From 5504c86fd61740886047320e2ed70f02a164acd7 Mon Sep 17 00:00:00 2001 From: yoshi-code-bot <70984784+yoshi-code-bot@users.noreply.github.com> Date: Wed, 11 Oct 2023 10:45:34 -0700 Subject: [PATCH] feat: run the generator (#3355) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * feat(admin): update the API #### admin:directory_v1 The following keys were added: - schemas.OrgUnit.properties.blockInheritance.deprecated The following keys were changed: - schemas.OrgUnit.properties.blockInheritance.description * feat(aiplatform)!: update the API BREAKING CHANGE: This release has breaking changes. #### aiplatform:v1beta1 The following keys were deleted: - resources.projects.resources.locations.resources.featurestores.resources.entityTypes.resources.features.methods.create.parameters.parent.description - schemas.GoogleCloudAiplatformV1beta1CreateFeatureRequest.properties.parent.description The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.flatPath - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.httpMethod - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.id - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.path - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.request.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.response.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.flatPath - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.httpMethod - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.id - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.path - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.response.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.flatPath - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.httpMethod - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.id - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.readMask.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.readMask.format - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.readMask.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.parameters.readMask.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.path - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.response.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.flatPath - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.httpMethod - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.id - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.readMask.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.readMask.format - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.readMask.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.parameters.readMask.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.path - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.response.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.flatPath - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.httpMethod - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.id - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.path - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.response.$ref - resources.projects.resources.locations.resources.datasets.resources.datasetVersions.methods.restore.scopes - resources.projects.resources.locations.resources.featureGroups.methods.create.description - resources.projects.resources.locations.resources.featureGroups.methods.create.flatPath - resources.projects.resources.locations.resources.featureGroups.methods.create.httpMethod - resources.projects.resources.locations.resources.featureGroups.methods.create.id - resources.projects.resources.locations.resources.featureGroups.methods.create.parameterOrder - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.featureGroupId.description - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.featureGroupId.location - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.featureGroupId.type - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.featureGroups.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.featureGroups.methods.create.path - resources.projects.resources.locations.resources.featureGroups.methods.create.request.$ref - resources.projects.resources.locations.resources.featureGroups.methods.create.response.$ref - resources.projects.resources.locations.resources.featureGroups.methods.create.scopes - resources.projects.resources.locations.resources.featureGroups.methods.delete.description - resources.projects.resources.locations.resources.featureGroups.methods.delete.flatPath - resources.projects.resources.locations.resources.featureGroups.methods.delete.httpMethod - resources.projects.resources.locations.resources.featureGroups.methods.delete.id - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameterOrder - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.force.description - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.force.location - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.force.type - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.methods.delete.path - resources.projects.resources.locations.resources.featureGroups.methods.delete.response.$ref - resources.projects.resources.locations.resources.featureGroups.methods.delete.scopes - resources.projects.resources.locations.resources.featureGroups.methods.get.description - resources.projects.resources.locations.resources.featureGroups.methods.get.flatPath - resources.projects.resources.locations.resources.featureGroups.methods.get.httpMethod - resources.projects.resources.locations.resources.featureGroups.methods.get.id - resources.projects.resources.locations.resources.featureGroups.methods.get.parameterOrder - resources.projects.resources.locations.resources.featureGroups.methods.get.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.methods.get.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.methods.get.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.methods.get.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.methods.get.path - resources.projects.resources.locations.resources.featureGroups.methods.get.response.$ref - resources.projects.resources.locations.resources.featureGroups.methods.get.scopes - resources.projects.resources.locations.resources.featureGroups.methods.list.description - resources.projects.resources.locations.resources.featureGroups.methods.list.flatPath - resources.projects.resources.locations.resources.featureGroups.methods.list.httpMethod - resources.projects.resources.locations.resources.featureGroups.methods.list.id - resources.projects.resources.locations.resources.featureGroups.methods.list.parameterOrder - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.featureGroups.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.featureGroups.methods.list.path - resources.projects.resources.locations.resources.featureGroups.methods.list.response.$ref - resources.projects.resources.locations.resources.featureGroups.methods.list.scopes - resources.projects.resources.locations.resources.featureGroups.methods.patch.description - resources.projects.resources.locations.resources.featureGroups.methods.patch.flatPath - resources.projects.resources.locations.resources.featureGroups.methods.patch.httpMethod - resources.projects.resources.locations.resources.featureGroups.methods.patch.id - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameterOrder - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.featureGroups.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.featureGroups.methods.patch.path - resources.projects.resources.locations.resources.featureGroups.methods.patch.request.$ref - resources.projects.resources.locations.resources.featureGroups.methods.patch.response.$ref - resources.projects.resources.locations.resources.featureGroups.methods.patch.scopes - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.id - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.featureId.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.featureId.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.featureId.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.path - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.request.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.create.scopes - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.id - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.path - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.delete.scopes - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.id - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.path - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.get.scopes - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.id - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.latestStatsCount.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.latestStatsCount.format - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.latestStatsCount.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.latestStatsCount.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.readMask.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.readMask.format - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.readMask.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.parameters.readMask.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.path - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.list.scopes - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.flatPath - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.httpMethod - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.id - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameterOrder - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.path - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.request.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.response.$ref - resources.projects.resources.locations.resources.featureGroups.resources.features.methods.patch.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.featureOnlineStoreId.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.featureOnlineStoreId.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.featureOnlineStoreId.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.create.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.force.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.force.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.force.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.delete.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.get.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.list.scopes - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.id - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.path - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.methods.patch.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.featureViewId.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.featureViewId.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.featureViewId.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.runSyncImmediately.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.runSyncImmediately.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.parameters.runSyncImmediately.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.create.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.delete.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameters.featureView.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameters.featureView.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameters.featureView.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameters.featureView.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.parameters.featureView.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.fetchFeatureValues.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.get.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.list.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.patch.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameters.featureView.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameters.featureView.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameters.featureView.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameters.featureView.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.parameters.featureView.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.searchNearestEntities.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameters.featureView.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameters.featureView.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameters.featureView.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameters.featureView.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.parameters.featureView.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.request.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.methods.sync.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameters.name.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameters.name.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameters.name.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.parameters.name.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.get.scopes - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.flatPath - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.httpMethod - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.id - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameterOrder - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.path - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.response.$ref - resources.projects.resources.locations.resources.featureOnlineStores.resources.featureViews.resources.featureViewSyncs.methods.list.scopes - resources.publishers.resources.models.methods.list.description - resources.publishers.resources.models.methods.list.flatPath - resources.publishers.resources.models.methods.list.httpMethod - resources.publishers.resources.models.methods.list.id - resources.publishers.resources.models.methods.list.parameterOrder - resources.publishers.resources.models.methods.list.parameters.filter.description - resources.publishers.resources.models.methods.list.parameters.filter.location - resources.publishers.resources.models.methods.list.parameters.filter.type - resources.publishers.resources.models.methods.list.parameters.languageCode.description - resources.publishers.resources.models.methods.list.parameters.languageCode.location - resources.publishers.resources.models.methods.list.parameters.languageCode.type - resources.publishers.resources.models.methods.list.parameters.orderBy.description - resources.publishers.resources.models.methods.list.parameters.orderBy.location - resources.publishers.resources.models.methods.list.parameters.orderBy.type - resources.publishers.resources.models.methods.list.parameters.pageSize.description - resources.publishers.resources.models.methods.list.parameters.pageSize.format - resources.publishers.resources.models.methods.list.parameters.pageSize.location - resources.publishers.resources.models.methods.list.parameters.pageSize.type - resources.publishers.resources.models.methods.list.parameters.pageToken.description - resources.publishers.resources.models.methods.list.parameters.pageToken.location - resources.publishers.resources.models.methods.list.parameters.pageToken.type - resources.publishers.resources.models.methods.list.parameters.parent.description - resources.publishers.resources.models.methods.list.parameters.parent.location - resources.publishers.resources.models.methods.list.parameters.parent.pattern - resources.publishers.resources.models.methods.list.parameters.parent.required - resources.publishers.resources.models.methods.list.parameters.parent.type - resources.publishers.resources.models.methods.list.parameters.view.description - resources.publishers.resources.models.methods.list.parameters.view.enum - resources.publishers.resources.models.methods.list.parameters.view.enumDescriptions - resources.publishers.resources.models.methods.list.parameters.view.location - resources.publishers.resources.models.methods.list.parameters.view.type - resources.publishers.resources.models.methods.list.path - resources.publishers.resources.models.methods.list.… * feat(alloydb)!: update the API BREAKING CHANGE: This release has breaking changes. #### alloydb:v1alpha The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceMetadata.description The following keys were added: - schemas.GenerateClientCertificateResponse.properties.pemCertificate.deprecated - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.id - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.id - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.items.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.format - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.GenerateClientCertificateRequest.properties.pemCsr.description - schemas.NetworkConfig.properties.network.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.resourceType.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceName.description #### alloydb:v1beta The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceMetadata.description The following keys were added: - schemas.GenerateClientCertificateResponse.properties.pemCertificate.deprecated - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.id - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.id - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.items.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.format - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.GenerateClientCertificateRequest.properties.pemCsr.description - schemas.NetworkConfig.properties.network.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.resourceType.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceName.description #### alloydb:v1 The following keys were deleted: - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceMetadata.description The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.description - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.flatPath - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.httpMethod - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.id - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameters.parent.description - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameters.parent.location - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameters.parent.pattern - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameters.parent.required - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.parameters.parent.type - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.path - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.request.$ref - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.response.$ref - resources.projects.resources.locations.resources.clusters.methods.generateClientCertificate.scopes - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.description - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.flatPath - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.httpMethod - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.id - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameterOrder - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.parent.description - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.parent.location - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.parent.pattern - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.parent.required - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.parent.type - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.requestId.location - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.parameters.requestId.type - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.path - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.response.$ref - resources.projects.resources.locations.resources.clusters.resources.instances.methods.getConnectionInfo.scopes - schemas.ConnectionInfo.description - schemas.ConnectionInfo.id - schemas.ConnectionInfo.properties.instanceUid.description - schemas.ConnectionInfo.properties.instanceUid.readOnly - schemas.ConnectionInfo.properties.instanceUid.type - schemas.ConnectionInfo.properties.ipAddress.description - schemas.ConnectionInfo.properties.ipAddress.readOnly - schemas.ConnectionInfo.properties.ipAddress.type - schemas.ConnectionInfo.properties.name.description - schemas.ConnectionInfo.properties.name.type - schemas.ConnectionInfo.type - schemas.GenerateClientCertificateRequest.description - schemas.GenerateClientCertificateRequest.id - schemas.GenerateClientCertificateRequest.properties.certDuration.description - schemas.GenerateClientCertificateRequest.properties.certDuration.format - schemas.GenerateClientCertificateRequest.properties.certDuration.type - schemas.GenerateClientCertificateRequest.properties.publicKey.description - schemas.GenerateClientCertificateRequest.properties.publicKey.type - schemas.GenerateClientCertificateRequest.properties.requestId.description - schemas.GenerateClientCertificateRequest.properties.requestId.type - schemas.GenerateClientCertificateRequest.type - schemas.GenerateClientCertificateResponse.description - schemas.GenerateClientCertificateResponse.id - schemas.GenerateClientCertificateResponse.properties.caCert.description - schemas.GenerateClientCertificateResponse.properties.caCert.type - schemas.GenerateClientCertificateResponse.properties.pemCertificateChain.description - schemas.GenerateClientCertificateResponse.properties.pemCertificateChain.items.type - schemas.GenerateClientCertificateResponse.properties.pemCertificateChain.readOnly - schemas.GenerateClientCertificateResponse.properties.pemCertificateChain.type - schemas.GenerateClientCertificateResponse.type - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.description - schemas.StorageDatabasecenterPartnerapiV1mainBackupConfiguration.properties.pointInTimeRecoveryEnabled.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.id - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.standard.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.description - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.properties.version.type - schemas.StorageDatabasecenterPartnerapiV1mainCompliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.resourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.id - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.additionalMetadata.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.items.$ref - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.compliance.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.description.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.format - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.eventTime.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.externalUri.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.name.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.provider.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceContainer.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.resourceName.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalClass.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.signalId.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.properties.state.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.providerDescription.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.additionalProperties.type - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.customMetadata.type The following keys were changed: - schemas.Cluster.properties.network.description - schemas.NetworkConfig.properties.network.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed.properties.feedType.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.provider.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceId.properties.resourceType.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.currentState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enum - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.expectedState.enumDescriptions - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.primaryResourceId.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceContainer.description - schemas.StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata.properties.resourceName.description * feat(analyticsadmin)!: update the API BREAKING CHANGE: This release has breaking changes. #### analyticsadmin:v1alpha The following keys were deleted: - resources.accounts.resources.userLinks.methods.audit.description - resources.accounts.resources.userLinks.methods.audit.flatPath - resources.accounts.resources.userLinks.methods.audit.httpMethod - resources.accounts.resources.userLinks.methods.audit.id - resources.accounts.resources.userLinks.methods.audit.parameterOrder - resources.accounts.resources.userLinks.methods.audit.parameters.parent.description - resources.accounts.resources.userLinks.methods.audit.parameters.parent.location - resources.accounts.resources.userLinks.methods.audit.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.audit.parameters.parent.required - resources.accounts.resources.userLinks.methods.audit.parameters.parent.type - resources.accounts.resources.userLinks.methods.audit.path - resources.accounts.resources.userLinks.methods.audit.request.$ref - resources.accounts.resources.userLinks.methods.audit.response.$ref - resources.accounts.resources.userLinks.methods.audit.scopes - resources.accounts.resources.userLinks.methods.batchCreate.description - resources.accounts.resources.userLinks.methods.batchCreate.flatPath - resources.accounts.resources.userLinks.methods.batchCreate.httpMethod - resources.accounts.resources.userLinks.methods.batchCreate.id - resources.accounts.resources.userLinks.methods.batchCreate.parameterOrder - resources.accounts.resources.userLinks.methods.batchCreate.parameters.parent.description - resources.accounts.resources.userLinks.methods.batchCreate.parameters.parent.location - resources.accounts.resources.userLinks.methods.batchCreate.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.batchCreate.parameters.parent.required - resources.accounts.resources.userLinks.methods.batchCreate.parameters.parent.type - resources.accounts.resources.userLinks.methods.batchCreate.path - resources.accounts.resources.userLinks.methods.batchCreate.request.$ref - resources.accounts.resources.userLinks.methods.batchCreate.response.$ref - resources.accounts.resources.userLinks.methods.batchCreate.scopes - resources.accounts.resources.userLinks.methods.batchDelete.description - resources.accounts.resources.userLinks.methods.batchDelete.flatPath - resources.accounts.resources.userLinks.methods.batchDelete.httpMethod - resources.accounts.resources.userLinks.methods.batchDelete.id - resources.accounts.resources.userLinks.methods.batchDelete.parameterOrder - resources.accounts.resources.userLinks.methods.batchDelete.parameters.parent.description - resources.accounts.resources.userLinks.methods.batchDelete.parameters.parent.location - resources.accounts.resources.userLinks.methods.batchDelete.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.batchDelete.parameters.parent.required - resources.accounts.resources.userLinks.methods.batchDelete.parameters.parent.type - resources.accounts.resources.userLinks.methods.batchDelete.path - resources.accounts.resources.userLinks.methods.batchDelete.request.$ref - resources.accounts.resources.userLinks.methods.batchDelete.response.$ref - resources.accounts.resources.userLinks.methods.batchDelete.scopes - resources.accounts.resources.userLinks.methods.batchGet.description - resources.accounts.resources.userLinks.methods.batchGet.flatPath - resources.accounts.resources.userLinks.methods.batchGet.httpMethod - resources.accounts.resources.userLinks.methods.batchGet.id - resources.accounts.resources.userLinks.methods.batchGet.parameterOrder - resources.accounts.resources.userLinks.methods.batchGet.parameters.names.description - resources.accounts.resources.userLinks.methods.batchGet.parameters.names.location - resources.accounts.resources.userLinks.methods.batchGet.parameters.names.repeated - resources.accounts.resources.userLinks.methods.batchGet.parameters.names.type - resources.accounts.resources.userLinks.methods.batchGet.parameters.parent.description - resources.accounts.resources.userLinks.methods.batchGet.parameters.parent.location - resources.accounts.resources.userLinks.methods.batchGet.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.batchGet.parameters.parent.required - resources.accounts.resources.userLinks.methods.batchGet.parameters.parent.type - resources.accounts.resources.userLinks.methods.batchGet.path - resources.accounts.resources.userLinks.methods.batchGet.response.$ref - resources.accounts.resources.userLinks.methods.batchGet.scopes - resources.accounts.resources.userLinks.methods.batchUpdate.description - resources.accounts.resources.userLinks.methods.batchUpdate.flatPath - resources.accounts.resources.userLinks.methods.batchUpdate.httpMethod - resources.accounts.resources.userLinks.methods.batchUpdate.id - resources.accounts.resources.userLinks.methods.batchUpdate.parameterOrder - resources.accounts.resources.userLinks.methods.batchUpdate.parameters.parent.description - resources.accounts.resources.userLinks.methods.batchUpdate.parameters.parent.location - resources.accounts.resources.userLinks.methods.batchUpdate.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.batchUpdate.parameters.parent.required - resources.accounts.resources.userLinks.methods.batchUpdate.parameters.parent.type - resources.accounts.resources.userLinks.methods.batchUpdate.path - resources.accounts.resources.userLinks.methods.batchUpdate.request.$ref - resources.accounts.resources.userLinks.methods.batchUpdate.response.$ref - resources.accounts.resources.userLinks.methods.batchUpdate.scopes - resources.accounts.resources.userLinks.methods.create.description - resources.accounts.resources.userLinks.methods.create.flatPath - resources.accounts.resources.userLinks.methods.create.httpMethod - resources.accounts.resources.userLinks.methods.create.id - resources.accounts.resources.userLinks.methods.create.parameterOrder - resources.accounts.resources.userLinks.methods.create.parameters.notifyNewUser.description - resources.accounts.resources.userLinks.methods.create.parameters.notifyNewUser.location - resources.accounts.resources.userLinks.methods.create.parameters.notifyNewUser.type - resources.accounts.resources.userLinks.methods.create.parameters.parent.description - resources.accounts.resources.userLinks.methods.create.parameters.parent.location - resources.accounts.resources.userLinks.methods.create.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.create.parameters.parent.required - resources.accounts.resources.userLinks.methods.create.parameters.parent.type - resources.accounts.resources.userLinks.methods.create.path - resources.accounts.resources.userLinks.methods.create.request.$ref - resources.accounts.resources.userLinks.methods.create.response.$ref - resources.accounts.resources.userLinks.methods.create.scopes - resources.accounts.resources.userLinks.methods.delete.description - resources.accounts.resources.userLinks.methods.delete.flatPath - resources.accounts.resources.userLinks.methods.delete.httpMethod - resources.accounts.resources.userLinks.methods.delete.id - resources.accounts.resources.userLinks.methods.delete.parameterOrder - resources.accounts.resources.userLinks.methods.delete.parameters.name.description - resources.accounts.resources.userLinks.methods.delete.parameters.name.location - resources.accounts.resources.userLinks.methods.delete.parameters.name.pattern - resources.accounts.resources.userLinks.methods.delete.parameters.name.required - resources.accounts.resources.userLinks.methods.delete.parameters.name.type - resources.accounts.resources.userLinks.methods.delete.path - resources.accounts.resources.userLinks.methods.delete.response.$ref - resources.accounts.resources.userLinks.methods.delete.scopes - resources.accounts.resources.userLinks.methods.get.description - resources.accounts.resources.userLinks.methods.get.flatPath - resources.accounts.resources.userLinks.methods.get.httpMethod - resources.accounts.resources.userLinks.methods.get.id - resources.accounts.resources.userLinks.methods.get.parameterOrder - resources.accounts.resources.userLinks.methods.get.parameters.name.description - resources.accounts.resources.userLinks.methods.get.parameters.name.location - resources.accounts.resources.userLinks.methods.get.parameters.name.pattern - resources.accounts.resources.userLinks.methods.get.parameters.name.required - resources.accounts.resources.userLinks.methods.get.parameters.name.type - resources.accounts.resources.userLinks.methods.get.path - resources.accounts.resources.userLinks.methods.get.response.$ref - resources.accounts.resources.userLinks.methods.get.scopes - resources.accounts.resources.userLinks.methods.list.description - resources.accounts.resources.userLinks.methods.list.flatPath - resources.accounts.resources.userLinks.methods.list.httpMethod - resources.accounts.resources.userLinks.methods.list.id - resources.accounts.resources.userLinks.methods.list.parameterOrder - resources.accounts.resources.userLinks.methods.list.parameters.pageSize.description - resources.accounts.resources.userLinks.methods.list.parameters.pageSize.format - resources.accounts.resources.userLinks.methods.list.parameters.pageSize.location - resources.accounts.resources.userLinks.methods.list.parameters.pageSize.type - resources.accounts.resources.userLinks.methods.list.parameters.pageToken.description - resources.accounts.resources.userLinks.methods.list.parameters.pageToken.location - resources.accounts.resources.userLinks.methods.list.parameters.pageToken.type - resources.accounts.resources.userLinks.methods.list.parameters.parent.description - resources.accounts.resources.userLinks.methods.list.parameters.parent.location - resources.accounts.resources.userLinks.methods.list.parameters.parent.pattern - resources.accounts.resources.userLinks.methods.list.parameters.parent.required - resources.accounts.resources.userLinks.methods.list.parameters.parent.type - resources.accounts.resources.userLinks.methods.list.path - resources.accounts.resources.userLinks.methods.list.response.$ref - resources.accounts.resources.userLinks.methods.list.scopes - resources.accounts.resources.userLinks.methods.patch.description - resources.accounts.resources.userLinks.methods.patch.flatPath - resources.accounts.resources.userLinks.methods.patch.httpMethod - resources.accounts.resources.userLinks.methods.patch.id - resources.accounts.resources.userLinks.methods.patch.parameterOrder - resources.accounts.resources.userLinks.methods.patch.parameters.name.description - resources.accounts.resources.userLinks.methods.patch.parameters.name.location - resources.accounts.resources.userLinks.methods.patch.parameters.name.pattern - resources.accounts.resources.userLinks.methods.patch.parameters.name.required - resources.accounts.resources.userLinks.methods.patch.parameters.name.type - resources.accounts.resources.userLinks.methods.patch.path - resources.accounts.resources.userLinks.methods.patch.request.$ref - resources.accounts.resources.userLinks.methods.patch.response.$ref - resources.accounts.resources.userLinks.methods.patch.scopes - resources.properties.resources.userLinks.methods.audit.description - resources.properties.resources.userLinks.methods.audit.flatPath - resources.properties.resources.userLinks.methods.audit.httpMethod - resources.properties.resources.userLinks.methods.audit.id - resources.properties.resources.userLinks.methods.audit.parameterOrder - resources.properties.resources.userLinks.methods.audit.parameters.parent.description - resources.properties.resources.userLinks.methods.audit.parameters.parent.location - resources.properties.resources.userLinks.methods.audit.parameters.parent.pattern - resources.properties.resources.userLinks.methods.audit.parameters.parent.required - resources.properties.resources.userLinks.methods.audit.parameters.parent.type - resources.properties.resources.userLinks.methods.audit.path - resources.properties.resources.userLinks.methods.audit.request.$ref - resources.properties.resources.userLinks.methods.audit.response.$ref - resources.properties.resources.userLinks.methods.audit.scopes - resources.properties.resources.userLinks.methods.batchCreate.description - resources.properties.resources.userLinks.methods.batchCreate.flatPath - resources.properties.resources.userLinks.methods.batchCreate.httpMethod - resources.properties.resources.userLinks.methods.batchCreate.id - resources.properties.resources.userLinks.methods.batchCreate.parameterOrder - resources.properties.resources.userLinks.methods.batchCreate.parameters.parent.description - resources.properties.resources.userLinks.methods.batchCreate.parameters.parent.location - resources.properties.resources.userLinks.methods.batchCreate.parameters.parent.pattern - resources.properties.resources.userLinks.methods.batchCreate.parameters.parent.required - resources.properties.resources.userLinks.methods.batchCreate.parameters.parent.type - resources.properties.resources.userLinks.methods.batchCreate.path - resources.properties.resources.userLinks.methods.batchCreate.request.$ref - resources.properties.resources.userLinks.methods.batchCreate.response.$ref - resources.properties.resources.userLinks.methods.batchCreate.scopes - resources.properties.resources.userLinks.methods.batchDelete.description - resources.properties.resources.userLinks.methods.batchDelete.flatPath - resources.properties.resources.userLinks.methods.batchDelete.httpMethod - resources.properties.resources.userLinks.methods.batchDelete.id - resources.properties.resources.userLinks.methods.batchDelete.parameterOrder - resources.properties.resources.userLinks.methods.batchDelete.parameters.parent.description - resources.properties.resources.userLinks.methods.batchDelete.parameters.parent.location - resources.properties.resources.userLinks.methods.batchDelete.parameters.parent.pattern - resources.properties.resources.userLinks.methods.batchDelete.parameters.parent.required - resources.properties.resources.userLinks.methods.batchDelete.parameters.parent.type - resources.properties.resources.userLinks.methods.batchDelete.path - resources.properties.resources.userLinks.methods.batchDelete.request.$ref - resources.properties.resources.userLinks.methods.batchDelete.response.$ref - resources.properties.resources.userLinks.methods.batchDelete.scopes - resources.properties.resources.userLinks.methods.batchGet.description - resources.properties.resources.userLinks.methods.batchGet.flatPath - resources.properties.resources.userLinks.methods.batchGet.httpMethod - resources.properties.resources.userLinks.methods.batchGet.id - resources.properties.resources.userLinks.methods.batchGet.parameterOrder - resources.properties.resources.userLinks.methods.batchGet.parameters.names.description - resources.properties.resources.userLinks.methods.batchGet.parameters.names.location - resources.properties.resources.userLinks.methods.batchGet.parameters.names.repeated - resources.properties.resources.userLinks.methods.batchGet.parameters.names.type - resources.properties.resources.userLinks.methods.batchGet.parameters.parent.description - resources.properties.resources.userLinks.methods.batchGet.parameters.parent.location - resources.properties.resources.userLinks.methods.batchGet.parameters.parent.pattern - resources.properties.resources.userLinks.methods.batchGet.parameters.parent.required - resources.properties.resources.userLinks.methods.batchGet.parameters.parent.type - resources.properties.resources.userLinks.methods.batchGet.path - resources.properties.resources.userLinks.methods.batchGet.response.$ref - resources.properties.resources.userLinks.methods.batchGet.scopes - resources.properties.resources.userLinks.methods.batchUpdate.description - resources.properties.resources.userLinks.methods.batchUpdate.flatPath - resources.properties.resources.userLinks.methods.batchUpdate.httpMethod - resources.properties.resources.userLinks.methods.batchUpdate.id - resources.properties.resources.userLinks.methods.batchUpdate.parameterOrder - resources.properties.resources.userLinks.methods.batchUpdate.parameters.parent.description - resources.properties.resources.userLinks.methods.batchUpdate.parameters.parent.location - resources.properties.resources.userLinks.methods.batchUpdate.parameters.parent.pattern - resources.properties.resources.userLinks.methods.batchUpdate.parameters.parent.required - resources.properties.resources.userLinks.methods.batchUpdate.parameters.parent.type - resources.properties.resources.userLinks.methods.batchUpdate.path - resources.properties.resources.userLinks.methods.batchUpdate.request.$ref - resources.properties.resources.userLinks.methods.batchUpdate.response.$ref - resources.properties.resources.userLinks.methods.batchUpdate.scopes - resources.properties.resources.userLinks.methods.create.description - resources.properties.resources.userLinks.methods.create.flatPath - resources.properties.resources.userLinks.methods.create.httpMethod - resources.properties.resources.userLinks.methods.create.id - resources.properties.resources.userLinks.methods.create.parameterOrder - resources.properties.resources.userLinks.methods.create.parameters.notifyNewUser.description - resources.properties.resources.userLinks.methods.create.parameters.notifyNewUser.location - resources.properties.resources.userLinks.methods.create.parameters.notifyNewUser.type - resources.properties.resources.userLinks.methods.create.parameters.parent.description - resources.properties.resources.userLinks.methods.create.parameters.parent.location - resources.properties.resources.userLinks.methods.create.parameters.parent.pattern - resources.properties.resources.userLinks.methods.create.parameters.parent.required - resources.properties.resources.userLinks.methods.create.parameters.parent.type - resources.properties.resources.userLinks.methods.create.path - resources.properties.resources.userLinks.methods.create.request.$ref - resources.properties.resources.userLinks.methods.create.response.$ref - resources.properties.resources.userLinks.methods.create.scopes - resources.properties.resources.userLinks.methods.delete.description - resources.properties.resources.userLinks.methods.delete.flatPath - resources.properties.resources.userLinks.methods.delete.httpMethod - resources.properties.resources.userLinks.methods.delete.id - resources.properties.resources.userLinks.methods.delete.parameterOrder - resources.properties.resources.userLinks.methods.delete.parameters.name.description - resources.properties.resources.userLinks.methods.delete.parameters.name.location - resources.properties.resources.userLinks.methods.delete.parameters.name.pattern - resources.properties.resources.userLinks.methods.delete.parameters.name.required - resources.properties.resources.userLinks.methods.delete.parameters.name.type - resources.properties.resources.userLinks.methods.delete.path - resources.properties.resources.userLinks.methods.delete.response.$ref - resources.properties.resources.userLinks.methods.delete.scopes - resources.properties.resources.userLinks.methods.get.description - resources.properties.resources.userLinks.methods.get.flatPath - resources.properties.resources.userLinks.methods.get.httpMethod - resources.properties.resources.userLinks.methods.get.id - resources.properties.resources.userLinks.methods.get.parameterOrder - resources.properties.resources.userLinks.methods.get.parameters.name.description - resources.properties.resources.userLinks.methods.get.parameters.name.location - resources.properties.resources.userLinks.methods.get.parameters.name.pattern - resources.properties.resources.userLinks.methods.get.parameters.name.required - resources.properties.resources.userLinks.methods.get.parameters.name.type - resources.properties.resources.userLinks.methods.get.path - resources.properties.resources.userLinks.methods.get.response.$ref - resources.properties.resources.userLinks.methods.get.scopes - resources.properties.resources.userLinks.methods.list.description - resources.properties.resources.userLinks.methods.list.flatPath - resources.properties.resources.userLinks.methods.list.httpMethod - resources.properties.resources.userLinks.methods.list.id - resources.properties.resources.userLinks.methods.list.parameterOrder - resources.properties.resources.userLinks.methods.list.parameters.pageSize.description - resources.properties.resources.userLinks.methods.list.parameters.pageSize.format - resources.properties.resources.userLinks.methods.list.parameters.pageSize.location - resources.properties.resources.userLinks.methods.list.parameters.pageSize.type - resources.properties.resources.userLinks.methods.list.parameters.pageToken.description - resources.properties.resources.userLinks.methods.list.parameters.pageToken.location - resources.properties.resources.userLinks.methods.list.parameters.pageToken.type - resources.properties.resources.userLinks.methods.list.parameters.parent.description - resources.properties.resources.userLinks.methods.list.parameters.parent.location - resources.properties.resources.userLinks.methods.list.parameters.parent.pattern - resources.properties.resources.userLinks.methods.list.parameters.parent.required - resources.properties.resources.userLinks.methods.list.parameters.parent.type - resources.properties.resources.userLinks.methods.list.path - resources.properties.resources.userLinks.methods.list.response.$ref - resources.properties.resources.userLinks.methods.list.scopes - resources.properties.resources.userLinks.methods.patch.description - resources.properties.resources.userLinks.methods.patch.flatPath - resources.properties.resources.userLinks.methods.patch.httpMethod - resources.properties.resources.userLinks.methods.patch.id - resources.properties.resources.userLinks.methods.patch.parameterOrder - resources.properties.resources.userLinks.methods.patch.parameters.name.description - resources.properties.resources.userLinks.methods.patch.parameters.name.location - resources.properties.resources.userLinks.methods.patch.parameters.name.pattern - resources.properties.resources.userLinks.methods.patch.parameters.name.required - resources.properties.resources.userLinks.methods.patch.parameters.name.type - resources.properties.resources.userLinks.methods.patch.path - resources.properties.resources.userLinks.methods.patch.request.$ref - resources.properties.resources.userLinks.methods.patch.response.$ref - resources.properties.resources.userLinks.methods.patch.scopes - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.id - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.directRoles.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.directRoles.items.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.directRoles.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.effectiveRoles.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.effectiveRoles.items.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.effectiveRoles.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.emailAddress.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.emailAddress.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLink.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.id - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.properties.pageSize.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.properties.pageSize.format - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.properties.pageSize.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.properties.pageToken.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.properties.pageToken.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksRequest.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.properties.nextPageToken.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.properties.nextPageToken.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.properties.userLinks.description - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.properties.userLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.properties.userLinks.type - schemas.GoogleAnalyticsAdminV1alphaAuditUserLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.description - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.id - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.properties.notifyNewUsers.description - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.properties.notifyNewUsers.type - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.properties.requests.description - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.properties.requests.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.properties.requests.type - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest.type - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.properties.userLinks.description - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.properties.userLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.properties.userLinks.type - schemas.GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.description - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.id - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.properties.requests.description - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.properties.requests.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.properties.requests.type - schemas.GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest.type - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.properties.userLinks.description - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.properties.userLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.properties.userLinks.type - schemas.GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.description - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.id - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.properties.requests.description - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.properties.requests.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.properties.requests.type - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest.type - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.properties.userLinks.description - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.properties.userLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.properties.userLinks.type - schemas.GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.description - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.id - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.notifyNewUser.description - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.notifyNewUser.type - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.parent.description - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.parent.type - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.userLink.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.properties.userLink.description - schemas.GoogleAnalyticsAdminV1alphaCreateUserLinkRequest.type - schemas.GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest.description - schemas.GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest.id - schemas.GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest.type - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.properties.nextPageToken.description - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.properties.nextPageToken.type - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.properties.userLinks.description - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.properties.userLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.properties.userLinks.type - schemas.GoogleAnalyticsAdminV1alphaListUserLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest.description - schemas.GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest.id - schemas.GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest.properties.userLink.$ref - schemas.GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest.properties.userLink.description - schemas.GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest.type - schemas.GoogleAnalyticsAdminV1alphaUserLink.description - schemas.GoogleAnalyticsAdminV1alphaUserLink.id - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.directRoles.description - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.directRoles.items.type - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.directRoles.type - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.emailAddress.description - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.emailAddress.type - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.name.readOnly - schemas.GoogleAnalyticsAdminV1alphaUserLink.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaUserLink.type The following keys were added: - resources.properties.methods.createRollupProperty.description - resources.properties.methods.createRollupProperty.flatPath - resources.properties.methods.createRollupProperty.httpMethod - resources.properties.methods.createRollupProperty.id - resources.properties.methods.createRollupProperty.parameterOrder - resources.properties.methods.createRollupProperty.path - resources.properties.methods.createRollupProperty.request.$ref - resources.properties.methods.createRollupProperty.response.$ref - resources.properties.methods.createRollupProperty.scopes - resources.properties.methods.createSubproperty.description - resources.properties.methods.createSubproperty.flatPath - resources.properties.methods.createSubproperty.httpMethod - resources.properties.methods.createSubproperty.id - resources.properties.methods.createSubproperty.parameterOrder - resources.properties.methods.createSubproperty.path - resources.properties.methods.createSubproperty.request.$ref - resources.properties.methods.createSubproperty.response.$ref - resources.properties.methods.createSubproperty.scopes - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.description - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.flatPath - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.httpMethod - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.id - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameterOrder - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameters.name.description - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameters.name.location - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameters.name.pattern - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameters.name.required - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.parameters.name.type - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.path - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.response.$ref - resources.properties.resources.dataStreams.methods.getDataRedactionSettings.scopes - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.description - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.flatPath - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.httpMethod - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.id - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameterOrder - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.name.description - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.name.location - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.name.pattern - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.name.required - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.name.type - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.updateMask.description - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.updateMask.format - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.updateMask.location - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.parameters.updateMask.type - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.path - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.request.$ref - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.response.$ref - resources.properties.resources.dataStreams.methods.updateDataRedactionSettings.scopes - resources.properties.resources.rollupPropertySourceLinks.methods.create.description - resources.properties.resources.rollupPropertySourceLinks.methods.create.flatPath - resources.properties.resources.rollupPropertySourceLinks.methods.create.httpMethod - resources.properties.resources.rollupPropertySourceLinks.methods.create.id - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameterOrder - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameters.parent.description - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameters.parent.location - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameters.parent.pattern - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameters.parent.required - resources.properties.resources.rollupPropertySourceLinks.methods.create.parameters.parent.type - resources.properties.resources.rollupPropertySourceLinks.methods.create.path - resources.properties.resources.rollupPropertySourceLinks.methods.create.request.$ref - resources.properties.resources.rollupPropertySourceLinks.methods.create.response.$ref - resources.properties.resources.rollupPropertySourceLinks.methods.create.scopes - resources.properties.resources.rollupPropertySourceLinks.methods.delete.description - resources.properties.resources.rollupPropertySourceLinks.methods.delete.flatPath - resources.properties.resources.rollupPropertySourceLinks.methods.delete.httpMethod - resources.properties.resources.rollupPropertySourceLinks.methods.delete.id - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameterOrder - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameters.name.description - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameters.name.location - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameters.name.pattern - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameters.name.required - resources.properties.resources.rollupPropertySourceLinks.methods.delete.parameters.name.type - resources.properties.resources.rollupPropertySourceLinks.methods.delete.path - resources.properties.resources.rollupPropertySourceLinks.methods.delete.response.$ref - resources.properties.resources.rollupPropertySourceLinks.methods.delete.scopes - resources.properties.resources.rollupPropertySourceLinks.methods.get.description - resources.properties.resources.rollupPropertySourceLinks.methods.get.flatPath - resources.properties.resources.rollupPropertySourceLinks.methods.get.httpMethod - resources.properties.resources.rollupPropertySourceLinks.methods.get.id - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameterOrder - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameters.name.description - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameters.name.location - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameters.name.pattern - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameters.name.required - resources.properties.resources.rollupPropertySourceLinks.methods.get.parameters.name.type - resources.properties.resources.rollupPropertySourceLinks.methods.get.path - resources.properties.resources.rollupPropertySourceLinks.methods.get.response.$ref - resources.properties.resources.rollupPropertySourceLinks.methods.get.scopes - resources.properties.resources.rollupPropertySourceLinks.methods.list.description - resources.properties.resources.rollupPropertySourceLinks.methods.list.flatPath - resources.properties.resources.rollupPropertySourceLinks.methods.list.httpMethod - resources.properties.resources.rollupPropertySourceLinks.methods.list.id - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameterOrder - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageSize.description - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageSize.format - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageSize.location - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageSize.type - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageToken.description - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageToken.location - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.pageToken.type - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.parent.description - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.parent.location - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.parent.pattern - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.parent.required - resources.properties.resources.rollupPropertySourceLinks.methods.list.parameters.parent.type - resources.properties.resources.rollupPropertySourceLinks.methods.list.path - resources.properties.resources.rollupPropertySourceLinks.methods.list.response.$ref - resources.properties.resources.rollupPropertySourceLinks.methods.list.scopes - resources.properties.resources.subpropertyEventFilters.methods.create.description - resources.properties.resources.subpropertyEventFilters.methods.create.flatPath - resources.properties.resources.subpropertyEventFilters.methods.create.httpMethod - resources.properties.resources.subpropertyEventFilters.methods.create.id - resources.properties.resources.subpropertyEventFilters.methods.create.parameterOrder - resources.properties.resources.subpropertyEventFilters.methods.create.parameters.parent.description - resources.properties.resources.subpropertyEventFilters.methods.create.parameters.parent.location - resources.properties.resources.subpropertyEventFilters.methods.create.parameters.parent.pattern - resources.properties.resources.subpropertyEventFilters.methods.create.parameters.parent.required - resources.properties.resources.subpropertyEventFilters.methods.create.parameters.parent.type - resources.properties.resources.subpropertyEventFilters.methods.create.path - resources.properties.resources.subpropertyEventFilters.methods.create.request.$ref - resources.properties.resources.subpropertyEventFilters.methods.create.response.$ref - resources.properties.resources.subpropertyEventFilters.methods.create.scopes - resources.properties.resources.subpropertyEventFilters.methods.delete.description - resources.properties.resources.subpropertyEventFilters.methods.delete.flatPath - resources.properties.resources.subpropertyEventFilters.methods.delete.httpMethod - resources.properties.resources.subpropertyEventFilters.methods.delete.id - resources.properties.resources.subpropertyEventFilters.methods.delete.parameterOrder - resources.properties.resources.subpropertyEventFilters.methods.delete.parameters.name.description - resources.properties.resources.subpropertyEventFilters.methods.delete.parameters.name.location - resources.properties.resources.subpropertyEventFilters.methods.delete.parameters.name.pattern - resources.properties.resources.subpropertyEventFilters.methods.delete.parameters.name.required - resources.properties.resources.subpropertyEventFilters.methods.delete.parameters.name.type - resources.properties.resources.subpropertyEventFilters.methods.delete.path - resources.properties.resources.subpropertyEventFilters.methods.delete.response.$ref - resources.properties.resources.subpropertyEventFilters.methods.delete.scopes - resources.properties.resources.subpropertyEventFilters.methods.get.description - resources.properties.resources.subpropertyEventFilters.methods.get.flatPath - resources.properties.resources.subpropertyEventFilters.methods.get.httpMethod - resources.properties.resources.subpropertyEventFilters.methods.get.id - resources.properties.resources.subpropertyEventFilters.methods.get.parameterOrder - resources.properties.resources.subpropertyEventFilters.methods.get.parameters.name.description - resources.properties.resources.subpropertyEventFilters.methods.get.parameters.name.location - resources.properties.resources.subpropertyEventFilters.methods.get.parameters.name.pattern - resources.properties.resources.subpropertyEventFilters.methods.get.parameters.name.required - resources.properties.resources.subpropertyEventFilters.methods.get.parameters.name.type - resources.properties.resources.subpropertyEventFilters.methods.get.path - resources.properties.resources.subpropertyEventFilters.methods.get.response.$ref - resources.properties.resources.subpropertyEventFilters.methods.get.scopes - resources.properties.resources.subpropertyEventFilters.methods.list.description - resources.properties.resources.subpropertyEventFilters.methods.list.flatPath - resources.properties.resources.subpropertyEventFilters.methods.list.httpMethod - resources.properties.resources.subpropertyEventFilters.methods.list.id - resources.properties.resources.subpropertyEventFilters.methods.list.parameterOrder - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageSize.description - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageSize.format - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageSize.location - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageSize.type - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageToken.description - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageToken.location - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.pageToken.type - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.parent.description - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.parent.location - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.parent.pattern - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.parent.required - resources.properties.resources.subpropertyEventFilters.methods.list.parameters.parent.type - resources.properties.resources.subpropertyEventFilters.methods.list.path - resources.properties.resources.subpropertyEventFilters.methods.list.response.$ref - resources.properties.resources.subpropertyEventFilters.methods.list.scopes - resources.properties.resources.subpropertyEventFilters.methods.patch.description - resources.properties.resources.subpropertyEventFilters.methods.patch.flatPath - resources.properties.resources.subpropertyEventFilters.methods.patch.httpMethod - resources.properties.resources.subpropertyEventFilters.methods.patch.id - resources.properties.resources.subpropertyEventFilters.methods.patch.parameterOrder - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.name.description - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.name.location - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.name.pattern - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.name.required - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.name.type - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.updateMask.description - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.updateMask.format - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.updateMask.location - resources.properties.resources.subpropertyEventFilters.methods.patch.parameters.updateMask.type - resources.properties.resources.subpropertyEventFilters.methods.patch.path - resources.properties.resources.subpropertyEventFilters.methods.patch.request.$ref - resources.properties.resources.subpropertyEventFilters.methods.patch.response.$ref - resources.properties.resources.subpropertyEventFilters.methods.patch.scopes - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.dataRedactionSettings.$ref - schemas.GoogleAnalyticsAdminV1alphaChangeHistoryChangeChangeHistoryResource.properties.dataRedactionSettings.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.id - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.properties.rollupProperty.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.properties.rollupProperty.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.properties.sourceProperties.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.properties.sourceProperties.items.type - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.properties.sourceProperties.type - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest.type - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.id - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.properties.rollupProperty.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.properties.rollupProperty.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.properties.rollupPropertySourceLinks.description - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.properties.rollupPropertySourceLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.properties.rollupPropertySourceLinks.type - schemas.GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse.type - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.id - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.parent.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.parent.type - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.subproperty.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.subproperty.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.subpropertyEventFilter.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.properties.subpropertyEventFilter.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest.type - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.id - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.properties.subproperty.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.properties.subproperty.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.properties.subpropertyEventFilter.$ref - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.properties.subpropertyEventFilter.description - schemas.GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.description - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.id - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.emailRedactionEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.emailRedactionEnabled.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.name.readOnly - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.queryParameterKeys.description - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.queryParameterKeys.items.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.queryParameterKeys.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.queryParameterRedactionEnabled.description - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.properties.queryParameterRedactionEnabled.type - schemas.GoogleAnalyticsAdminV1alphaDataRedactionSettings.type - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.description - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.id - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.properties.nextPageToken.description - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.properties.nextPageToken.type - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.properties.rollupPropertySourceLinks.description - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.properties.rollupPropertySourceLinks.items.$ref - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.properties.rollupPropertySourceLinks.type - schemas.GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse.type - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.description - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.id - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.properties.nextPageToken.description - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.properties.nextPageToken.type - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.properties.subpropertyEventFilters.description - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.properties.subpropertyEventFilters.items.$ref - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.properties.subpropertyEventFilters.type - schemas.GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse.type - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.description - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.id - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.properties.name.readOnly - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.properties.sourceProperty.description - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.properties.sourceProperty.type - schemas.GoogleAnalyticsAdminV1alphaRollupPropertySourceLink.type - schemas.GoogleAnalyticsAdminV1alphaRunAccessReportRequest.properties.expandGroups.description - schemas.GoogleAnalyticsAdminV1alphaRunAccessReportRequest.properties.expandGroups.type - schemas.GoogleAnalyticsAdminV1alphaRunAccessReportRequest.properties.includeAllUsers.description - schemas.GoogleAnalyticsAdminV1alphaRunAccessReportRequest.properties.includeAllUsers.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.applyToProperty.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.applyToProperty.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.filterClauses.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.filterClauses.items.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.filterClauses.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.name.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.name.readOnly - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.properties.name.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilter.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterClauseType.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterClauseType.enum - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterClauseType.enumDescriptions - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterClauseType.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterExpression.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.properties.filterExpression.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.fieldName.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.fieldName.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.nullFilter.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.nullFilter.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.stringFilter.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.properties.stringFilter.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.caseSensitive.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.caseSensitive.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.matchType.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.matchType.enum - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.matchType.enumDescriptions - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.matchType.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.value.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.properties.value.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.filterCondition.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.filterCondition.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.notExpression.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.notExpression.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.orGroup.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.properties.orGroup.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.id - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.properties.filterExpressions.description - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.properties.filterExpressions.items.$ref - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.properties.filterExpressions.type - schemas.GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList.type The following keys were changed: - resources.accounts.methods.delete.description - resources.properties.methods.delete.description - schemas.GoogleAnalyticsAdminV1alphaProperty.properties.propertyType.description - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enum - schemas.GoogleAnalyticsAdminV1alphaSearchChangeHistoryEventsRequest.properties.resourceType.items.enumDescriptions #### analyticsadmin:v1beta The following keys were added: - schemas.GoogleAnalyticsAdminV1betaRunAccessReportRequest.properties.expandGroups.description - schemas.GoogleAnalyticsAdminV1betaRunAccessReportRequest.properties.expandGroups.type - schemas.GoogleAnalyticsAdminV1betaRunAccessReportRequest.properties.includeAllUsers.description - schemas.GoogleAnalyticsAdminV1betaRunAccessReportRequest.properties.includeAllUsers.type The following keys were changed: - resources.accounts.methods.delete.description - resources.properties.methods.delete.description - schemas.GoogleAnalyticsAdminV1betaProperty.properties.propertyType.description * feat(analyticshub)!: update the API BREAKING CHANGE: This release has breaking changes. #### analyticshub:v1beta1 The following keys were deleted: - schemas.OperationMetadata.properties.cancelRequested.description - schemas.OperationMetadata.properties.cancelRequested.readOnly - schemas.OperationMetadata.properties.cancelRequested.type - schemas.OperationMetadata.properties.statusDetail.description - schemas.OperationMetadata.properties.statusDetail.readOnly - schemas.OperationMetadata.properties.statusDetail.type The following keys were added: - schemas.OperationMetadata.properties.requestedCancellation.description - schemas.OperationMetadata.properties.requestedCancellation.readOnly - schemas.OperationMetadata.properties.requestedCancellation.type - schemas.OperationMetadata.properties.statusMessage.description - schemas.OperationMetadata.properties.statusMessage.readOnly - schemas.OperationMetadata.properties.statusMessage.type The following keys were changed: - schemas.OperationMetadata.description #### analyticshub:v1 The following keys were deleted: - schemas.OperationMetadata.properties.cancelRequested.description - schemas.OperationMetadata.properties.cancelRequested.readOnly - schemas.OperationMetadata.properties.cancelRequested.type - schemas.OperationMetadata.properties.statusDetail.description - schemas.OperationMetadata.properties.statusDetail.readOnly - schemas.OperationMetadata.properties.statusDetail.type The following keys were added: - schemas.OperationMetadata.properties.requestedCancellation.description - schemas.OperationMetadata.properties.requestedCancellation.readOnly - schemas.OperationMetadata.properties.requestedCancellation.type - schemas.OperationMetadata.properties.statusMessage.description - schemas.OperationMetadata.properties.statusMessage.readOnly - schemas.OperationMetadata.properties.statusMessage.type The following keys were changed: - schemas.OperationMetadata.description * feat(androidmanagement): update the API #### androidmanagement:v1 The following keys were added: - schemas.DeviceRadioState.properties.cellularTwoGState.description - schemas.DeviceRadioState.properties.cellularTwoGState.enum - schemas.DeviceRadioState.properties.cellularTwoGState.enumDescriptions - schemas.DeviceRadioState.properties.cellularTwoGState.type - schemas.DeviceRadioState.properties.ultraWidebandState.description - schemas.DeviceRadioState.properties.ultraWidebandState.enum - schemas.DeviceRadioState.properties.ultraWidebandState.enumDescriptions - schemas.DeviceRadioState.properties.ultraWidebandState.type - schemas.SigninDetail.properties.tokenTag.description - schemas.SigninDetail.properties.tokenTag.type The following keys were changed: - schemas.CrossProfilePolicies.properties.showWorkContactsInPersonalProfile.description - schemas.CrossProfilePolicies.properties.showWorkContactsInPersonalProfile.enumDescriptions - schemas.PersonalApplicationPolicy.properties.installType.enumDescriptions - schemas.PersonalUsagePolicies.properties.maxDaysWithWorkOff.description - schemas.Policy.properties.keyguardDisabledFeatures.items.enum - schemas.Policy.properties.keyguardDisabledFeatures.items.enumDescriptions - schemas.SigninDetail.description * fix(androidpublisher): update the API #### androidpublisher:v3 The following keys were changed: - resources.edits.resources.deobfuscationfiles.methods.upload.mediaUpload.maxSize - schemas.Grant.properties.appLevelPermissions.items.enum - schemas.Grant.properties.appLevelPermissions.items.enumDeprecated - schemas.Grant.properties.appLevelPermissions.items.enumDescriptions - schemas.SubscriptionItemPriceChangeDetails.properties.expectedNewPriceChargeTime.description - schemas.User.properties.developerAccountPermissions.items.enum - schemas.User.properties.developerAccountPermissions.items.enumDescriptions * feat(apigeeregistry): update the API #### apigeeregistry:v1 The following keys were added: - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.description - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.flatPath - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.httpMethod - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.id - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameterOrder - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.options.requestedPolicyVersion.description - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.options.requestedPolicyVersion.format - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.options.requestedPolicyVersion.location - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.options.requestedPolicyVersion.type - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.path - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.response.$ref - resources.projects.resources.locations.resources.documents.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.description - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.flatPath - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.httpMethod - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.id - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameterOrder - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameters.resource.description - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameters.resource.location - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameters.resource.pattern - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameters.resource.required - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.parameters.resource.type - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.path - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.request.$ref - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.response.$ref - resources.projects.resources.locations.resources.documents.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.description - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.flatPath - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.httpMethod - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.id - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameterOrder - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameters.resource.description - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameters.resource.location - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameters.resource.pattern - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameters.resource.required - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.parameters.resource.type - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.path - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.request.$ref - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.response.$ref - resources.projects.resources.locations.resources.documents.methods.testIamPermissions.scopes * fix(artifactregistry): update the API #### artifactregistry:v1beta1 The following keys were changed: - endpoints - resources.projects.resources.locations.resources.repositories.methods.create.parameters.repositoryId.description #### artifactregistry:v1beta2 The following keys were changed: - endpoints - resources.projects.resources.locations.resources.repositories.methods.create.parameters.repositoryId.description #### artifactregistry:v1 The following keys were changed: - endpoints - resources.projects.resources.locations.resources.repositories.methods.create.parameters.repositoryId.description * fix(backupdr): update the API * feat(batch): update the API #### batch:v1 The following keys were added: - schemas.Runnable.properties.displayName.description - schemas.Runnable.properties.displayName.type * feat(beyondcorp): update the API #### beyondcorp:v1alpha The following keys were added: - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig.properties.proxyProtocolConfig.$ref - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyConfig.properties.proxyProtocolConfig.description - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.description - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.id - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.properties.metadata.additionalProperties.type - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.properties.metadata.description - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.properties.metadata.type - schemas.GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig.type * feat(binaryauthorization): update the API #### binaryauthorization:v1 The following keys were added: - schemas.PkixPublicKey.properties.keyId.description - schemas.PkixPublicKey.properties.keyId.type * feat(blockchainnodeengine): update the API #### blockchainnodeengine:v1 The following keys were added: - schemas.EthereumDetails.properties.beaconFeeRecipient.description - schemas.EthereumDetails.properties.beaconFeeRecipient.type * feat(chat)!: update the API BREAKING CHANGE: This release has breaking changes. #### chat:v1 The following keys were deleted: - schemas.Membership.properties.role.readOnly The following keys were added: - schemas.Message.properties.formattedText.description - schemas.Message.properties.formattedText.readOnly - schemas.Message.properties.formattedText.type The following keys were changed: - resources.spaces.methods.get.description - resources.spaces.resources.members.methods.delete.scopes - resources.spaces.resources.members.methods.list.scopes - schemas.Annotation.description - schemas.GoogleAppsCardV1Action.properties.persistValues.description - schemas.GoogleAppsCardV1Card.properties.fixedFooter.description - schemas.GoogleAppsCardV1CardFixedFooter.description - schemas.GoogleAppsCardV1DecoratedText.properties.endIcon.description - schemas.GoogleAppsCardV1DecoratedText.properties.text.description - schemas.GoogleAppsCardV1Icon.description - schemas.GoogleAppsCardV1Icon.properties.knownIcon.description - schemas.GoogleAppsCardV1Section.properties.header.description - schemas.GoogleAppsCardV1TextParagraph.description - schemas.GoogleAppsCardV1Widget.properties.textParagraph.description - schemas.KeyValue.properties.bottomLabel.description - schemas.KeyValue.properties.content.description - schemas.KeyValue.properties.topLabel.description - schemas.Membership.properties.role.description - schemas.Message.properties.text.description - schemas.Section.properties.header.description - schemas.TextParagraph.description * feat(chromepolicy)!: update the API BREAKING CHANGE: This release has breaking changes. #### chromepolicy:v1 The following keys were deleted: - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.id - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.deprecatedInFavorOf.description - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.deprecatedInFavorOf.items.type - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.deprecatedInFavorOf.type - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.description.description - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.description.type - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.endSupport.$ref - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.endSupport.description - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.policyApiLifecycleStage.description - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.policyApiLifecycleStage.enum - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.policyApiLifecycleStage.enumDescriptions - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.properties.policyApiLifecycleStage.type - schemas.ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle.type - schemas.Proto2FileDescriptorProto.properties.editionEnum.description - schemas.Proto2FileDescriptorProto.properties.editionEnum.enum - schemas.Proto2FileDescriptorProto.properties.editionEnum.enumDescriptions - schemas.Proto2FileDescriptorProto.properties.editionEnum.type The following keys were added: - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.id - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.deprecatedInFavorOf.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.deprecatedInFavorOf.items.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.deprecatedInFavorOf.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.description.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.description.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.endSupport.$ref - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.endSupport.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.policyApiLifecycleStage.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.policyApiLifecycleStage.enum - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.policyApiLifecycleStage.enumDescriptions - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.policyApiLifecycleStage.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.scheduledToDeprecatePolicies.description - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.scheduledToDeprecatePolicies.items.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.properties.scheduledToDeprecatePolicies.type - schemas.GoogleChromePolicyVersionsV1PolicyApiLifecycle.type - schemas.Proto2FileDescriptorProto.properties.editionDeprecated.deprecated - schemas.Proto2FileDescriptorProto.properties.editionDeprecated.description - schemas.Proto2FileDescriptorProto.properties.editionDeprecated.type The following keys were changed: - schemas.GoogleChromePolicyVersionsV1PolicySchema.properties.policyApiLifecycle.$ref * feat(cloudasset): update the API #### cloudasset:v1 The following keys were added: - schemas.EffectiveTagDetails.description - schemas.EffectiveTagDetails.id - schemas.EffectiveTagDetails.properties.attachedResource.description - schemas.EffectiveTagDetails.properties.attachedResource.type - schemas.EffectiveTagDetails.properties.effectiveTags.description - schemas.EffectiveTagDetails.properties.effectiveTags.items.$ref - schemas.EffectiveTagDetails.properties.effectiveTags.type - schemas.EffectiveTagDetails.type - schemas.ResourceSearchResult.properties.effectiveTags.description - schemas.ResourceSearchResult.properties.effectiveTags.items.$ref - schemas.ResourceSearchResult.properties.effectiveTags.type - schemas.ResourceSearchResult.properties.tagKeys.deprecated - schemas.ResourceSearchResult.properties.tagValueIds.deprecated - schemas.ResourceSearchResult.properties.tagValues.deprecated - schemas.ResourceSearchResult.properties.tags.description - schemas.ResourceSearchResult.properties.tags.items.$ref - schemas.ResourceSearchResult.properties.tags.type - schemas.Tag.description - schemas.Tag.id - schemas.Tag.properties.tagKey.description - schemas.Tag.properties.tagKey.type - schemas.Tag.properties.tagValue.description - schemas.Tag.properties.tagValue.type - schemas.Tag.properties.tagValueId.description - schemas.Tag.properties.tagValueId.type - schemas.Tag.type The following keys were changed: - resources.v1.methods.searchAllResources.parameters.orderBy.description - resources.v1.methods.searchAllResources.parameters.query.description - resources.v1.methods.searchAllResources.parameters.readMask.description - schemas.ResourceSearchResult.properties.tagKeys.description - schemas.ResourceSearchResult.properties.tagValueIds.description - schemas.ResourceSearchResult.properties.tagValues.description * feat(cloudbuild): update the API #### cloudbuild:v1 The following keys were added: - schemas.BitbucketServerConfig.properties.peeredNetworkIpRange.description - schemas.BitbucketServerConfig.properties.peeredNetworkIpRange.type - schemas.SourceProvenance.properties.resolvedConnectedRepository.$ref - schemas.SourceProvenance.properties.resolvedConnectedRepository.description - schemas.SourceProvenance.properties.resolvedConnectedRepository.readOnly - schemas.SourceProvenance.properties.resolvedGitSource.$ref - schemas.SourceProvenance.properties.resolvedGitSource.description - schemas.SourceProvenance.properties.resolvedGitSource.readOnly #### cloudbuild:v2 The following keys were changed: - schemas.WhenExpression.properties.expressionOperator.enum - schemas.WhenExpression.properties.expressionOperator.enumDescriptions * fix(cloudsupport): update the API #### cloudsupport:v2beta The following keys were changed: - resources.cases.methods.search.parameters.query.description #### cloudsupport:v2 The following keys were changed: - resources.cases.methods.search.parameters.query.description * feat(cloudtasks): update the API #### cloudtasks:v2beta3 The following keys were added: - resources.projects.resources.locations.methods.getCmekConfig.description - resources.projects.resources.locations.methods.getCmekConfig.flatPath - resources.projects.resources.locations.methods.getCmekConfig.httpMethod - resources.projects.resources.locations.methods.getCmekConfig.id - resources.projects.resources.locations.methods.getCmekConfig.parameterOrder - resources.projects.resources.locations.methods.getCmekConfig.parameters.name.description - resources.projects.resources.locations.methods.getCmekConfig.parameters.name.location - resources.projects.resources.locations.methods.getCmekConfig.parameters.name.pattern - resources.projects.resources.locations.methods.getCmekConfig.parameters.name.required - resources.projects.resources.locations.methods.getCmekConfig.parameters.name.type - resources.projects.resources.locations.methods.getCmekConfig.path - resources.projects.resources.locations.methods.getCmekConfig.response.$ref - resources.projects.resources.locations.methods.getCmekConfig.scopes - resources.projects.resources.locations.methods.updateCmekConfig.description - resources.projects.resources.locations.methods.updateCmekConfig.flatPath - resources.projects.resources.locations.methods.updateCmekConfig.httpMethod - resources.projects.resources.locations.methods.updateCmekConfig.id - resources.projects.resources.locations.methods.updateCmekConfig.parameterOrder - resources.projects.resources.locations.methods.updateCmekConfig.parameters.locationsId.location - resources.projects.resources.locations.methods.updateCmekConfig.parameters.locationsId.required - resources.projects.resources.locations.methods.updateCmekConfig.parameters.locationsId.type - resources.projects.resources.locations.methods.updateCmekConfig.parameters.projectsId.location - resources.projects.resources.locations.methods.updateCmekConfig.parameters.projectsId.required - resources.projects.resources.locations.methods.updateCmekConfig.parameters.projectsId.type - resources.projects.resources.locations.methods.updateCmekConfig.parameters.updateMask.description - resources.projects.resources.locations.methods.updateCmekConfig.parameters.updateMask.format - resources.projects.resources.locations.methods.updateCmekConfig.parameters.updateMask.location - resources.projects.resources.locations.methods.updateCmekConfig.parameters.updateMask.type - resources.projects.resources.locations.methods.updateCmekConfig.path - resources.projects.resources.locations.methods.updateCmekConfig.request.$ref - resources.projects.resources.locations.methods.updateCmekConfig.response.$ref - resources.projects.resources.locations.methods.updateCmekConfig.scopes - schemas.CmekConfig.description - schemas.CmekConfig.id - schemas.CmekConfig.properties.kmsKey.description - schemas.CmekConfig.properties.kmsKey.type - schemas.CmekConfig.properties.name.description - schemas.CmekConfig.properties.name.readOnly - schemas.CmekConfig.properties.name.type - schemas.CmekConfig.type * feat(composer): update the API #### composer:v1beta1 The following keys were added: - schemas.DatabaseConfig.properties.zone.description - schemas.DatabaseConfig.properties.zone.type - schemas.StorageConfig.properties.bucket.description - schemas.StorageConfig.properties.bucket.type #### composer:v1 The following keys were added: - schemas.DatabaseConfig.properties.zone.description - schemas.DatabaseConfig.properties.zone.type - schemas.StorageConfig.properties.bucket.description - schemas.StorageConfig.properties.bucket.type * feat(compute): update the API #### compute:alpha The following keys were added: - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionHealthCheckServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionHealthCheckServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionHealthCheckServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionNotificationEndpoints.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionNotificationEndpoints.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionNotificationEndpoints.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePoolTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.storagePools.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.zoneQueuedResources.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.zoneQueuedResources.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.zoneQueuedResources.methods.aggregatedList.parameters.serviceProjectNumber.type - schemas.ManagedInstance.properties.propertiesFromFlexibilityPolicy.$ref - schemas.ManagedInstance.properties.propertiesFromFlexibilityPolicy.description - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.id - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.machineType.description - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.properties.machineType.type - schemas.ManagedInstancePropertiesFromFlexibilityPolicy.type - schemas.NetworkRoutingConfig.properties.bgpInterRegionCost.description - schemas.NetworkRoutingConfig.properties.bgpInterRegionCost.enum - schemas.NetworkRoutingConfig.properties.bgpInterRegionCost.enumDescriptions - schemas.NetworkRoutingConfig.properties.bgpInterRegionCost.type - schemas.ServiceAttachment.properties.propagatedConnectionLimit.description - schemas.ServiceAttachment.properties.propagatedConnectionLimit.format - schemas.ServiceAttachment.properties.propagatedConnectionLimit.type - schemas.StoragePool.properties.capacityProvisioningType.description - schemas.StoragePool.properties.capacityProvisioningType.enum - schemas.StoragePool.properties.capacityProvisioningType.enumDescriptions - schemas.StoragePool.properties.capacityProvisioningType.type - schemas.StoragePool.properties.performanceProvisioningType.description - schemas.StoragePool.properties.performanceProvisioningType.enum - schemas.StoragePool.properties.performanceProvisioningType.enumDescriptions - schemas.StoragePool.properties.performanceProvisioningType.type The following keys were changed: - schemas.AutoscalingPolicyScalingSchedule.properties.timeZone.description - schemas.BackendService.properties.localityLbPolicy.description - schemas.FutureReservation.properties.autoDeleteAutoCreatedReservations.description - schemas.GuestOsFeature.properties.type.enum - schemas.GuestOsFeature.properties.type.enumDescriptions - schemas.HealthCheck.description - schemas.InstanceTemplate.description - schemas.Interconnect.properties.availableFeatures.description - schemas.Interconnect.properties.macsec.description - schemas.Interconnect.properties.requestedFeatures.description - schemas.InterconnectMacsec.description - schemas.InterconnectMacsec.properties.preSharedKeys.description - schemas.RoutePolicyPolicyTerm.properties.priority.format - schemas.RouterNat.properties.endpointTypes.items.enumDescriptions - schemas.ServiceAttachment.properties.reconcileConnections.description - schemas.TargetHttpProxy.description - schemas.UpcomingMaintenance.properties.startTimeWindow.description - schemas.UpcomingMaintenanceTimeWindow.description #### compute:beta The following keys were added: - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.futureReservations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroupManagerResizeRequests.methods.cancel.description - resources.instanceGroupManagerResizeRequests.methods.cancel.flatPath - resources.instanceGroupManagerResizeRequests.methods.cancel.httpMethod - resources.instanceGroupManagerResizeRequests.methods.cancel.id - resources.instanceGroupManagerResizeRequests.methods.cancel.parameterOrder - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.instanceGroupManager.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.pattern - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.project.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.requestId.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.resizeRequest.type - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.description - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.location - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.required - resources.instanceGroupManagerResizeRequests.methods.cancel.parameters.zone.type - resources.instanceGroupManagerResizeRequests.methods.cancel.path - resources.instanceGroupManagerResizeRequests.methods.cancel.response.$ref - resources.instanceGroupManagerResizeRequests.methods.cancel.scopes - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroupManagers.methods.resumeInstances.description - resources.instanceGroupManagers.methods.resumeInstances.flatPath - resources.instanceGroupManagers.methods.resumeInstances.httpMethod - resources.instanceGroupManagers.methods.resumeInstances.id - resources.instanceGroupManagers.methods.resumeInstances.parameterOrder - resources.instanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.description - resources.instanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.location - resources.instanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.required - resources.instanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.type - resources.instanceGroupManagers.methods.resumeInstances.parameters.project.description - resources.instanceGroupManagers.methods.resumeInstances.parameters.project.location - resources.instanceGroupManagers.methods.resumeInstances.parameters.project.pattern - resources.instanceGroupManagers.methods.resumeInstances.parameters.project.required - resources.instanceGroupManagers.methods.resumeInstances.parameters.project.type - resources.instanceGroupManagers.methods.resumeInstances.parameters.requestId.description - resources.instanceGroupManagers.methods.resumeInstances.parameters.requestId.location - resources.instanceGroupManagers.methods.resumeInstances.parameters.requestId.type - resources.instanceGroupManagers.methods.resumeInstances.parameters.zone.description - resources.instanceGroupManagers.methods.resumeInstances.parameters.zone.location - resources.instanceGroupManagers.methods.resumeInstances.parameters.zone.required - resources.instanceGroupManagers.methods.resumeInstances.parameters.zone.type - resources.instanceGroupManagers.methods.resumeInstances.path - resources.instanceGroupManagers.methods.resumeInstances.request.$ref - resources.instanceGroupManagers.methods.resumeInstances.response.$ref - resources.instanceGroupManagers.methods.resumeInstances.scopes - resources.instanceGroupManagers.methods.startInstances.description - resources.instanceGroupManagers.methods.startInstances.flatPath - resources.instanceGroupManagers.methods.startInstances.httpMethod - resources.instanceGroupManagers.methods.startInstances.id - resources.instanceGroupManagers.methods.startInstances.parameterOrder - resources.instanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.description - resources.instanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.location - resources.instanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.required - resources.instanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.type - resources.instanceGroupManagers.methods.startInstances.parameters.project.description - resources.instanceGroupManagers.methods.startInstances.parameters.project.location - resources.instanceGroupManagers.methods.startInstances.parameters.project.pattern - resources.instanceGroupManagers.methods.startInstances.parameters.project.required - resources.instanceGroupManagers.methods.startInstances.parameters.project.type - resources.instanceGroupManagers.methods.startInstances.parameters.requestId.description - resources.instanceGroupManagers.methods.startInstances.parameters.requestId.location - resources.instanceGroupManagers.methods.startInstances.parameters.requestId.type - resources.instanceGroupManagers.methods.startInstances.parameters.zone.description - resources.instanceGroupManagers.methods.startInstances.parameters.zone.location - resources.instanceGroupManagers.methods.startInstances.parameters.zone.required - resources.instanceGroupManagers.methods.startInstances.parameters.zone.type - resources.instanceGroupManagers.methods.startInstances.path - resources.instanceGroupManagers.methods.startInstances.request.$ref - resources.instanceGroupManagers.methods.startInstances.response.$ref - resources.instanceGroupManagers.methods.startInstances.scopes - resources.instanceGroupManagers.methods.stopInstances.description - resources.instanceGroupManagers.methods.stopInstances.flatPath - resources.instanceGroupManagers.methods.stopInstances.httpMethod - resources.instanceGroupManagers.methods.stopInstances.id - resources.instanceGroupManagers.methods.stopInstances.parameterOrder - resources.instanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.description - resources.instanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.location - resources.instanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.required - resources.instanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.type - resources.instanceGroupManagers.methods.stopInstances.parameters.project.description - resources.instanceGroupManagers.methods.stopInstances.parameters.project.location - resources.instanceGroupManagers.methods.stopInstances.parameters.project.pattern - resources.instanceGroupManagers.methods.stopInstances.parameters.project.required - resources.instanceGroupManagers.methods.stopInstances.parameters.project.type - resources.instanceGroupManagers.methods.stopInstances.parameters.requestId.description - resources.instanceGroupManagers.methods.stopInstances.parameters.requestId.location - resources.instanceGroupManagers.methods.stopInstances.parameters.requestId.type - resources.instanceGroupManagers.methods.stopInstances.parameters.zone.description - resources.instanceGroupManagers.methods.stopInstances.parameters.zone.location - resources.instanceGroupManagers.methods.stopInstances.parameters.zone.required - resources.instanceGroupManagers.methods.stopInstances.parameters.zone.type - resources.instanceGroupManagers.methods.stopInstances.path - resources.instanceGroupManagers.methods.stopInstances.request.$ref - resources.instanceGroupManagers.methods.stopInstances.response.$ref - resources.instanceGroupManagers.methods.stopInstances.scopes - resources.instanceGroupManagers.methods.suspendInstances.description - resources.instanceGroupManagers.methods.suspendInstances.flatPath - resources.instanceGroupManagers.methods.suspendInstances.httpMethod - resources.instanceGroupManagers.methods.suspendInstances.id - resources.instanceGroupManagers.methods.suspendInstances.parameterOrder - resources.instanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.description - resources.instanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.location - resources.instanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.required - resources.instanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.type - resources.instanceGroupManagers.methods.suspendInstances.parameters.project.description - resources.instanceGroupManagers.methods.suspendInstances.parameters.project.location - resources.instanceGroupManagers.methods.suspendInstances.parameters.project.pattern - resources.instanceGroupManagers.methods.suspendInstances.parameters.project.required - resources.instanceGroupManagers.methods.suspendInstances.parameters.project.type - resources.instanceGroupManagers.methods.suspendInstances.parameters.requestId.description - resources.instanceGroupManagers.methods.suspendInstances.parameters.requestId.location - resources.instanceGroupManagers.methods.suspendInstances.parameters.requestId.type - resources.instanceGroupManagers.methods.suspendInstances.parameters.zone.description - resources.instanceGroupManagers.methods.suspendInstances.parameters.zone.location - resources.instanceGroupManagers.methods.suspendInstances.parameters.zone.required - resources.instanceGroupManagers.methods.suspendInstances.parameters.zone.type - resources.instanceGroupManagers.methods.suspendInstances.path - resources.instanceGroupManagers.methods.suspendInstances.request.$ref - resources.instanceGroupManagers.methods.suspendInstances.response.$ref - resources.instanceGroupManagers.methods.suspendInstances.scopes - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instantSnapshots.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeGroups.methods.performMaintenance.description - resources.nodeGroups.methods.performMaintenance.flatPath - resources.nodeGroups.methods.performMaintenance.httpMethod - resources.nodeGroups.methods.performMaintenance.id - resources.nodeGroups.methods.performMaintenance.parameterOrder - resources.nodeGroups.methods.performMaintenance.parameters.nodeGroup.description - resources.nodeGroups.methods.performMaintenance.parameters.nodeGroup.location - resources.nodeGroups.methods.performMaintenance.parameters.nodeGroup.pattern - resources.nodeGroups.methods.performMaintenance.parameters.nodeGroup.required - resources.nodeGroups.methods.performMaintenance.parameters.nodeGroup.type - resources.nodeGroups.methods.performMaintenance.parameters.project.description - resources.nodeGroups.methods.performMaintenance.parameters.project.location - resources.nodeGroups.methods.performMaintenance.parameters.project.pattern - resources.nodeGroups.methods.performMaintenance.parameters.project.required - resources.nodeGroups.methods.performMaintenance.parameters.project.type - resources.nodeGroups.methods.performMaintenance.parameters.requestId.description - resources.nodeGroups.methods.performMaintenance.parameters.requestId.location - resources.nodeGroups.methods.performMaintenance.parameters.requestId.type - resources.nodeGroups.methods.performMaintenance.parameters.zone.description - resources.nodeGroups.methods.performMaintenance.parameters.zone.location - resources.nodeGroups.methods.performMaintenance.parameters.zone.pattern - resources.nodeGroups.methods.performMaintenance.parameters.zone.required - resources.nodeGroups.methods.performMaintenance.parameters.zone.type - resources.nodeGroups.methods.performMaintenance.path - resources.nodeGroups.methods.performMaintenance.request.$ref - resources.nodeGroups.methods.performMaintenance.response.$ref - resources.nodeGroups.methods.performMaintenance.scopes - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeTemplates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.nodeTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.packetMirrorings.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.publicDelegatedPrefixes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.regionCommitments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.regionInstanceGroupManagers.methods.resumeInstances.description - resources.regionInstanceGroupManagers.methods.resumeInstances.flatPath - resources.regionInstanceGroupManagers.methods.resumeInstances.httpMethod - resources.regionInstanceGroupManagers.methods.resumeInstances.id - resources.regionInstanceGroupManagers.methods.resumeInstances.parameterOrder - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.description - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.location - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.required - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.instanceGroupManager.type - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.project.description - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.project.location - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.project.pattern - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.project.required - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.project.type - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.region.description - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.region.location - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.region.required - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.region.type - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.requestId.description - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.requestId.location - resources.regionInstanceGroupManagers.methods.resumeInstances.parameters.requestId.type - resources.regionInstanceGroupManagers.methods.resumeInstances.path - resources.regionInstanceGroupManagers.methods.resumeInstances.request.$ref - resources.regionInstanceGroupManagers.methods.resumeInstances.response.$ref - resources.regionInstanceGroupManagers.methods.resumeInstances.scopes - resources.regionInstanceGroupManagers.methods.startInstances.description - resources.regionInstanceGroupManagers.methods.startInstances.flatPath - resources.regionInstanceGroupManagers.methods.startInstances.httpMethod - resources.regionInstanceGroupManagers.methods.startInstances.id - resources.regionInstanceGroupManagers.methods.startInstances.parameterOrder - resources.regionInstanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.description - resources.regionInstanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.location - resources.regionInstanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.required - resources.regionInstanceGroupManagers.methods.startInstances.parameters.instanceGroupManager.type - resources.regionInstanceGroupManagers.methods.startInstances.parameters.project.description - resources.regionInstanceGroupManagers.methods.startInstances.parameters.project.location - resources.regionInstanceGroupManagers.methods.startInstances.parameters.project.pattern - resources.regionInstanceGroupManagers.methods.startInstances.parameters.project.required - resources.regionInstanceGroupManagers.methods.startInstances.parameters.project.type - resources.regionInstanceGroupManagers.methods.startInstances.parameters.region.description - resources.regionInstanceGroupManagers.methods.startInstances.parameters.region.location - resources.regionInstanceGroupManagers.methods.startInstances.parameters.region.required - resources.regionInstanceGroupManagers.methods.startInstances.parameters.region.type - resources.regionInstanceGroupManagers.methods.startInstances.parameters.requestId.description - resources.regionInstanceGroupManagers.methods.startInstances.parameters.requestId.location - resources.regionInstanceGroupManagers.methods.startInstances.parameters.requestId.type - resources.regionInstanceGroupManagers.methods.startInstances.path - resources.regionInstanceGroupManagers.methods.startInstances.request.$ref - resources.regionInstanceGroupManagers.methods.startInstances.response.$ref - resources.regionInstanceGroupManagers.methods.startInstances.scopes - resources.regionInstanceGroupManagers.methods.stopInstances.description - resources.regionInstanceGroupManagers.methods.stopInstances.flatPath - resources.regionInstanceGroupManagers.methods.stopInstances.httpMethod - resources.regionInstanceGroupManagers.methods.stopInstances.id - resources.regionInstanceGroupManagers.methods.stopInstances.parameterOrder - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.description - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.location - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.required - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.instanceGroupManager.type - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.project.description - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.project.location - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.project.pattern - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.project.required - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.project.type - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.region.description - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.region.location - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.region.required - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.region.type - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.requestId.description - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.requestId.location - resources.regionInstanceGroupManagers.methods.stopInstances.parameters.requestId.type - resources.regionInstanceGroupManagers.methods.stopInstances.path - resources.regionInstanceGroupManagers.methods.stopInstances.request.$ref - resources.regionInstanceGroupManagers.methods.stopInstances.response.$ref - resources.regionInstanceGroupManagers.methods.stopInstances.scopes - resources.regionInstanceGroupManagers.methods.suspendInstances.description - resources.regionInstanceGroupManagers.methods.suspendInstances.flatPath - resources.regionInstanceGroupManagers.methods.suspendInstances.httpMethod - resources.regionInstanceGroupManagers.methods.suspendInstances.id - resources.regionInstanceGroupManagers.methods.suspendInstances.parameterOrder - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.description - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.location - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.required - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.instanceGroupManager.type - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.project.description - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.project.location - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.project.pattern - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.project.required - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.project.type - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.region.description - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.region.location - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.region.required - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.region.type - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.requestId.description - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.requestId.location - resources.regionInstanceGroupManagers.methods.suspendInstances.parameters.requestId.type - resources.regionInstanceGroupManagers.methods.suspendInstances.path - resources.regionInstanceGroupManagers.methods.suspendInstances.request.$ref - resources.regionInstanceGroupManagers.methods.suspendInstances.response.$ref - resources.regionInstanceGroupManagers.methods.suspendInstances.scopes - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.reservations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.resourcePolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.routers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.securityPolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.serviceAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.sslCertificates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.sslPolicies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.subnetworks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetHttpProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetHttpsProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetInstances.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetPools.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetTcpProxies.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.targetVpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.urlMaps.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.vpnGateways.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.vpnTunnels.methods.aggregatedList.parameters.serviceProjectNumber.type - schemas.BackendService.properties.ipAddressSelectionPolicy.description - schemas.BackendService.properties.ipAddressSelectionPolicy.enum - schemas.BackendService.properties.ipAddressSelectionPolicy.enumDescriptions - schemas.BackendService.properties.ipAddressSelectionPolicy.type - schemas.InstanceGroupManager.properties.standbyPolicy.$ref - schemas.InstanceGroupManager.properties.standbyPolicy.description - schemas.InstanceGroupManager.properties.targetStoppedSize.description - schemas.InstanceGroupManager.properties.targetStoppedSize.format - schemas.InstanceGroupManager.properties.targetStoppedSize.type - schemas.InstanceGroupManager.properties.targetSuspendedSize.description - schemas.InstanceGroupManager.properties.targetSuspendedSize.format - schemas.InstanceGroupManager.properties.targetSuspendedSize.type - schemas.InstanceGroupManagerStandbyPolicy.id - schemas.InstanceGroupManagerStandbyPolicy.properties.initialDelaySec.format - schemas.InstanceGroupManagerStandbyPolicy.properties.initialDelaySec.type - schemas.InstanceGroupManagerStandbyPolicy.properties.mode.description - schemas.InstanceGroupManagerStandbyPolicy.properties.mode.enum - schemas.InstanceGroupManagerStandbyPolicy.properties.mode.enumDescriptions - schemas.InstanceGroupManagerStandbyPolicy.properties.mode.type - schemas.InstanceGroupManagerStandbyPolicy.type - schemas.InstanceGroupManagersResumeInstancesRequest.id - schemas.InstanceGroupManagersResumeInstancesRequest.properties.instances.description - schemas.InstanceGroupManagersResumeInstancesRequest.properties.instances.items.type - schemas.InstanceGroupManagersResumeInstancesRequest.properties.instances.type - schemas.InstanceGroupManagersResumeInstancesRequest.type - schemas.InstanceGroupManagersStartInstancesRequest.id - schemas.InstanceGroupManagersStartInstancesRequest.properties.instances.description - schemas.InstanceGroupManagersStartInstancesRequest.properties.instances.items.type - schemas.InstanceGroupManagersStartInstancesRequest.properties.instances.type - schemas.InstanceGroupManagersStartInstancesRequest.type - schemas.InstanceGroupManagersStopInstancesRequest.id - schemas.InstanceGroupManagersStopInstancesRequest.properties.forceStop.description - schemas.InstanceGroupManagersStopInstancesRequest.properties.forceStop.type - schemas.InstanceGroupManagersStopInstancesRequest.properties.instances.description - schemas.InstanceGroupManagersStopInstancesRequest.properties.instances.items.type - schemas.InstanceGroupManagersStopInstancesRequest.properties.instances.type - schemas.InstanceGroupManagersStopInstancesRequest.type - schemas.InstanceGroupManagersSuspendInstancesRequest.id - schemas.InstanceGroupManagersSuspendInstancesRequest.properties.forceSuspend.description - schemas.InstanceGroupManagersSuspendInstancesRequest.properties.forceSuspend.type - schemas.InstanceGroupManagersSuspendInstancesRequest.properties.instances.description - schemas.InstanceGroupManagersSuspendInstancesRequest.properties.instances.items.type - schemas.InstanceGroupManagersSuspendInstancesRequest.properties.instances.type - schemas.InstanceGroupManagersSuspendInstancesRequest.type - schemas.ManagedInstance.properties.instanceFlexibilityOverride.$ref - schemas.ManagedInstance.properties.instanceFlexibilityOverride.deprecated - schemas.ManagedInstance.properties.instanceFlexibilityOverride.description - schemas.ManagedInstanceInstanceFlexibilityOverride.id - schemas.ManagedInstanceInstanceFlexibilityOverride.properties.machineType.description - schemas.ManagedInstanceInstanceFlexibilityOverride.properties.machineType.type - schemas.ManagedInstanceInstanceFlexibilityOverride.type - schemas.NodeGroup.properties.maintenanceInterval.description - schemas.NodeGroup.properties.maintenanceInterval.enum - schemas.NodeGroup.properties.maintenanceInterval.enumDescriptions - schemas.NodeGroup.properties.maintenanceInterval.type - schemas.NodeGroupNode.properties.upcomingMaintenance.$ref - schemas.NodeGroupNode.properties.upcomingMaintenance.description - schemas.NodeGroupsPerformMaintenanceRequest.id - schemas.NodeGroupsPerformMaintenanceRequest.properties.nodes.description - schemas.NodeGroupsPerformMaintenanceRequest.properties.nodes.items.type - schemas.NodeGroupsPerformMaintenanceRequest.properties.nodes.type - schemas.NodeGroupsPerformMaintenanceRequest.properties.startTime.description - schemas.NodeGroupsPerformMaintenanceRequest.properties.startTime.type - schemas.NodeGroupsPerformMaintenanceRequest.type - schemas.RegionInstanceGroupManagersResumeInstancesRequest.id - schemas.RegionInstanceGroupManagersResumeInstancesRequest.properties.instances.description - schemas.RegionInstanceGroupManagersResumeInstancesRequest.properties.instances.items.type - schemas.RegionInstanceGroupManagersResumeInstancesRequest.properties.instances.type - schemas.RegionInstanceGroupManagersResumeInstancesRequest.type - schemas.RegionInstanceGroupManagersStartInstancesRequest.id - schemas.RegionInstanceGroupManagersStartInstancesRequest.properties.instances.description - schemas.RegionInstanceGroupManagersStartInstancesRequest.properties.instances.items.type - schemas.RegionInstanceGroupManagersStartInstancesRequest.properties.instances.type - schemas.RegionInstanceGroupManagersStartInstancesRequest.type - schemas.RegionInstanceGroupManagersStopInstancesRequest.id - schemas.RegionInstanceGroupManagersStopInstancesRequest.properties.forceStop.description - schemas.RegionInstanceGroupManagersStopInstancesRequest.properties.forceStop.type - schemas.RegionInstanceGroupManagersStopInstancesRequest.properties.instances.description - schemas.RegionInstanceGroupManagersStopInstancesRequest.properties.instances.items.type - schemas.RegionInstanceGroupManagersStopInstancesRequest.properties.instances.type - schemas.RegionInstanceGroupManagersStopInstancesRequest.type - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.id - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.properties.forceSuspend.description - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.properties.forceSuspend.type - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.properties.instances.description - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.properties.instances.items.type - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.properties.instances.type - schemas.RegionInstanceGroupManagersSuspendInstancesRequest.type - schemas.UpcomingMaintenance.description - schemas.UpcomingMaintenance.id - schemas.UpcomingMaintenance.properties.canReschedule.description - schemas.UpcomingMaintenance.properties.canReschedule.type - schemas.UpcomingMaintenance.properties.latestWindowStartTime.description - schemas.UpcomingMaintenance.properties.latestWindowStartTime.type - schemas.UpcomingMaintenance.properties.maintenanceStatus.enum - schemas.UpcomingMaintenance.properties.maintenanceStatus.enumDescriptions - schemas.UpcomingMaintenance.properties.maintenanceStatus.type - schemas.UpcomingMaintenance.properties.type.description - schemas.UpcomingMaintenance.properties.type.enum - schemas.UpcomingMaintenance.properties.type.enumDescriptions - schemas.UpcomingMaintenance.properties.type.type - schemas.UpcomingMaintenance.properties.windowEndTime.description - schemas.UpcomingMaintenance.properties.windowEndTime.type - schemas.UpcomingMaintenance.properties.windowStartTime.description - schemas.UpcomingMaintenance.properties.windowStartTime.type - schemas.UpcomingMaintenance.type The following keys were changed: - schemas.AllocationSpecificSKUAllocationReservedInstanceProperties.properties.maintenanceInterval.enum - schemas.AllocationSpecificSKUAllocationReservedInstanceProperties.properties.maintenanceInterval.enumDescriptions - schemas.AutoscalingPolicyScalingSchedule.properties.timeZone.description - schemas.BackendService.properties.localityLbPolicy.description - schemas.FutureReservation.properties.autoDeleteAutoCreatedReservations.description - schemas.GuestOsFeature.properties.type.enum - schemas.GuestOsFeature.properties.type.enumDescriptions - schemas.HealthCheck.description - schemas.InstanceTemplate.description - schemas.Interconnect.properties.availableFeatures.description - schemas.Interconnect.properties.macsec.description - schemas.Interconnect.properties.requestedFeatures.description - schemas.InterconnectMacsec.description - schemas.InterconnectMacsec.properties.preSharedKeys.description - schemas.RouterNat.properties.endpointTypes.items.enumDescriptions - schemas.Scheduling.properties.maintenanceInterval.enum - schemas.Scheduling.properties.maintenanceInterval.enumDescriptions - schemas.ServiceAttachment.properties.reconcileConnections.description - schemas.TargetHttpProxy.description #### compute:v1 The following keys were added: - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.acceleratorTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.addresses.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.autoscalers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.backendServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.backendServices.methods.listUsable.description - resources.backendServices.methods.listUsable.flatPath - resources.backendServices.methods.listUsable.httpMethod - resources.backendServices.methods.listUsable.id - resources.backendServices.methods.listUsable.parameterOrder - resources.backendServices.methods.listUsable.parameters.filter.description - resources.backendServices.methods.listUsable.parameters.filter.location - resources.backendServices.methods.listUsable.parameters.filter.type - resources.backendServices.methods.listUsable.parameters.maxResults.default - resources.backendServices.methods.listUsable.parameters.maxResults.description - resources.backendServices.methods.listUsable.parameters.maxResults.format - resources.backendServices.methods.listUsable.parameters.maxResults.location - resources.backendServices.methods.listUsable.parameters.maxResults.minimum - resources.backendServices.methods.listUsable.parameters.maxResults.type - resources.backendServices.methods.listUsable.parameters.orderBy.description - resources.backendServices.methods.listUsable.parameters.orderBy.location - resources.backendServices.methods.listUsable.parameters.orderBy.type - resources.backendServices.methods.listUsable.parameters.pageToken.description - resources.backendServices.methods.listUsable.parameters.pageToken.location - resources.backendServices.methods.listUsable.parameters.pageToken.type - resources.backendServices.methods.listUsable.parameters.project.description - resources.backendServices.methods.listUsable.parameters.project.location - resources.backendServices.methods.listUsable.parameters.project.pattern - resources.backendServices.methods.listUsable.parameters.project.required - resources.backendServices.methods.listUsable.parameters.project.type - resources.backendServices.methods.listUsable.parameters.returnPartialSuccess.description - resources.backendServices.methods.listUsable.parameters.returnPartialSuccess.location - resources.backendServices.methods.listUsable.parameters.returnPartialSuccess.type - resources.backendServices.methods.listUsable.path - resources.backendServices.methods.listUsable.response.$ref - resources.backendServices.methods.listUsable.scopes - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.diskTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.disks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.forwardingRules.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.globalOperations.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.healthChecks.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroupManagers.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instanceTemplates.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.instances.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.interconnectAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.interconnects.methods.getMacsecConfig.description - resources.interconnects.methods.getMacsecConfig.flatPath - resources.interconnects.methods.getMacsecConfig.httpMethod - resources.interconnects.methods.getMacsecConfig.id - resources.interconnects.methods.getMacsecConfig.parameterOrder - resources.interconnects.methods.getMacsecConfig.parameters.interconnect.description - resources.interconnects.methods.getMacsecConfig.parameters.interconnect.location - resources.interconnects.methods.getMacsecConfig.parameters.interconnect.pattern - resources.interconnects.methods.getMacsecConfig.parameters.interconnect.required - resources.interconnects.methods.getMacsecConfig.parameters.interconnect.type - resources.interconnects.methods.getMacsecConfig.parameters.project.description - resources.interconnects.methods.getMacsecConfig.parameters.project.location - resources.interconnects.methods.getMacsecConfig.parameters.project.pattern - resources.interconnects.methods.getMacsecConfig.parameters.project.required - resources.interconnects.methods.getMacsecConfig.parameters.project.type - resources.interconnects.methods.getMacsecConfig.path - resources.interconnects.methods.getMacsecConfig.response.$ref - resources.interconnects.methods.getMacsecConfig.scopes - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.machineTypes.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkAttachments.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEdgeSecurityServices.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.format - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.location - resources.networkEndpointGroups.methods.aggregatedList.parameters.serviceProjectNumber.type - resources.n… * feat(connectors): update the API #### connectors:v1 The following keys were added: - schemas.ConnectorInfraConfig.properties.connectionRatelimitWindowSeconds.description - schemas.ConnectorInfraConfig.properties.connectionRatelimitWindowSeconds.format - schemas.ConnectorInfraConfig.properties.connectionRatelimitWindowSeconds.type - schemas.ConnectorVersionInfraConfig.properties.connectionRatelimitWindowSeconds.description - schemas.ConnectorVersionInfraConfig.properties.connectionRatelimitWindowSeconds.format - schemas.ConnectorVersionInfraConfig.properties.connectionRatelimitWindowSeconds.readOnly - schemas.ConnectorVersionInfraConfig.properties.connectionRatelimitWindowSeconds.type * feat(contactcenterinsights)!: update the API BREAKING CHANGE: This release has breaking changes. #### contactcenterinsights:v1 The following keys were deleted: - schemas.GoogleCloudContactcenterinsightsV1ExportIssueModelResponse.description - schemas.GoogleCloudContactcenterinsightsV1ExportIssueModelResponse.id - schemas.GoogleCloudContactcenterinsightsV1ExportIssueModelResponse.type - schemas.GoogleCloudContactcenterinsightsV1ImportIssueModelResponse.description - schemas.GoogleCloudContactcenterinsightsV1ImportIssueModelResponse.id - schemas.GoogleCloudContactcenterinsightsV1ImportIssueModelResponse.type - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse.description - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse.id - schemas.GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse.type - schemas.GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse.description - schemas.GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse.id - schemas.GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse.type The following keys were added: - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.speechConfig.$ref - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.speechConfig.description - schemas.GoogleCloudContactcenterinsightsV1SpeechConfig.description - schemas.GoogleCloudContactcenterinsightsV1SpeechConfig.id - schemas.GoogleCloudContactcenterinsightsV1SpeechConfig.properties.speechRecognizer.description - schemas.GoogleCloudContactcenterinsightsV1SpeechConfig.properties.speechRecognizer.type - schemas.GoogleCloudContactcenterinsightsV1SpeechConfig.type - schemas.GoogleCloudContactcenterinsightsV1UploadConversationRequest.properties.speechConfig.$ref - schemas.GoogleCloudContactcenterinsightsV1UploadConversationRequest.properties.speechConfig.description - schemas.GoogleCloudContactcenterinsightsV1alpha1SpeechConfig.description - schemas.GoogleCloudContactcenterinsightsV1alpha1SpeechConfig.id - schemas.GoogleCloudContactcenterinsightsV1alpha1SpeechConfig.properties.speechRecognizer.description - schemas.GoogleCloudContactcenterinsightsV1alpha1SpeechConfig.properties.speechRecognizer.type - schemas.GoogleCloudContactcenterinsightsV1alpha1SpeechConfig.type - schemas.GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest.properties.speechConfig.$ref - schemas.GoogleCloudContactcenterinsightsV1alpha1UploadConversationRequest.properties.speechConfig.description * feat(container): update the API #### container:v1beta1 The following keys were added: - schemas.Cluster.properties.parentProductConfig.$ref - schemas.Cluster.properties.parentProductConfig.description - schemas.ClusterUpdate.properties.desiredInTransitEncryptionConfig.description - schemas.ClusterUpdate.properties.desiredInTransitEncryptionConfig.enum - schemas.ClusterUpdate.properties.desiredInTransitEncryptionConfig.enumDescriptions - schemas.ClusterUpdate.properties.desiredInTransitEncryptionConfig.type - schemas.ClusterUpdate.properties.desiredParentProductConfig.$ref - schemas.ClusterUpdate.properties.desiredParentProductConfig.description - schemas.NetworkConfig.properties.inTransitEncryptionConfig.description - schemas.NetworkConfig.properties.inTransitEncryptionConfig.enum - schemas.NetworkConfig.properties.inTransitEncryptionConfig.enumDescriptions - schemas.NetworkConfig.properties.inTransitEncryptionConfig.type - schemas.ParentProductConfig.description - schemas.ParentProductConfig.id - schemas.ParentProductConfig.properties.labels.additionalProperties.type - schemas.ParentProductConfig.properties.labels.description - schemas.ParentProductConfig.properties.labels.type - schemas.ParentProductConfig.properties.productName.description - schemas.ParentProductConfig.properties.productName.type - schemas.ParentProductConfig.type The following keys were changed: - schemas.BlueGreenInfo.properties.phase.enum - schemas.BlueGreenInfo.properties.phase.enumDescriptions - schemas.EphemeralStorageConfig.properties.localSsdCount.description - schemas.EphemeralStorageLocalSsdConfig.properties.localSsdCount.description - schemas.GatewayAPIConfig.properties.channel.enum - schemas.GatewayAPIConfig.properties.channel.enumDescriptions - schemas.LocalNvmeSsdBlockConfig.properties.localSsdCount.description #### container:v1 The following keys were added: - schemas.Cluster.properties.parentProductConfig.$ref - schemas.Cluster.properties.parentProductConfig.description - schemas.ClusterUpdate.properties.desiredParentProductConfig.$ref - schemas.ClusterUpdate.properties.desiredParentProductConfig.description - schemas.ParentProductConfig.description - schemas.ParentProductConfig.id - schemas.ParentProductConfig.properties.labels.additionalProperties.type - schemas.ParentProductConfig.properties.labels.description - schemas.ParentProductConfig.properties.labels.type - schemas.ParentProductConfig.properties.productName.description - schemas.ParentProductConfig.properties.productName.type - schemas.ParentProductConfig.type The following keys were changed: - schemas.EphemeralStorageLocalSsdConfig.description - schemas.EphemeralStorageLocalSsdConfig.properties.localSsdCount.description - schemas.GatewayAPIConfig.properties.channel.enum - schemas.GatewayAPIConfig.properties.channel.enumDescriptions - schemas.LocalNvmeSsdBlockConfig.description - schemas.LocalNvmeSsdBlockConfig.properties.localSsdCount.description * feat(containeranalysis)!: update the API BREAKING CHANGE: This release has breaking changes. #### containeranalysis:v1alpha1 The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.type - schemas.VulnerabilityDetails.properties.extraDetails.description - schemas.VulnerabilityDetails.properties.extraDetails.type #### containeranalysis:v1beta1 The following keys were deleted: - schemas.Vulnerability.properties.extraDetails.description - schemas.Vulnerability.properties.extraDetails.type The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.type - schemas.GrafeasV1beta1VulnerabilityDetails.properties.extraDetails.description - schemas.GrafeasV1beta1VulnerabilityDetails.properties.extraDetails.type #### containeranalysis:v1 The following keys were deleted: - schemas.VulnerabilityNote.properties.extraDetails.description - schemas.VulnerabilityNote.properties.extraDetails.type The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.description - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enum - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.enumDescriptions - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1StorageSource.properties.sourceFetcher.type - schemas.VulnerabilityOccurrence.properties.extraDetails.description - schemas.VulnerabilityOccurrence.properties.extraDetails.type * fix(content): update the API #### content:v2.1 The following keys were changed: - resources.freelistingsprogram.methods.requestreview.description - resources.liasettings.methods.setomnichannelexperience.description - resources.shoppingadsprogram.methods.requestreview.description * feat(contentwarehouse)!: update the API BREAKING CHANGE: This release has breaking changes. #### contentwarehouse:v1 The following keys were deleted: - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.hasSameStructure.description - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.hasSameStructure.type - schemas.ClassifierPornQueryClassifierOutput.properties.csaiRegexpHighConfidenceClassification.deprecated - schemas.ClassifierPornQueryClassifierOutput.properties.csaiRegexpHighConfidenceClassification.description - schemas.ClassifierPornQueryClassifierOutput.properties.csaiRegexpHighConfidenceClassification.enum - schemas.ClassifierPornQueryClassifierOutput.properties.csaiRegexpHighConfidenceClassification.enumDescriptions - schemas.ClassifierPornQueryClassifierOutput.properties.csaiRegexpHighConfidenceClassification.type - schemas.GeostoreCityJsonProtoTransformXyzVector.description - schemas.GeostoreCityJsonProtoTransformXyzVector.id - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.x.format - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.x.type - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.y.format - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.y.type - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.z.format - schemas.GeostoreCityJsonProtoTransformXyzVector.properties.z.type - schemas.GeostoreCityJsonProtoTransformXyzVector.type - schemas.GeostoreFeatureProto.properties.geopolitical.description - schemas.GeostoreFeatureProto.properties.transitStation.description - schemas.RepositoryWebrefFprintModifierProto.properties.capitalization.enum - schemas.RepositoryWebrefFprintModifierProto.properties.capitalization.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.capitalization.type - schemas.RepositoryWebrefFprintModifierProto.properties.enclosing.enum - schemas.RepositoryWebrefFprintModifierProto.properties.enclosing.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.enclosing.type - schemas.RepositoryWebrefFprintModifierProto.properties.punctuation.enum - schemas.RepositoryWebrefFprintModifierProto.properties.punctuation.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.punctuation.type - schemas.RepositoryWebrefFprintModifierProto.properties.sentence.enum - schemas.RepositoryWebrefFprintModifierProto.properties.sentence.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.sentence.type - schemas.RepositoryWebrefFprintModifierProto.properties.sourceType.enum - schemas.RepositoryWebrefFprintModifierProto.properties.sourceType.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.sourceType.type - schemas.RepositoryWebrefFprintModifierProto.properties.stemming.enum - schemas.RepositoryWebrefFprintModifierProto.properties.stemming.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.stemming.type - schemas.RepositoryWebrefFprintModifierProto.properties.style.enum - schemas.RepositoryWebrefFprintModifierProto.properties.style.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.style.type - schemas.RepositoryWebrefFprintModifierProto.properties.tokenType.enum - schemas.RepositoryWebrefFprintModifierProto.properties.tokenType.enumDeprecated - schemas.RepositoryWebrefFprintModifierProto.properties.tokenType.enumDescriptions - schemas.RepositoryWebrefFprintModifierProto.properties.tokenType.type The following keys were added: - schemas.AppsPeopleOzExternalMergedpeopleapiPerson.properties.contactCreateContextInfo.description - schemas.AppsPeopleOzExternalMergedpeopleapiPerson.properties.contactEditContextInfo.description - schemas.AssistantApiOnDeviceAssistantCapabilities.properties.isOnDeviceArbitrationSupported.deprecated - schemas.AssistantApiOnDeviceAssistantCapabilities.properties.isOnDeviceUnderstandingSupported.deprecated - schemas.AssistantApiSettingsDeviceSettings.properties.marketplaceDisclosure.deprecated - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameRoomAsHearingDevice.description - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameRoomAsHearingDevice.type - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameRoomAsLocalDevice.description - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameRoomAsLocalDevice.type - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameStructureAsHearingDevice.description - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameStructureAsHearingDevice.type - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameStructureAsLocalDevice.description - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.properties.inSameStructureAsLocalDevice.type - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.isScoreBasedIntent.description - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.isScoreBasedIntent.type - schemas.GeostoreCityJsonProtoTransformTranslate.description - schemas.GeostoreCityJsonProtoTransformTranslate.id - schemas.GeostoreCityJsonProtoTransformTranslate.properties.x.format - schemas.GeostoreCityJsonProtoTransformTranslate.properties.x.type - schemas.GeostoreCityJsonProtoTransformTranslate.properties.y.format - schemas.GeostoreCityJsonProtoTransformTranslate.properties.y.type - schemas.GeostoreCityJsonProtoTransformTranslate.properties.z.format - schemas.GeostoreCityJsonProtoTransformTranslate.properties.z.type - schemas.GeostoreCityJsonProtoTransformTranslate.type - schemas.GoogleAssistantAccessoryV1DeviceState.properties.installedApps.$ref - schemas.GoogleAssistantAccessoryV1DeviceState.properties.installedApps.description - schemas.GoogleAssistantAccessoryV1DeviceState.properties.installedAppsZlib.description - schemas.GoogleAssistantAccessoryV1DeviceState.properties.installedAppsZlib.format - schemas.GoogleAssistantAccessoryV1DeviceState.properties.installedAppsZlib.type - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.description - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.id - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.properties.apps.description - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.properties.apps.items.$ref - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.properties.apps.type - schemas.GoogleAssistantAccessoryV1DeviceStateInstalledAppsState.type - schemas.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.properties.matchedTokenPageIndices.description - schemas.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.properties.matchedTokenPageIndices.items.format - schemas.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.properties.matchedTokenPageIndices.items.type - schemas.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.properties.matchedTokenPageIndices.type - schemas.KnowledgeAnswersIntentQueryConceptSignals.description - schemas.KnowledgeAnswersIntentQueryConceptSignals.id - schemas.KnowledgeAnswersIntentQueryConceptSignals.properties.dataEpochId.description - schemas.KnowledgeAnswersIntentQueryConceptSignals.properties.dataEpochId.format - schemas.KnowledgeAnswersIntentQueryConceptSignals.properties.dataEpochId.type - schemas.KnowledgeAnswersIntentQueryConceptSignals.type - schemas.KnowledgeAnswersIntentQueryFunctionCallSignals.properties.conceptSignals.$ref - schemas.KnowledgeAnswersIntentQueryFunctionCallSignals.properties.conceptSignals.description - schemas.QualityOrbitAsteroidBeltImageIntentScores.description - schemas.QualityPreviewRanklabTitle.properties.sourceGeneratedTitle.type - schemas.RepositoryWebrefMetaTagIndices.description - schemas.RepositoryWebrefMetaTagIndices.id - schemas.RepositoryWebrefMetaTagIndices.properties.index.format - schemas.RepositoryWebrefMetaTagIndices.properties.index.type - schemas.RepositoryWebrefMetaTagIndices.properties.metaName.enum - schemas.RepositoryWebrefMetaTagIndices.properties.metaName.enumDescriptions - schemas.RepositoryWebrefMetaTagIndices.properties.metaName.type - schemas.RepositoryWebrefMetaTagIndices.type - schemas.RepositoryWebrefSubSegmentIndex.properties.metaTagIndex.$ref - schemas.RepositoryWebrefSubSegmentIndex.properties.metaTagIndex.description - schemas.SocialGraphWireProtoPeopleapiAffinityMetadata.properties.suggestionConfidence.description - schemas.SocialGraphWireProtoPeopleapiAffinityMetadata.properties.suggestionConfidence.enum - schemas.SocialGraphWireProtoPeopleapiAffinityMetadata.properties.suggestionConfidence.enumDescriptions - schemas.SocialGraphWireProtoPeopleapiAffinityMetadata.properties.suggestionConfidence.type - schemas.SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData.properties.suggestionConfidence.enum - schemas.SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData.properties.suggestionConfidence.enumDescriptions - schemas.SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData.properties.suggestionConfidence.type The following keys were changed: - schemas.AppsPeopleOzExternalMergedpeopleapiAffinity.properties.affinityType.enum - schemas.AppsPeopleOzExternalMergedpeopleapiAffinity.properties.affinityType.enumDeprecated - schemas.AppsPeopleOzExternalMergedpeopleapiAffinity.properties.affinityType.enumDescriptions - schemas.AppsPeopleOzExternalMergedpeopleapiPersonFieldMetadata.properties.encodedContainerId.description - schemas.AppsPeopleOzExternalMergedpeopleapiRawDeviceContactInfo.properties.id.description - schemas.AssistantApiClientOpPropertiesDeviceModifySettingClientOpProperty.properties.supportedSettings.items.enum - schemas.AssistantGroundingRankerDeviceTargetingFeaturesStates.description - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.description - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.intentType.enum - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.intentType.enumDescriptions - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.rankerName.enum - schemas.AssistantPrefulfillmentRankerPrefulfillmentSignals.properties.rankerName.enumDescriptions - schemas.GeostoreCityJsonProtoTransform.properties.translate.$ref - schemas.GeostoreFeatureProto.properties.disputedArea.description - schemas.GeostoreFlowLineProto.properties.curvature.description - schemas.GeostoreInternalSegmentProto.properties.disallowedConnections.description - schemas.GeostoreInternalSegmentProto.properties.disallowedPrimaryConnection.description - schemas.GeostorePoliticalProto.properties.claim.description - schemas.GeostoreRestrictionProto.properties.type.description - schemas.GeostoreRestrictionProto.properties.type.enum - schemas.GeostoreRestrictionProto.properties.type.enumDescriptions - schemas.GoogleAssistantAccessoryV1DeviceState.description - schemas.GoogleAssistantAccessoryV1DeviceState.properties.unavailableSettings.items.enum - schemas.KnowledgeAnswersIntentQueryFunctionCallSignals.description - schemas.PeoplestackFlexorgsProtoInternalExternal.properties.application.enum - schemas.PeoplestackFlexorgsProtoInternalExternal.properties.application.enumDeprecated - schemas.PeoplestackFlexorgsProtoInternalExternal.properties.application.enumDescriptions - schemas.QualityPreviewRanklabTitle.description - schemas.SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData.description - schemas.TrawlerFetchReplyDataProtocolResponse.properties.ContentType.enumDescriptions - schemas.VendingConsumerProtoTrustedGenomeAnnotation.properties.testCode.items.enum - schemas.VendingConsumerProtoTrustedGenomeAnnotation.properties.testCode.items.enumDeprecated - schemas.VendingConsumerProtoTrustedGenomeAnnotation.properties.testCode.items.enumDescriptions - schemas.VideoContentSearchFrameStarburstData.properties.sbVersion.enum - schemas.VideoContentSearchFrameStarburstData.properties.sbVersion.enumDeprecated - schemas.VideoContentSearchFrameStarburstData.properties.sbVersion.enumDescriptions - schemas.YoutubeDiscoveryLegosLegosSemanticRelationshipContext.properties.type.enum * feat(datalabeling): update the API #### datalabeling:v1beta1 The following keys were added: - schemas.GoogleCloudDatalabelingV1beta1Instruction.properties.csvInstruction.deprecated - schemas.GoogleCloudDatalabelingV1beta1TextClassificationConfig.properties.sentimentConfig.deprecated The following keys were changed: - schemas.GoogleLongrunningOperation.properties.response.description * feat(dataplex): update the API #### dataplex:v1 The following keys were added: - schemas.GoogleCloudDataplexV1DataQualityDimension.description - schemas.GoogleCloudDataplexV1DataQualityDimension.id - schemas.GoogleCloudDataplexV1DataQualityDimension.properties.name.description - schemas.GoogleCloudDataplexV1DataQualityDimension.properties.name.type - schemas.GoogleCloudDataplexV1DataQualityDimension.type - schemas.GoogleCloudDataplexV1DataQualityDimensionResult.properties.dimension.$ref - schemas.GoogleCloudDataplexV1DataQualityDimensionResult.properties.dimension.description - schemas.GoogleCloudDataplexV1DataQualityDimensionResult.properties.dimension.readOnly - schemas.GoogleCloudDataplexV1GovernanceEvent.description - schemas.GoogleCloudDataplexV1GovernanceEvent.id - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.entity.$ref - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.entity.description - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.eventType.description - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.eventType.enum - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.eventType.enumDescriptions - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.eventType.type - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.message.description - schemas.GoogleCloudDataplexV1GovernanceEvent.properties.message.type - schemas.GoogleCloudDataplexV1GovernanceEvent.type - schemas.GoogleCloudDataplexV1GovernanceEventEntity.description - schemas.GoogleCloudDataplexV1GovernanceEventEntity.id - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entity.description - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entity.type - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entityType.description - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entityType.enum - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entityType.enumDescriptions - schemas.GoogleCloudDataplexV1GovernanceEventEntity.properties.entityType.type - schemas.GoogleCloudDataplexV1GovernanceEventEntity.type * feat(dataproc): update the API #### dataproc:v1 The following keys were added: - resources.projects.resources.regions.resources.clusters.resources.nodeGroups.methods.create.parameters.parentOperationId.description - resources.projects.resources.regions.resources.clusters.resources.nodeGroups.methods.create.parameters.parentOperationId.location - resources.projects.resources.regions.resources.clusters.resources.nodeGroups.methods.create.parameters.parentOperationId.type - schemas.InstanceGroupConfig.properties.startupConfig.$ref - schemas.InstanceGroupConfig.properties.startupConfig.description - schemas.ResizeNodeGroupRequest.properties.parentOperationId.description - schemas.ResizeNodeGroupRequest.properties.parentOperationId.type - schemas.SparkStandaloneAutoscalingConfig.properties.removeOnlyIdleWorkers.description - schemas.SparkStandaloneAutoscalingConfig.properties.removeOnlyIdleWorkers.type - schemas.StartupConfig.description - schemas.StartupConfig.id - schemas.StartupConfig.properties.requiredRegistrationFraction.description - schemas.StartupConfig.properties.requiredRegistrationFraction.format - schemas.StartupConfig.properties.requiredRegistrationFraction.type - schemas.StartupConfig.type * fix(deploymentmanager): update the API #### deploymentmanager:v2 The following keys were changed: - resources.deployments.methods.list.parameters.filter.description - resources.manifests.methods.list.parameters.filter.description - resources.operations.methods.list.parameters.filter.description - resources.resources.methods.list.parameters.filter.description - resources.types.methods.list.parameters.filter.description * feat(dialogflow): update the API #### dialogflow:v2beta1 The following keys were added: - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.id - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.id - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.type #### dialogflow:v3beta1 The following keys were added: - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.flatPath - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.httpMethod - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.id - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameterOrder - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.path - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.request.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.response.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.scopes - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.flatPath - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.httpMethod - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.id - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameterOrder - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.path - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.request.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.response.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.scopes - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.id - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.dataFormat.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.dataFormat.enum - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.dataFormat.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.dataFormat.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intents.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intents.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intentsContentInline.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intentsContentInline.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsRequest.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.mergeOption.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.mergeOption.enum - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.mergeOption.enumDeprecated - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.mergeOption.enumDescriptions - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.properties.mergeOption.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsRequest.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.id - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.type - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.description - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.id - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.properties.content.description - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.properties.content.format - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.properties.content.type - schemas.GoogleCloudDialogflowCxV3beta1InlineSource.type #### dialogflow:v2 The following keys were added: - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.id - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.id - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.type #### dialogflow:v3 The following keys were added: - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.flatPath - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.httpMethod - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.id - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameterOrder - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.path - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.request.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.response.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.export.scopes - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.flatPath - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.httpMethod - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.id - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameterOrder - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.description - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.location - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.pattern - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.required - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.parameters.parent.type - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.path - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.request.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.response.$ref - resources.projects.resources.locations.resources.agents.resources.intents.methods.import.scopes - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.dataFormat.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.dataFormat.enum - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.dataFormat.enumDescriptions - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.dataFormat.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intents.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intents.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intentsContentInline.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intentsContentInline.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsRequest.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.mergeOption.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.mergeOption.enum - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.mergeOption.enumDeprecated - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.mergeOption.enumDescriptions - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.properties.mergeOption.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsRequest.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.id - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3InlineDestination.type - schemas.GoogleCloudDialogflowCxV3InlineSource.description - schemas.GoogleCloudDialogflowCxV3InlineSource.id - schemas.GoogleCloudDialogflowCxV3InlineSource.properties.content.description - schemas.GoogleCloudDialogflowCxV3InlineSource.properties.content.format - schemas.GoogleCloudDialogflowCxV3InlineSource.properties.content.type - schemas.GoogleCloudDialogflowCxV3InlineSource.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.$ref - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsContent.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.description - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.properties.intentsUri.type - schemas.GoogleCloudDialogflowCxV3beta1ExportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.$ref - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.conflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.properties.intents.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponse.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.id - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.entityDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.description - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.items.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.properties.intentDisplayNames.type - schemas.GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.id - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.description - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.format - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.readOnly - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.properties.content.type - schemas.GoogleCloudDialogflowCxV3beta1InlineDestination.type * feat(discoveryengine): update the API #### discoveryengine:v1alpha The following keys were added: - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.flatPath - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.httpMethod - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.id - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameterOrder - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.description - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.location - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.pattern - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.required - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.type - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.path - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.request.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.response.$ref - resources.projects.resources.locations.resources.collections.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.scopes - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.flatPath - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.httpMethod - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.id - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameterOrder - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.description - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.location - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.pattern - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.required - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.parameters.siteSearchEngine.type - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.path - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.request.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.response.$ref - resources.projects.resources.locations.resources.dataStores.resources.siteSearchEngine.methods.recrawlUris.scopes - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.properties.uris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.properties.uris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.properties.uris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.enum - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.errorMessage.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.errorMessage.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponse.properties.geoSearchDebugInfo.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponse.properties.geoSearchDebugInfo.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.id - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.properties.errorMessage.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.properties.errorMessage.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.properties.originalAddressQuery.description - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.properties.originalAddressQuery.type - schemas.GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.readOnly - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.minimumDataTermAccepted.type - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.description - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.enum - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaWidgetConfig.properties.resultDisplayType.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.parameters.queryModel.description - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.parameters.queryModel.description - schemas.GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest.properties.queryModel.description - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.fieldType.enum - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.fieldType.enumDescriptions #### discoveryengine:v1beta The following keys were added: - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.parameters.servingConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.recommend.scopes - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.flatPath - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.httpMethod - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.id - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameterOrder - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.description - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.location - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.pattern - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.required - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.parameters.servingConfig.type - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.path - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.request.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.response.$ref - resources.projects.resources.locations.resources.collections.resources.engines.resources.servingConfigs.methods.search.scopes - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.createTime.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.invalidUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.pendingCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.quotaExceededCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.successCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.updateTime.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.format - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.properties.validUrisCount.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.items.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failedUris.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.properties.failureSamples.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.items.$ref - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.failureReasons.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.uri.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.properties.uri.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.id - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.enum - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.enumDescriptions - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.corpusType.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.errorMessage.description - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.properties.errorMessage.type - schemas.GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponse.properties.geoSearchDebugInfo.items.$ref - schemas.GoogleCloudDiscoveryengineV1betaSearchResponse.properties.geoSearchDebugInfo.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.id - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.properties.errorMessage.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.properties.errorMessage.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.properties.originalAddressQuery.description - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.properties.originalAddressQuery.type - schemas.GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo.type The following keys were changed: - resources.projects.resources.locations.resources.collections.resources.dataStores.methods.completeQuery.parameters.queryModel.description - resources.projects.resources.locations.resources.dataStores.methods.completeQuery.parameters.queryModel.description - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.fieldType.enum - schemas.GoogleCloudDiscoveryengineV1alphaFieldConfig.properties.fieldType.enumDescriptions * feat(displayvideo)!: update the API BREAKING CHANGE: This release has breaking changes. #### displayvideo:v1 The following keys were deleted: - schemas.BulkEditAssignedLocationsResponse.description The following keys were changed: - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.description - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.description - schemas.AssignedLocation.description - schemas.AssignedLocation.properties.targetingOptionId.description - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.description - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.description - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.description - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.description - schemas.CustomBiddingScript.properties.errors.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.description - schemas.GenderAssignedTargetingOptionDetails.properties.gender.description - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.enumDescriptions - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.description - schemas.InsertionOrderBudget.properties.automationType.enumDescriptions - schemas.LineItem.properties.lineItemType.enumDescriptions - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.description - schemas.OmidAssignedTargetingOptionDetails.properties.omid.description - schemas.Pacing.properties.pacingPeriod.description - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.description - schemas.PerformanceGoal.description - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.description - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.description #### displayvideo:v2 The following keys were deleted: - schemas.BulkEditAssignedLocationsResponse.description The following keys were changed: - resources.advertisers.resources.locationLists.resources.assignedLocations.methods.bulkEdit.description - resources.advertisers.resources.youtubeAdGroups.methods.bulkListAdGroupAssignedTargetingOptions.description - resources.advertisers.resources.youtubeAdGroups.methods.bulkListAdGroupAssignedTargetingOptions.parameters.orderBy.description - schemas.Advertiser.properties.billingConfig.description - schemas.AdvertiserBillingConfig.properties.billingProfileId.description - schemas.AgeRangeAssignedTargetingOptionDetails.properties.ageRange.description - schemas.AssignedLocation.description - schemas.AssignedLocation.properties.targetingOptionId.description - schemas.AudioContentTypeAssignedTargetingOptionDetails.properties.audioContentType.description - schemas.BulkEditAssignedLocationsRequest.properties.createdAssignedLocations.description - schemas.BulkEditAssignedLocationsRequest.properties.deletedAssignedLocations.description - schemas.BulkListAdGroupAssignedTargetingOptionsResponse.properties.nextPageToken.description - schemas.ContentInstreamPositionAssignedTargetingOptionDetails.properties.contentInstreamPosition.description - schemas.ContentOutstreamPositionAssignedTargetingOptionDetails.properties.contentOutstreamPosition.description - schemas.CustomBiddingScript.properties.errors.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.description - schemas.DeviceTypeAssignedTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.DeviceTypeTargetingOptionDetails.properties.deviceType.enumDescriptions - schemas.EnvironmentAssignedTargetingOptionDetails.properties.environment.description - schemas.GenderAssignedTargetingOptionDetails.properties.gender.description - schemas.GenerateDefaultLineItemRequest.properties.lineItemType.enumDescriptions - schemas.HouseholdIncomeAssignedTargetingOptionDetails.properties.householdIncome.description - schemas.InsertionOrderBudget.properties.automationType.enumDescriptions - schemas.LineItem.properties.lineItemType.enumDescriptions - schemas.NativeContentPositionAssignedTargetingOptionDetails.properties.contentPosition.description - schemas.OmidAssignedTargetingOptionDetails.properties.omid.description - schemas.Pacing.properties.pacingPeriod.description - schemas.ParentalStatusAssignedTargetingOptionDetails.properties.parentalStatus.description - schemas.PerformanceGoal.description - schemas.VideoPlayerSizeAssignedTargetingOptionDetails.properties.videoPlayerSize.description - schemas.ViewabilityAssignedTargetingOptionDetails.properties.viewability.description - schemas.YoutubeAdGroupAssignedTargetingOption.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.description - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaSource.enumDescriptions - schemas.YoutubeAndPartnersBiddingStrategy.properties.adGroupEffectiveTargetCpaValue.description * feat(dlp): update the API #### dlp:v2 The following keys were added: - schemas.GooglePrivacyDlpV2DlpJob.properties.lastModified.description - schemas.GooglePrivacyDlpV2DlpJob.properties.lastModified.format - schemas.GooglePrivacyDlpV2DlpJob.properties.lastModified.type The following keys were changed: - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.locationCategory.enum - schemas.GooglePrivacyDlpV2InfoTypeCategory.properties.locationCategory.enumDescriptions * feat(docs): update the API #### docs:v1 The following keys were added: - schemas.DocumentStyle.properties.flipPageOrientation.description - schemas.DocumentStyle.properties.flipPageOrientation.type - schemas.DocumentStyleSuggestionState.properties.flipPageOrientationSuggested.description - schemas.DocumentStyleSuggestionState.properties.flipPageOrientationSuggested.type - schemas.SectionStyle.properties.flipPageOrientation.description - schemas.SectionStyle.properties.flipPageOrientation.type * feat(documentai): update the API #### documentai:v1beta2 The following keys were changed: - schemas.GoogleCloudDocumentaiV1beta3Dataset.description #### documentai:v1beta3 The following keys were added: - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.description - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.flatPath - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.httpMethod - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.id - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameterOrder - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameters.dataset.description - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameters.dataset.location - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameters.dataset.pattern - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameters.dataset.required - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.parameters.dataset.type - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.path - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.request.$ref - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.response.$ref - resources.projects.resources.locations.resources.processors.resources.dataset.methods.listDocuments.scopes - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.id - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.datasetType.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.datasetType.enum - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.datasetType.enumDescriptions - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.datasetType.type - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.displayName.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.displayName.type - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.documentId.$ref - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.documentId.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.labelingState.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.labelingState.enum - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.labelingState.enumDescriptions - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.labelingState.type - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.pageCount.description - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.pageCount.format - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.properties.pageCount.type - schemas.GoogleCloudDocumentaiV1beta3DocumentMetadata.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.id - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.filter.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.filter.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.pageSize.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.pageSize.format - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.pageSize.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.pageToken.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.pageToken.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.returnTotalSize.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.returnTotalSize.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.skip.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.skip.format - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.properties.skip.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsRequest.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.id - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.documentMetadata.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.documentMetadata.items.$ref - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.documentMetadata.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.nextPageToken.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.nextPageToken.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.totalSize.description - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.totalSize.format - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.properties.totalSize.type - schemas.GoogleCloudDocumentaiV1beta3ListDocumentsResponse.type The following keys were changed: - schemas.GoogleCloudDocumentaiV1beta3Dataset.description - schemas.GoogleCloudDocumentaiV1beta3OcrConfig.properties.disableCharacterBoxesDetection.description - schemas.GoogleCloudDocumentaiV1beta3OcrConfigPremiumFeatures.properties.enableSelectionMarkDetection.description - schemas.GoogleCloudDocumentaiV1beta3ProcessOptions.properties.fromStart.description #### documentai:v1 The following keys were changed: - schemas.GoogleCloudDocumentaiV1OcrConfig.properties.disableCharacterBoxesDetection.description - schemas.GoogleCloudDocumentaiV1OcrConfigPremiumFeatures.properties.enableSelectionMarkDetection.description - schemas.GoogleCloudDocumentaiV1ProcessOptions.properties.fromStart.description - schemas.GoogleCloudDocumentaiV1beta3Dataset.description * feat(eventarc)!: update the API BREAKING CHANGE: This release has breaking changes. #### eventarc:v1 The following keys were deleted: - schemas.HttpEndpoint.properties.forwardDnsRequests.description - schemas.HttpEndpoint.properties.forwardDnsRequests.type * feat(firestore): update the API #### firestore:v1beta1 The following keys were changed: - schemas.PartitionQueryResponse.properties.partitions.description #### firestore:v1 The following keys were added: - schemas.GoogleFirestoreAdminV1FlatIndex.description - schemas.GoogleFirestoreAdminV1FlatIndex.id - schemas.GoogleFirestoreAdminV1FlatIndex.type - schemas.GoogleFirestoreAdminV1IndexField.properties.vectorConfig.$ref - schemas.GoogleFirestoreAdminV1IndexField.properties.vectorConfig.description - schemas.GoogleFirestoreAdminV1VectorConfig.description - schemas.GoogleFirestoreAdminV1VectorConfig.id - schemas.GoogleFirestoreAdminV1VectorConfig.properties.dimension.description - schemas.GoogleFirestoreAdminV1VectorConfig.properties.dimension.format - schemas.GoogleFirestoreAdminV1VectorConfig.properties.dimension.type - schemas.GoogleFirestoreAdminV1VectorConfig.properties.flat.$ref - schemas.GoogleFirestoreAdminV1VectorConfig.properties.flat.description - schemas.GoogleFirestoreAdminV1VectorConfig.type The following keys were changed: - schemas.GoogleFirestoreAdminV1ExportDocumentsRequest.properties.snapshotTime.description - schemas.GoogleFirestoreAdminV1RestoreDatabaseRequest.properties.backup.description - schemas.PartitionQueryResponse.properties.partitions.description * feat(gkebackup)!: update the API BREAKING CHANGE: This release has breaking changes. #### gkebackup:v1 The following keys were deleted: - resources.projects.resources.locations.methods.deleteOperations.description - resources.projects.resources.locations.methods.deleteOperations.flatPath - resources.projects.resources.locations.methods.deleteOperations.httpMethod - resources.projects.resources.locations.methods.deleteOperations.id - resources.projects.resources.locations.methods.deleteOperations.parameterOrder - resources.projects.resources.locations.methods.deleteOperations.parameters.name.description - resources.projects.resources.locations.methods.deleteOperations.parameters.name.location - resources.projects.resources.locations.methods.deleteOperations.parameters.name.pattern - resources.projects.resources.locations.methods.deleteOperations.parameters.name.required - resources.projects.resources.locations.methods.deleteOperations.parameters.name.type - resources.projects.resources.locations.methods.deleteOperations.path - resources.projects.resources.locations.methods.deleteOperations.response.$ref - resources.projects.resources.locations.methods.deleteOperations.scopes The following keys were added: - resources.projects.resources.locations.resources.operations.methods.delete.description - resources.projects.resources.locations.resources.operations.methods.delete.flatPath - resources.projects.resources.locations.resources.operations.methods.delete.httpMethod - resources.projects.resources.locations.resources.operations.methods.delete.id - resources.projects.resources.locations.resources.operations.methods.delete.parameterOrder - resources.projects.resources.locations.resources.operations.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.operations.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.operations.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.operations.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.operations.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.operations.methods.delete.path - resources.projects.resources.locations.resources.operations.methods.delete.response.$ref - resources.projects.resources.locations.resources.operations.methods.delete.scopes The following keys were changed: - schemas.ResourceFilter.properties.namespaces.description * feat(gkehub)!: update the API BREAKING CHANGE: This release has breaking changes. #### gkehub:v1alpha The following keys were deleted: - schemas.Scope.properties.allMemberships.description - schemas.Scope.properties.allMemberships.type #### gkehub:v1beta The following keys were deleted: - schemas.Scope.properties.allMemberships.description - schemas.Scope.properties.allMemberships.type The following keys were added: - resources.projects.resources.locations.resources.memberships.methods.create.description - resources.projects.resources.locations.resources.memberships.methods.create.flatPath - resources.projects.resources.locations.resources.memberships.methods.create.httpMethod - resources.projects.resources.locations.resources.memberships.methods.create.id - resources.projects.resources.locations.resources.memberships.methods.create.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.create.parameters.membershipId.description - resources.projects.resources.locations.resources.memberships.methods.create.parameters.membershipId.location - resources.projects.resources.locations.resources.memberships.methods.create.parameters.membershipId.type - resources.projects.resources.locations.resources.memberships.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.memberships.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.memberships.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.memberships.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.memberships.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.memberships.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.memberships.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.memberships.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.memberships.methods.create.path - resources.projects.resources.locations.resources.memberships.methods.create.request.$ref - resources.projects.resources.locations.resources.memberships.methods.create.response.$ref - resources.projects.resources.locations.resources.memberships.methods.create.scopes - resources.projects.resources.locations.resources.memberships.methods.delete.description - resources.projects.resources.locations.resources.memberships.methods.delete.flatPath - resources.projects.resources.locations.resources.memberships.methods.delete.httpMethod - resources.projects.resources.locations.resources.memberships.methods.delete.id - resources.projects.resources.locations.resources.memberships.methods.delete.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.force.description - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.force.location - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.force.type - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.memberships.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.memberships.methods.delete.path - resources.projects.resources.locations.resources.memberships.methods.delete.response.$ref - resources.projects.resources.locations.resources.memberships.methods.delete.scopes - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.flatPath - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.httpMethod - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.id - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.imagePullSecretContent.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.imagePullSecretContent.format - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.imagePullSecretContent.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.imagePullSecretContent.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.isUpgrade.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.isUpgrade.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.isUpgrade.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.name.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.name.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.name.pattern - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.name.required - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.name.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.namespace.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.namespace.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.namespace.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.proxy.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.proxy.format - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.proxy.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.proxy.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.registry.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.registry.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.registry.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.version.description - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.version.location - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.parameters.version.type - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.path - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.response.$ref - resources.projects.resources.locations.resources.memberships.methods.generateConnectManifest.scopes - resources.projects.resources.locations.resources.memberships.methods.get.description - resources.projects.resources.locations.resources.memberships.methods.get.flatPath - resources.projects.resources.locations.resources.memberships.methods.get.httpMethod - resources.projects.resources.locations.resources.memberships.methods.get.id - resources.projects.resources.locations.resources.memberships.methods.get.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.get.parameters.name.description - resources.projects.resources.locations.resources.memberships.methods.get.parameters.name.location - resources.projects.resources.locations.resources.memberships.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.memberships.methods.get.parameters.name.required - resources.projects.resources.locations.resources.memberships.methods.get.parameters.name.type - resources.projects.resources.locations.resources.memberships.methods.get.path - resources.projects.resources.locations.resources.memberships.methods.get.response.$ref - resources.projects.resources.locations.resources.memberships.methods.get.scopes - resources.projects.resources.locations.resources.memberships.methods.list.description - resources.projects.resources.locations.resources.memberships.methods.list.flatPath - resources.projects.resources.locations.resources.memberships.methods.list.httpMethod - resources.projects.resources.locations.resources.memberships.methods.list.id - resources.projects.resources.locations.resources.memberships.methods.list.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.memberships.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.memberships.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.memberships.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.memberships.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.memberships.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.memberships.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.memberships.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.memberships.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.memberships.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.memberships.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.memberships.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.memberships.methods.list.path - resources.projects.resources.locations.resources.memberships.methods.list.response.$ref - resources.projects.resources.locations.resources.memberships.methods.list.scopes - resources.projects.resources.locations.resources.memberships.methods.patch.description - resources.projects.resources.locations.resources.memberships.methods.patch.flatPath - resources.projects.resources.locations.resources.memberships.methods.patch.httpMethod - resources.projects.resources.locations.resources.memberships.methods.patch.id - resources.projects.resources.locations.resources.memberships.methods.patch.parameterOrder - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.memberships.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.memberships.methods.patch.path - resources.projects.resources.locations.resources.memberships.methods.patch.request.$ref - resources.projects.resources.locations.resources.memberships.methods.patch.response.$ref - resources.projects.resources.locations.resources.memberships.methods.patch.scopes - schemas.ApplianceCluster.description - schemas.ApplianceCluster.id - schemas.ApplianceCluster.properties.resourceLink.description - schemas.ApplianceCluster.properties.resourceLink.type - schemas.ApplianceCluster.type - schemas.Authority.description - schemas.Authority.id - schemas.Authority.properties.identityProvider.description - schemas.Authority.properties.identityProvider.readOnly - schemas.Authority.properties.identityProvider.type - schemas.Authority.properties.issuer.description - schemas.Authority.properties.issuer.type - schemas.Authority.properties.oidcJwks.description - schemas.Authority.properties.oidcJwks.format - schemas.Authority.properties.oidcJwks.type - schemas.Authority.properties.workloadIdentityPool.description - schemas.Authority.properties.workloadIdentityPool.readOnly - schemas.Authority.properties.workloadIdentityPool.type - schemas.Authority.type - schemas.ConnectAgentResource.description - schemas.ConnectAgentResource.id - schemas.ConnectAgentResource.properties.manifest.description - schemas.ConnectAgentResource.properties.manifest.type - schemas.ConnectAgentResource.properties.type.$ref - schemas.ConnectAgentResource.properties.type.description - schemas.ConnectAgentResource.type - schemas.EdgeCluster.description - schemas.EdgeCluster.id - schemas.EdgeCluster.properties.resourceLink.description - schemas.EdgeCluster.properties.resourceLink.type - schemas.EdgeCluster.type - schemas.GenerateConnectManifestResponse.description - schemas.GenerateConnectManifestResponse.id - schemas.GenerateConnectManifestResponse.properties.manifest.description - schemas.GenerateConnectManifestResponse.properties.manifest.items.$ref - schemas.GenerateConnectManifestResponse.properties.manifest.type - schemas.GenerateConnectManifestResponse.type - schemas.GkeCluster.description - schemas.GkeCluster.id - schemas.GkeCluster.properties.clusterMissing.description - schemas.GkeCluster.properties.clusterMissing.readOnly - schemas.GkeCluster.properties.clusterMissing.type - schemas.GkeCluster.properties.resourceLink.description - schemas.GkeCluster.properties.resourceLink.type - schemas.GkeCluster.type - schemas.KubernetesMetadata.description - schemas.KubernetesMetadata.id - schemas.KubernetesMetadata.properties.kubernetesApiServerVersion.description - schemas.KubernetesMetadata.properties.kubernetesApiServerVersion.readOnly - schemas.KubernetesMetadata.properties.kubernetesApiServerVersion.type - schemas.KubernetesMetadata.properties.memoryMb.description - schemas.KubernetesMetadata.properties.memoryMb.format - schemas.KubernetesMetadata.properties.memoryMb.readOnly - schemas.KubernetesMetadata.properties.memoryMb.type - schemas.KubernetesMetadata.properties.nodeCount.description - schemas.KubernetesMetadata.properties.nodeCount.format - schemas.KubernetesMetadata.properties.nodeCount.readOnly - schemas.KubernetesMetadata.properties.nodeCount.type - schemas.KubernetesMetadata.properties.nodeProviderId.description - schemas.KubernetesMetadata.properties.nodeProviderId.readOnly - schemas.KubernetesMetadata.properties.nodeProviderId.type - schemas.KubernetesMetadata.properties.updateTime.description - schemas.KubernetesMetadata.properties.updateTime.format - schemas.KubernetesMetadata.properties.updateTime.readOnly - schemas.KubernetesMetadata.properties.updateTime.type - schemas.KubernetesMetadata.properties.vcpuCount.description - schemas.KubernetesMetadata.properties.vcpuCount.format - schemas.KubernetesMetadata.properties.vcpuCount.readOnly - schemas.KubernetesMetadata.properties.vcpuCount.type - schemas.KubernetesMetadata.type - schemas.KubernetesResource.description - schemas.KubernetesResource.id - schemas.KubernetesResource.properties.connectResources.description - schemas.KubernetesResource.properties.connectResources.items.$ref - schemas.KubernetesResource.properties.connectResources.readOnly - schemas.KubernetesResource.properties.connectResources.type - schemas.KubernetesResource.properties.membershipCrManifest.description - schemas.KubernetesResource.properties.membershipCrManifest.type - schemas.KubernetesResource.properties.membershipResources.description - schemas.KubernetesResource.properties.membershipResources.items.$ref - schemas.KubernetesResource.properties.membershipResources.readOnly - schemas.KubernetesResource.properties.membershipResources.type - schemas.KubernetesResource.properties.resourceOptions.$ref - schemas.KubernetesResource.properties.resourceOptions.description - schemas.KubernetesResource.type - schemas.ListMembershipsResponse.description - schemas.ListMembershipsResponse.id - schemas.ListMembershipsResponse.properties.nextPageToken.description - schemas.ListMembershipsResponse.properties.nextPageToken.type - schemas.ListMembershipsResponse.properties.resources.description - schemas.ListMembershipsResponse.properties.resources.items.$ref - schemas.ListMembershipsResponse.properties.resources.type - schemas.ListMembershipsResponse.properties.unreachable.description - schemas.ListMembershipsResponse.properties.unreachable.items.type - schemas.ListMembershipsResponse.properties.unreachable.type - schemas.ListMembershipsResponse.type - schemas.Membership.description - schemas.Membership.id - schemas.Membership.properties.authority.$ref - schemas.Membership.properties.authority.description - schemas.Membership.properties.createTime.description - schemas.Membership.properties.createTime.format - schemas.Membership.properties.createTime.readOnly - schemas.Membership.properties.createTime.type - schemas.Membership.properties.deleteTime.description - schemas.Membership.properties.deleteTime.format - schemas.Membership.properties.deleteTime.readOnly - schemas.Membership.properties.deleteTime.type - schemas.Membership.properties.description.description - schemas.Membership.properties.description.readOnly - schemas.Membership.properties.description.type - schemas.Membership.properties.endpoint.$ref - schemas.Membership.properties.endpoint.description - schemas.Membership.properties.externalId.description - schemas.Membership.properties.externalId.type - schemas.Membership.properties.labels.additionalProperties.type - schemas.Membership.properties.labels.description - schemas.Membership.properties.labels.type - schemas.Membership.properties.lastConnectionTime.description - schemas.Membership.properties.lastConnectionTime.format - schemas.Membership.properties.lastConnectionTime.readOnly - schemas.Membership.properties.lastConnectionTime.type - schemas.Membership.properties.monitoringConfig.$ref - schemas.Membership.properties.monitoringConfig.description - schemas.Membership.properties.name.description - schemas.Membership.properties.name.readOnly - schemas.Membership.properties.name.type - schemas.Membership.properties.state.$ref - schemas.Membership.properties.state.description - schemas.Membership.properties.state.readOnly - schemas.Membership.properties.uniqueId.description - schemas.Membership.properties.uniqueId.readOnly - schemas.Membership.properties.uniqueId.type - schemas.Membership.properties.updateTime.description - schemas.Membership.properties.updateTime.format - schemas.Membership.properties.updateTime.readOnly - schemas.Membership.properties.updateTime.type - schemas.Membership.type - schemas.MembershipEndpoint.description - schemas.MembershipEndpoint.id - schemas.MembershipEndpoint.properties.applianceCluster.$ref - schemas.MembershipEndpoint.properties.applianceCluster.description - schemas.MembershipEndpoint.properties.edgeCluster.$ref - schemas.MembershipEndpoint.properties.edgeCluster.description - schemas.MembershipEndpoint.properties.gkeCluster.$ref - schemas.MembershipEndpoint.properties.gkeCluster.description - schemas.MembershipEndpoint.properties.googleManaged.description - schemas.MembershipEndpoint.properties.googleManaged.readOnly - schemas.MembershipEndpoint.properties.googleManaged.type - schemas.MembershipEndpoint.properties.kubernetesMetadata.$ref - schemas.MembershipEndpoint.properties.kubernetesMetadata.description - schemas.MembershipEndpoint.properties.kubernetesMetadata.readOnly - schemas.MembershipEndpoint.properties.kubernetesResource.$ref - schemas.MembershipEndpoint.properties.kubernetesResource.description - schemas.MembershipEndpoint.properties.multiCloudCluster.$ref - schemas.MembershipEndpoint.properties.multiCloudCluster.description - schemas.MembershipEndpoint.properties.onPremCluster.$ref - schemas.MembershipEndpoint.properties.onPremCluster.description - schemas.MembershipEndpoint.type - schemas.MembershipState.description - schemas.MembershipState.id - schemas.MembershipState.properties.code.description - schemas.MembershipState.properties.code.enum - schemas.MembershipState.properties.code.enumDescriptions - schemas.MembershipState.properties.code.readOnly - schemas.MembershipState.properties.code.type - schemas.MembershipState.type - schemas.MonitoringConfig.description - schemas.MonitoringConfig.id - schemas.MonitoringConfig.properties.cluster.description - schemas.MonitoringConfig.properties.cluster.type - schemas.MonitoringConfig.properties.clusterHash.description - schemas.MonitoringConfig.properties.clusterHash.type - schemas.MonitoringConfig.properties.kubernetesMetricsPrefix.description - schemas.MonitoringConfig.properties.kubernetesMetricsPrefix.type - schemas.MonitoringConfig.properties.location.description - schemas.MonitoringConfig.properties.location.type - schemas.MonitoringConfig.properties.projectId.description - schemas.MonitoringConfig.properties.projectId.type - schemas.MonitoringConfig.type - schemas.MultiCloudCluster.description - schemas.MultiCloudCluster.id - schemas.MultiCloudCluster.properties.clusterMissing.description - schemas.MultiCloudCluster.properties.clusterMissing.readOnly - schemas.MultiCloudCluster.properties.clusterMissing.type - schemas.MultiCloudCluster.properties.resourceLink.description - schemas.MultiCloudCluster.properties.resourceLink.type - schemas.MultiCloudCluster.type - schemas.OnPremCluster.description - schemas.OnPremCluster.id - schemas.OnPremCluster.properties.adminCluster.description - schemas.OnPremCluster.properties.adminCluster.type - schemas.OnPremCluster.properties.clusterMissing.description - schemas.OnPremCluster.properties.clusterMissing.readOnly - schemas.OnPremCluster.properties.clusterMissing.type - schemas.OnPremCluster.properties.clusterType.description - schemas.OnPremCluster.properties.clusterType.enum - schemas.OnPremCluster.properties.clusterType.enumDescriptions - schemas.OnPremCluster.properties.clusterType.type - schemas.OnPremCluster.properties.resourceLink.description - schemas.OnPremCluster.properties.resourceLink.type - schemas.OnPremCluster.type - schemas.ResourceManifest.description - schemas.ResourceManifest.id - schemas.ResourceManifest.properties.clusterScoped.description - schemas.ResourceManifest.properties.clusterScoped.type - schemas.ResourceManifest.properties.manifest.description - schemas.ResourceManifest.properties.manifest.type - schemas.ResourceManifest.type - schemas.ResourceOptions.description - schemas.ResourceOptions.id - schemas.ResourceOptions.properties.connectVersion.description - schemas.ResourceOptions.properties.connectVersion.type - schemas.ResourceOptions.properties.k8sVersion.description - schemas.ResourceOptions.properties.k8sVersion.type - schemas.ResourceOptions.properties.v1beta1Crd.description - schemas.ResourceOptions.properties.v1beta1Crd.type - schemas.ResourceOptions.type - schemas.TypeMeta.description - schemas.TypeMeta.id - schemas.TypeMeta.properties.apiVersion.description - schemas.TypeMeta.properties.apiVersion.type - schemas.TypeMeta.properties.kind.description - schemas.TypeMeta.properties.kind.type - schemas.TypeMeta.type #### gkehub:v1 The following keys were deleted: - schemas.Scope.properties.allMemberships.description - schemas.Scope.properties.allMemberships.type * feat(gkeonprem)!: update the API BREAKING CHANGE: This release has breaking changes. #### gkeonprem:v1 The following keys were deleted: - schemas.UpgradeDependency.properties.localName.description - schemas.UpgradeDependency.properties.localName.type * feat(gmail)!: update the API BREAKING CHANGE: This release has breaking changes. #### gmail:v1 The following keys were deleted: - schemas.CsePrivateKeyMetadata.properties.hardwareKeyMetadata.$ref - schemas.CsePrivateKeyMetadata.properties.hardwareKeyMetadata.description - schemas.HardwareKeyMetadata.description - schemas.HardwareKeyMetadata.id - schemas.HardwareKeyMetadata.properties.description.description - schemas.HardwareKeyMetadata.properties.description.type - schemas.HardwareKeyMetadata.type The following keys were added: - schemas.CseIdentity.properties.signAndEncryptKeyPairs.$ref - schemas.CseIdentity.properties.signAndEncryptKeyPairs.description - schemas.SignAndEncryptKeyPairs.description - schemas.SignAndEncryptKeyPairs.id - schemas.SignAndEncryptKeyPairs.properties.encryptionKeyPairId.description - schemas.SignAndEncryptKeyPairs.properties.encryptionKeyPairId.type - schemas.SignAndEncryptKeyPairs.properties.signingKeyPairId.description - schemas.SignAndEncryptKeyPairs.properties.signingKeyPairId.type - schemas.SignAndEncryptKeyPairs.type * feat(healthcare): update the API #### healthcare:v1beta1 The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/cloud-healthcare.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.id - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.path - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.scopes - schemas.DicomStoreMetrics.description - schemas.DicomStoreMetrics.id - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.description - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.format - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.type - schemas.DicomStoreMetrics.properties.instanceCount.description - schemas.DicomStoreMetrics.properties.instanceCount.format - schemas.DicomStoreMetrics.properties.instanceCount.type - schemas.DicomStoreMetrics.properties.name.description - schemas.DicomStoreMetrics.properties.name.type - schemas.DicomStoreMetrics.properties.seriesCount.description - schemas.DicomStoreMetrics.properties.seriesCount.format - schemas.DicomStoreMetrics.properties.seriesCount.type - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.description - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.format - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.type - schemas.DicomStoreMetrics.properties.studyCount.description - schemas.DicomStoreMetrics.properties.studyCount.format - schemas.DicomStoreMetrics.properties.studyCount.type - schemas.DicomStoreMetrics.type - schemas.Hl7V2StoreMetric.description - schemas.Hl7V2StoreMetric.id - schemas.Hl7V2StoreMetric.properties.count.description - schemas.Hl7V2StoreMetric.properties.count.format - schemas.Hl7V2StoreMetric.properties.count.type - schemas.Hl7V2StoreMetric.properties.messageType.description - schemas.Hl7V2StoreMetric.properties.messageType.type - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.description - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.format - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.type - schemas.Hl7V2StoreMetric.type - schemas.Hl7V2StoreMetrics.description - schemas.Hl7V2StoreMetrics.id - schemas.Hl7V2StoreMetrics.properties.metrics.description - schemas.Hl7V2StoreMetrics.properties.metrics.items.$ref - schemas.Hl7V2StoreMetrics.properties.metrics.type - schemas.Hl7V2StoreMetrics.properties.name.description - schemas.Hl7V2StoreMetrics.properties.name.type - schemas.Hl7V2StoreMetrics.type - schemas.SeriesMetrics.description - schemas.SeriesMetrics.id - schemas.SeriesMetrics.properties.blobStorageSizeBytes.description - schemas.SeriesMetrics.properties.blobStorageSizeBytes.format - schemas.SeriesMetrics.properties.blobStorageSizeBytes.type - schemas.SeriesMetrics.properties.instanceCount.description - schemas.SeriesMetrics.properties.instanceCount.format - schemas.SeriesMetrics.properties.instanceCount.type - schemas.SeriesMetrics.properties.series.description - schemas.SeriesMetrics.properties.series.type - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.description - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.format - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.type - schemas.SeriesMetrics.type - schemas.StudyMetrics.description - schemas.StudyMetrics.id - schemas.StudyMetrics.properties.blobStorageSizeBytes.description - schemas.StudyMetrics.properties.blobStorageSizeBytes.format - schemas.StudyMetrics.properties.blobStorageSizeBytes.type - schemas.StudyMetrics.properties.instanceCount.description - schemas.StudyMetrics.properties.instanceCount.format - schemas.StudyMetrics.properties.instanceCount.type - schemas.StudyMetrics.properties.seriesCount.description - schemas.StudyMetrics.properties.seriesCount.format - schemas.StudyMetrics.properties.seriesCount.type - schemas.StudyMetrics.properties.structuredStorageSizeBytes.description - schemas.StudyMetrics.properties.structuredStorageSizeBytes.format - schemas.StudyMetrics.properties.structuredStorageSizeBytes.type - schemas.StudyMetrics.properties.study.description - schemas.StudyMetrics.properties.study.type - schemas.StudyMetrics.type The following keys were changed: - resources.projects.resources.locations.methods.get.scopes - resources.projects.resources.locations.methods.list.scopes - resources.projects.resources.locations.resources.datasets.methods.create.scopes - resources.projects.resources.locations.resources.datasets.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.methods.get.scopes - resources.projects.resources.locations.resources.datasets.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.methods.list.scopes - resources.projects.resources.locations.resources.datasets.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.evaluate.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.annotationStores.resources.annotations.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.checkDataAccess.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.evaluateUserConsents.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.queryAccessibleData.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.activate.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.deleteRevision.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.listRevisions.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.reject.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.revoke.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.archive.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForStudies.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.storeInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.retrieveStudy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.searchForSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.storeInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.retrieveSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveInstance.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveFrames.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.applyAdminConsents.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.applyConsents.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.configureSearch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.getFHIRStoreMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.ConceptMap-search-translate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.ConceptMap-translate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Consent-enforcement-status.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Observation-lastn.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Patient-consent-enforcement-status.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Patient-everything.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-incoming-references.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-purge.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-validate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.capabilities.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalDelete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalPatch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalUpdate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.executeBundle.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.history.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.read.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.search.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.search-type.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.update.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.vread.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.batchGet.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.ingest.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.services.resources.nlp.methods.analyzeEntities.scopes - schemas.CleanTextTag.description - schemas.DeidentifyConfig.properties.useRegionalDataProcessing.description - schemas.FhirFieldConfig.properties.profileType.enumDescriptions - schemas.FhirOutput.properties.fhirStore.description #### healthcare:v1 The following keys were added: - auth.oauth2.scopes.https://www.googleapis.com/auth/cloud-healthcare.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getDICOMStoreMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.parameters.study.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.methods.getStudyMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.id - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.description - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.location - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.pattern - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.required - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.parameters.series.type - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.path - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.dicomWeb.resources.studies.resources.series.methods.getSeriesMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.flatPath - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.httpMethod - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.id - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameterOrder - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.description - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.location - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.pattern - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.required - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.parameters.name.type - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.path - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.response.$ref - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getHL7v2StoreMetrics.scopes - schemas.DicomStoreMetrics.description - schemas.DicomStoreMetrics.id - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.description - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.format - schemas.DicomStoreMetrics.properties.blobStorageSizeBytes.type - schemas.DicomStoreMetrics.properties.instanceCount.description - schemas.DicomStoreMetrics.properties.instanceCount.format - schemas.DicomStoreMetrics.properties.instanceCount.type - schemas.DicomStoreMetrics.properties.name.description - schemas.DicomStoreMetrics.properties.name.type - schemas.DicomStoreMetrics.properties.seriesCount.description - schemas.DicomStoreMetrics.properties.seriesCount.format - schemas.DicomStoreMetrics.properties.seriesCount.type - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.description - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.format - schemas.DicomStoreMetrics.properties.structuredStorageSizeBytes.type - schemas.DicomStoreMetrics.properties.studyCount.description - schemas.DicomStoreMetrics.properties.studyCount.format - schemas.DicomStoreMetrics.properties.studyCount.type - schemas.DicomStoreMetrics.type - schemas.Hl7V2StoreMetric.description - schemas.Hl7V2StoreMetric.id - schemas.Hl7V2StoreMetric.properties.count.description - schemas.Hl7V2StoreMetric.properties.count.format - schemas.Hl7V2StoreMetric.properties.count.type - schemas.Hl7V2StoreMetric.properties.messageType.description - schemas.Hl7V2StoreMetric.properties.messageType.type - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.description - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.format - schemas.Hl7V2StoreMetric.properties.structuredStorageSizeBytes.type - schemas.Hl7V2StoreMetric.type - schemas.Hl7V2StoreMetrics.description - schemas.Hl7V2StoreMetrics.id - schemas.Hl7V2StoreMetrics.properties.metrics.description - schemas.Hl7V2StoreMetrics.properties.metrics.items.$ref - schemas.Hl7V2StoreMetrics.properties.metrics.type - schemas.Hl7V2StoreMetrics.properties.name.description - schemas.Hl7V2StoreMetrics.properties.name.type - schemas.Hl7V2StoreMetrics.type - schemas.SeriesMetrics.description - schemas.SeriesMetrics.id - schemas.SeriesMetrics.properties.blobStorageSizeBytes.description - schemas.SeriesMetrics.properties.blobStorageSizeBytes.format - schemas.SeriesMetrics.properties.blobStorageSizeBytes.type - schemas.SeriesMetrics.properties.instanceCount.description - schemas.SeriesMetrics.properties.instanceCount.format - schemas.SeriesMetrics.properties.instanceCount.type - schemas.SeriesMetrics.properties.series.description - schemas.SeriesMetrics.properties.series.type - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.description - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.format - schemas.SeriesMetrics.properties.structuredStorageSizeBytes.type - schemas.SeriesMetrics.type - schemas.StudyMetrics.description - schemas.StudyMetrics.id - schemas.StudyMetrics.properties.blobStorageSizeBytes.description - schemas.StudyMetrics.properties.blobStorageSizeBytes.format - schemas.StudyMetrics.properties.blobStorageSizeBytes.type - schemas.StudyMetrics.properties.instanceCount.description - schemas.StudyMetrics.properties.instanceCount.format - schemas.StudyMetrics.properties.instanceCount.type - schemas.StudyMetrics.properties.seriesCount.description - schemas.StudyMetrics.properties.seriesCount.format - schemas.StudyMetrics.properties.seriesCount.type - schemas.StudyMetrics.properties.structuredStorageSizeBytes.description - schemas.StudyMetrics.properties.structuredStorageSizeBytes.format - schemas.StudyMetrics.properties.structuredStorageSizeBytes.type - schemas.StudyMetrics.properties.study.description - schemas.StudyMetrics.properties.study.type - schemas.StudyMetrics.type The following keys were changed: - resources.projects.resources.locations.methods.get.scopes - resources.projects.resources.locations.methods.list.scopes - resources.projects.resources.locations.resources.datasets.methods.create.scopes - resources.projects.resources.locations.resources.datasets.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.methods.get.scopes - resources.projects.resources.locations.resources.datasets.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.methods.list.scopes - resources.projects.resources.locations.resources.datasets.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.checkDataAccess.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.evaluateUserConsents.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.queryAccessibleData.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.attributeDefinitions.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consentArtifacts.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.activate.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.deleteRevision.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.listRevisions.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.reject.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.consents.methods.revoke.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.archive.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.consentStores.resources.userDataMappings.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.searchForStudies.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.storeInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.retrieveStudy.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.searchForSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.methods.storeInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.retrieveSeries.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.methods.searchForInstances.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveInstance.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveMetadata.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.methods.retrieveRendered.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveFrames.scopes - resources.projects.resources.locations.resources.datasets.resources.dicomStores.resources.studies.resources.series.resources.instances.resources.frames.methods.retrieveRendered.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.deidentify.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.getFHIRStoreMetrics.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Patient-everything.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-purge.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.Resource-validate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.capabilities.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalDelete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalPatch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.conditionalUpdate.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.executeBundle.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.history.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.read.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.search.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.search-type.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.update.scopes - resources.projects.resources.locations.resources.datasets.resources.fhirStores.resources.fhir.methods.vread.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.export.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.getIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.import.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.setIamPolicy.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.methods.testIamPermissions.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.create.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.delete.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.ingest.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.list.scopes - resources.projects.resources.locations.resources.datasets.resources.hl7V2Stores.resources.messages.methods.patch.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.cancel.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.get.scopes - resources.projects.resources.locations.resources.datasets.resources.operations.methods.list.scopes - resources.projects.resources.locations.resources.services.resources.nlp.methods.analyzeEntities.scopes - schemas.DeidentifyConfig.properties.useRegionalDataProcessing.description * feat(iap): update the API #### iap:v1 The following keys were added: - schemas.Resource.properties.expectedNextState.additionalProperties.description - schemas.Resource.properties.expectedNextState.additionalProperties.type - schemas.Resource.properties.expectedNextState.description - schemas.Resource.properties.expectedNextState.type * fix(indexing): update the API #### indexing:v3 The following keys were changed: - description - title * feat(metastore): update the API #### metastore:v1alpha The following keys were added: - schemas.LocationMetadata.properties.multiRegionMetadata.$ref - schemas.LocationMetadata.properties.multiRegionMetadata.description - schemas.MultiRegionMetadata.description - schemas.MultiRegionMetadata.id - schemas.MultiRegionMetadata.properties.constituentRegions.description - schemas.MultiRegionMetadata.properties.constituentRegions.items.type - schemas.MultiRegionMetadata.properties.constituentRegions.type - schemas.MultiRegionMetadata.type #### metastore:v1beta The following keys were added: - schemas.LocationMetadata.properties.multiRegionMetadata.$ref - schemas.LocationMetadata.properties.multiRegionMetadata.description - schemas.MultiRegionMetadata.description - schemas.MultiRegionMetadata.id - schemas.MultiRegionMetadata.properties.constituentRegions.description - schemas.MultiRegionMetadata.properties.constituentRegions.items.type - schemas.MultiRegionMetadata.properties.constituentRegions.type - schemas.MultiRegionMetadata.type #### metastore:v1 The following keys were added: - schemas.LocationMetadata.properties.multiRegionMetadata.$ref - schemas.LocationMetadata.properties.multiRegionMetadata.description - schemas.MultiRegionMetadata.description - schemas.MultiRegionMetadata.id - schemas.MultiRegionMetadata.properties.constituentRegions.description - schemas.MultiRegionMetadata.properties.constituentRegions.items.type - schemas.MultiRegionMetadata.properties.constituentRegions.type - schemas.MultiRegionMetadata.type * feat(migrationcenter): update the API #### migrationcenter:v1alpha1 The following keys were added: - schemas.VirtualMachinePreferences.properties.networkCostParameters.$ref - schemas.VirtualMachinePreferences.properties.networkCostParameters.description - schemas.VirtualMachinePreferences.properties.sizingOptimizationCustomParameters.$ref - schemas.VirtualMachinePreferences.properties.sizingOptimizationCustomParameters.description - schemas.VirtualMachinePreferencesNetworkCostParameters.description - schemas.VirtualMachinePreferencesNetworkCostParameters.id - schemas.VirtualMachinePreferencesNetworkCostParameters.properties.estimatedEgressTrafficPercentage.description - schemas.VirtualMachinePreferencesNetworkCostParameters.properties.estimatedEgressTrafficPercentage.format - schemas.VirtualMachinePreferencesNetworkCostParameters.properties.estimatedEgressTrafficPercentage.type - schemas.VirtualMachinePreferencesNetworkCostParameters.type - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.description - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.id - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.aggregationMethod.description - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.aggregationMethod.enum - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.aggregationMethod.enumDescriptions - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.aggregationMethod.type - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.cpuUsagePercentage.description - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.cpuUsagePercentage.format - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.cpuUsagePercentage.type - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.memoryUsagePercentage.description - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.memoryUsagePercentage.format - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.memoryUsagePercentage.type - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.storageMultiplier.description - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.storageMultiplier.format - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.properties.storageMultiplier.type - schemas.VirtualMachinePreferencesSizingOptimizationCustomParameters.type The following keys were changed: - schemas.GenericInsight.description - schemas.GenericInsight.properties.additionalInformation.description - schemas.ImportDataFile.properties.displayName.description - schemas.VirtualMachinePreferences.description - schemas.VirtualMachinePreferences.properties.sizingOptimizationStrategy.enum - schemas.VirtualMachinePreferences.properties.sizingOptimizationStrategy.enumDescriptions #### migrationcenter:v1 The following keys were changed: - schemas.GenericInsight.description - schemas.GenericInsight.properties.additionalInformation.description - schemas.ImportJob.properties.displayName.description - schemas.PerformanceSample.properties.sampleTime.description * fix(networkconnectivity): update the API #### networkconnectivity:v1 The following keys were changed: - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpoke.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.acceptSpoke.parameters.name.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpoke.description - resources.projects.resources.locations.resources.global.resources.hubs.methods.rejectSpoke.parameters.name.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.create.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.create.parameters.policyBasedRouteId.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.delete.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.get.description - resources.projects.resources.locations.resources.global.resources.policyBasedRoutes.methods.list.description - resources.projects.resources.locations.resources.spokes.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.spokes.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.spokes.methods.patch.parameters.requestId.description - schemas.AcceptHubSpokeRequest.properties.requestId.description - schemas.AcceptSpokeRequest.properties.requestId.description - schemas.Filter.properties.destRange.description - schemas.Filter.properties.ipProtocol.description - schemas.Filter.properties.protocolVersion.description - schemas.Filter.properties.srcRange.description - schemas.InterconnectAttachment.description - schemas.InterconnectAttachment.properties.region.description - schemas.ListPolicyBasedRoutesResponse.properties.policyBasedRoutes.description - schemas.PolicyBasedRoute.description - schemas.PolicyBasedRoute.properties.createTime.description - schemas.PolicyBasedRoute.properties.interconnectAttachment.description - schemas.PolicyBasedRoute.properties.kind.description - schemas.PolicyBasedRoute.properties.network.description - schemas.PolicyBasedRoute.properties.nextHopIlbIp.description - schemas.PolicyBasedRoute.properties.priority.description - schemas.PolicyBasedRoute.properties.updateTime.description - schemas.PolicyBasedRoute.properties.virtualMachine.description - schemas.RejectHubSpokeRequest.properties.requestId.description - schemas.RejectSpokeRequest.properties.requestId.description - schemas.VirtualMachine.description - schemas.VirtualMachine.properties.tags.description - schemas.Warnings.properties.code.enumDescriptions * feat(networksecurity): update the API #### networksecurity:v1beta1 The following keys were added: - schemas.FirewallEndpoint.properties.description.description - schemas.FirewallEndpoint.properties.description.type The following keys were changed: - resources.organizations.resources.locations.resources.securityProfileGroups.methods.patch.parameters.name.description - resources.organizations.resources.locations.resources.securityProfiles.methods.patch.parameters.name.description - schemas.SecurityProfile.properties.name.description - schemas.SecurityProfileGroup.properties.name.description * feat(networkservices): update the API #### networkservices:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.flatPath - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.httpMethod - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.id - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameterOrder - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.lbRouteExtensionId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.lbRouteExtensionId.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.lbRouteExtensionId.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.path - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.request.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.response.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.create.scopes - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.flatPath - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.httpMethod - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.id - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.path - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.response.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.delete.scopes - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.flatPath - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.httpMethod - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.id - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameterOrder - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.path - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.response.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.get.scopes - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.flatPath - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.httpMethod - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.id - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameterOrder - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.path - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.response.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.list.scopes - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.flatPath - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.httpMethod - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.id - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameterOrder - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.path - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.request.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.response.$ref - resources.projects.resources.locations.resources.lbRouteExtensions.methods.patch.scopes - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.flatPath - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.httpMethod - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.id - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameterOrder - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.lbTrafficExtensionId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.lbTrafficExtensionId.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.lbTrafficExtensionId.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.path - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.request.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.response.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.create.scopes - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.flatPath - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.httpMethod - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.id - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameterOrder - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.path - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.response.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.delete.scopes - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.flatPath - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.httpMethod - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.id - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameterOrder - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameters.name.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameters.name.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameters.name.required - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.parameters.name.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.path - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.response.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.get.scopes - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.flatPath - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.httpMethod - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.id - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameterOrder - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.filter.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.filter.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.filter.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.orderBy.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.orderBy.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.orderBy.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.path - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.response.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.list.scopes - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.flatPath - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.httpMethod - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.id - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameterOrder - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.path - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.request.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.response.$ref - resources.projects.resources.locations.resources.lbTrafficExtensions.methods.patch.scopes - schemas.ExtensionChain.description - schemas.ExtensionChain.id - schemas.ExtensionChain.properties.extensions.description - schemas.ExtensionChain.properties.extensions.items.$ref - schemas.ExtensionChain.properties.extensions.type - schemas.ExtensionChain.properties.matchCondition.$ref - schemas.ExtensionChain.properties.matchCondition.description - schemas.ExtensionChain.properties.name.description - schemas.ExtensionChain.properties.name.type - schemas.ExtensionChain.type - schemas.ExtensionChainExtension.description - schemas.ExtensionChainExtension.id - schemas.ExtensionChainExtension.properties.authority.description - schemas.ExtensionChainExtension.properties.authority.type - schemas.ExtensionChainExtension.properties.failOpen.description - schemas.ExtensionChainExtension.properties.failOpen.type - schemas.ExtensionChainExtension.properties.forwardHeaders.description - schemas.ExtensionChainExtension.properties.forwardHeaders.items.type - schemas.ExtensionChainExtension.properties.forwardHeaders.type - schemas.ExtensionChainExtension.properties.name.description - schemas.ExtensionChainExtension.properties.name.type - schemas.ExtensionChainExtension.properties.service.description - schemas.ExtensionChainExtension.properties.service.type - schemas.ExtensionChainExtension.properties.supportedEvents.description - schemas.ExtensionChainExtension.properties.supportedEvents.items.enum - schemas.ExtensionChainExtension.properties.supportedEvents.items.enumDescriptions - schemas.ExtensionChainExtension.properties.supportedEvents.items.type - schemas.ExtensionChainExtension.properties.supportedEvents.type - schemas.ExtensionChainExtension.properties.timeout.description - schemas.ExtensionChainExtension.properties.timeout.format - schemas.ExtensionChainExtension.properties.timeout.type - schemas.ExtensionChainExtension.type - schemas.ExtensionChainMatchCondition.description - schemas.ExtensionChainMatchCondition.id - schemas.ExtensionChainMatchCondition.properties.celExpression.description - schemas.ExtensionChainMatchCondition.properties.celExpression.type - schemas.ExtensionChainMatchCondition.type - schemas.GrpcRouteRouteAction.properties.statefulSessionAffinity.$ref - schemas.GrpcRouteRouteAction.properties.statefulSessionAffinity.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.id - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.format - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.type - schemas.GrpcRouteStatefulSessionAffinityPolicy.type - schemas.HttpRouteRouteAction.properties.statefulSessionAffinity.$ref - schemas.HttpRouteRouteAction.properties.statefulSessionAffinity.description - schemas.HttpRouteStatefulSessionAffinityPolicy.description - schemas.HttpRouteStatefulSessionAffinityPolicy.id - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.description - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.format - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.type - schemas.HttpRouteStatefulSessionAffinityPolicy.type - schemas.LbRouteExtension.description - schemas.LbRouteExtension.id - schemas.LbRouteExtension.properties.createTime.description - schemas.LbRouteExtension.properties.createTime.format - schemas.LbRouteExtension.properties.createTime.readOnly - schemas.LbRouteExtension.properties.createTime.type - schemas.LbRouteExtension.properties.description.description - schemas.LbRouteExtension.properties.description.type - schemas.LbRouteExtension.properties.extensionChains.description - schemas.LbRouteExtension.properties.extensionChains.items.$ref - schemas.LbRouteExtension.properties.extensionChains.type - schemas.LbRouteExtension.properties.forwardingRules.description - schemas.LbRouteExtension.properties.forwardingRules.items.type - schemas.LbRouteExtension.properties.forwardingRules.type - schemas.LbRouteExtension.properties.labels.additionalProperties.type - schemas.LbRouteExtension.properties.labels.description - schemas.LbRouteExtension.properties.labels.type - schemas.LbRouteExtension.properties.loadBalancingScheme.description - schemas.LbRouteExtension.properties.loadBalancingScheme.enum - schemas.LbRouteExtension.properties.loadBalancingScheme.enumDescriptions - schemas.LbRouteExtension.properties.loadBalancingScheme.type - schemas.LbRouteExtension.properties.name.description - schemas.LbRouteExtension.properties.name.type - schemas.LbRouteExtension.properties.updateTime.description - schemas.LbRouteExtension.properties.updateTime.format - schemas.LbRouteExtension.properties.updateTime.readOnly - schemas.LbRouteExtension.properties.updateTime.type - schemas.LbRouteExtension.type - schemas.LbTrafficExtension.description - schemas.LbTrafficExtension.id - schemas.LbTrafficExtension.properties.createTime.description - schemas.LbTrafficExtension.properties.createTime.format - schemas.LbTrafficExtension.properties.createTime.readOnly - schemas.LbTrafficExtension.properties.createTime.type - schemas.LbTrafficExtension.properties.description.description - schemas.LbTrafficExtension.properties.description.type - schemas.LbTrafficExtension.properties.extensionChains.description - schemas.LbTrafficExtension.properties.extensionChains.items.$ref - schemas.LbTrafficExtension.properties.extensionChains.type - schemas.LbTrafficExtension.properties.forwardingRules.description - schemas.LbTrafficExtension.properties.forwardingRules.items.type - schemas.LbTrafficExtension.properties.forwardingRules.type - schemas.LbTrafficExtension.properties.labels.additionalProperties.type - schemas.LbTrafficExtension.properties.labels.description - schemas.LbTrafficExtension.properties.labels.type - schemas.LbTrafficExtension.properties.loadBalancingScheme.description - schemas.LbTrafficExtension.properties.loadBalancingScheme.enum - schemas.LbTrafficExtension.properties.loadBalancingScheme.enumDescriptions - schemas.LbTrafficExtension.properties.loadBalancingScheme.type - schemas.LbTrafficExtension.properties.name.description - schemas.LbTrafficExtension.properties.name.type - schemas.LbTrafficExtension.properties.updateTime.description - schemas.LbTrafficExtension.properties.updateTime.format - schemas.LbTrafficExtension.properties.updateTime.readOnly - schemas.LbTrafficExtension.properties.updateTime.type - schemas.LbTrafficExtension.type - schemas.ListLbRouteExtensionsResponse.description - schemas.ListLbRouteExtensionsResponse.id - schemas.ListLbRouteExtensionsResponse.properties.lbRouteExtensions.description - schemas.ListLbRouteExtensionsResponse.properties.lbRouteExtensions.items.$ref - schemas.ListLbRouteExtensionsResponse.properties.lbRouteExtensions.type - schemas.ListLbRouteExtensionsResponse.properties.nextPageToken.description - schemas.ListLbRouteExtensionsResponse.properties.nextPageToken.type - schemas.ListLbRouteExtensionsResponse.properties.unreachable.description - schemas.ListLbRouteExtensionsResponse.properties.unreachable.items.type - schemas.ListLbRouteExtensionsResponse.properties.unreachable.type - schemas.ListLbRouteExtensionsResponse.type - schemas.ListLbTrafficExtensionsResponse.description - schemas.ListLbTrafficExtensionsResponse.id - schemas.ListLbTrafficExtensionsResponse.properties.lbTrafficExtensions.description - schemas.ListLbTrafficExtensionsResponse.properties.lbTrafficExtensions.items.$ref - schemas.ListLbTrafficExtensionsResponse.properties.lbTrafficExtensions.type - schemas.ListLbTrafficExtensionsResponse.properties.nextPageToken.description - schemas.ListLbTrafficExtensionsResponse.properties.nextPageToken.type - schemas.ListLbTrafficExtensionsResponse.properties.unreachable.description - schemas.ListLbTrafficExtensionsResponse.properties.unreachable.items.type - schemas.ListLbTrafficExtensionsResponse.properties.unreachable.type - schemas.ListLbTrafficExtensionsResponse.type #### networkservices:v1 The following keys were added: - schemas.GrpcRouteRouteAction.properties.statefulSessionAffinity.$ref - schemas.GrpcRouteRouteAction.properties.statefulSessionAffinity.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.id - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.description - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.format - schemas.GrpcRouteStatefulSessionAffinityPolicy.properties.cookieTtl.type - schemas.GrpcRouteStatefulSessionAffinityPolicy.type - schemas.HttpRouteRouteAction.properties.statefulSessionAffinity.$ref - schemas.HttpRouteRouteAction.properties.statefulSessionAffinity.description - schemas.HttpRouteStatefulSessionAffinityPolicy.description - schemas.HttpRouteStatefulSessionAffinityPolicy.id - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.description - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.format - schemas.HttpRouteStatefulSessionAffinityPolicy.properties.cookieTtl.type - schemas.HttpRouteStatefulSessionAffinityPolicy.type * feat(notebooks): update the API #### notebooks:v1 The following keys were added: - resources.projects.resources.locations.resources.instances.methods.migrate.description - resources.projects.resources.locations.resources.instances.methods.migrate.flatPath - resources.projects.resources.locations.resources.instances.methods.migrate.httpMethod - resources.projects.resources.locations.resources.instances.methods.migrate.id - resources.projects.resources.locations.resources.instances.methods.migrate.parameterOrder - resources.projects.resources.locations.resources.instances.methods.migrate.parameters.name.description - resources.projects.resources.locations.resources.instances.methods.migrate.parameters.name.location - resources.projects.resources.locations.resources.instances.methods.migrate.parameters.name.pattern - resources.projects.resources.locations.resources.instances.methods.migrate.parameters.name.required - resources.projects.resources.locations.resources.instances.methods.migrate.parameters.name.type - resources.projects.resources.locations.resources.instances.methods.migrate.path - resources.projects.resources.locations.resources.instances.methods.migrate.request.$ref - resources.projects.resources.locations.resources.instances.methods.migrate.response.$ref - resources.projects.resources.locations.resources.instances.methods.migrate.scopes - resources.projects.resources.locations.resources.runtimes.methods.migrate.description - resources.projects.resources.locations.resources.runtimes.methods.migrate.flatPath - resources.projects.resources.locations.resources.runtimes.methods.migrate.httpMethod - resources.projects.resources.locations.resources.runtimes.methods.migrate.id - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameterOrder - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameters.name.description - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameters.name.location - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameters.name.pattern - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameters.name.required - resources.projects.resources.locations.resources.runtimes.methods.migrate.parameters.name.type - resources.projects.resources.locations.resources.runtimes.methods.migrate.path - resources.projects.resources.locations.resources.runtimes.methods.migrate.request.$ref - resources.projects.resources.locations.resources.runtimes.methods.migrate.response.$ref - resources.projects.resources.locations.resources.runtimes.methods.migrate.scopes - schemas.MigrateInstanceRequest.description - schemas.MigrateInstanceRequest.id - schemas.MigrateInstanceRequest.properties.postStartupScriptOption.description - schemas.MigrateInstanceRequest.properties.postStartupScriptOption.enum - schemas.MigrateInstanceRequest.properties.postStartupScriptOption.enumDescriptions - schemas.MigrateInstanceRequest.properties.postStartupScriptOption.type - schemas.MigrateInstanceRequest.type - schemas.MigrateRuntimeRequest.description - schemas.MigrateRuntimeRequest.id - schemas.MigrateRuntimeRequest.properties.network.description - schemas.MigrateRuntimeRequest.properties.network.type - schemas.MigrateRuntimeRequest.properties.postStartupScriptOption.description - schemas.MigrateRuntimeRequest.properties.postStartupScriptOption.enum - schemas.MigrateRuntimeRequest.properties.postStartupScriptOption.enumDescriptions - schemas.MigrateRuntimeRequest.properties.postStartupScriptOption.type - schemas.MigrateRuntimeRequest.properties.requestId.description - schemas.MigrateRuntimeRequest.properties.requestId.type - schemas.MigrateRuntimeRequest.properties.serviceAccount.description - schemas.MigrateRuntimeRequest.properties.serviceAccount.type - schemas.MigrateRuntimeRequest.properties.subnet.description - schemas.MigrateRuntimeRequest.properties.subnet.type - schemas.MigrateRuntimeRequest.type The following keys were changed: - schemas.InstanceMigrationEligibility.properties.warnings.items.enumDescriptions * feat(ondemandscanning): update the API #### ondemandscanning:v1beta1 The following keys were added: - schemas.VulnerabilityOccurrence.properties.extraDetails.description - schemas.VulnerabilityOccurrence.properties.extraDetails.type #### ondemandscanning:v1 The following keys were added: - schemas.VulnerabilityOccurrence.properties.extraDetails.description - schemas.VulnerabilityOccurrence.properties.extraDetails.type * feat(oslogin): update the API #### oslogin:v1alpha The following keys were added: - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.description - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.id - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.path - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.scopes #### oslogin:v1beta The following keys were added: - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.description - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.id - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.path - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.users.resources.projects.resources.locations.methods.signSshPublicKey.scopes * feat(places)!: update the API BREAKING CHANGE: This release has breaking changes. #### places:v1 The following keys were deleted: - schemas.GoogleMapsPlacesV1Place.properties.openingHours.$ref - schemas.GoogleMapsPlacesV1Place.properties.openingHours.description - schemas.GoogleMapsPlacesV1Place.properties.openingHours.readOnly - schemas.GoogleMapsPlacesV1Place.properties.secondaryOpeningHours.description - schemas.GoogleMapsPlacesV1Place.properties.secondaryOpeningHours.items.$ref - schemas.GoogleMapsPlacesV1Place.properties.secondaryOpeningHours.readOnly - schemas.GoogleMapsPlacesV1Place.properties.secondaryOpeningHours.type - schemas.GoogleMapsPlacesV1Place.properties.wheelchairAccessibleEntrance.deprecated - schemas.GoogleMapsPlacesV1Place.properties.wheelchairAccessibleEntrance.description - schemas.GoogleMapsPlacesV1Place.properties.wheelchairAccessibleEntrance.readOnly - schemas.GoogleMapsPlacesV1Place.properties.wheelchairAccessibleEntrance.type The following keys were added: - schemas.GoogleMapsPlacesV1Place.properties.accessibilityOptions.$ref - schemas.GoogleMapsPlacesV1Place.properties.accessibilityOptions.description - schemas.GoogleMapsPlacesV1Place.properties.accessibilityOptions.readOnly - schemas.GoogleMapsPlacesV1Place.properties.regularOpeningHours.$ref - schemas.GoogleMapsPlacesV1Place.properties.regularOpeningHours.description - schemas.GoogleMapsPlacesV1Place.properties.regularOpeningHours.readOnly - schemas.GoogleMapsPlacesV1Place.properties.regularSecondaryOpeningHours.description - schemas.GoogleMapsPlacesV1Place.properties.regularSecondaryOpeningHours.items.$ref - schemas.GoogleMapsPlacesV1Place.properties.regularSecondaryOpeningHours.readOnly - schemas.GoogleMapsPlacesV1Place.properties.regularSecondaryOpeningHours.type - schemas.GoogleMapsPlacesV1PlaceAccessibilityOptions.description - schemas.GoogleMapsPlacesV1PlaceAccessibilityOptions.id - schemas.GoogleMapsPlacesV1PlaceAccessibilityOptions.properties.wheelchairAccessibleEntrance.description - schemas.GoogleMapsPlacesV1PlaceAccessibilityOptions.properties.wheelchairAccessibleEntrance.type - schemas.GoogleMapsPlacesV1PlaceAccessibilityOptions.type * fix(playintegrity): update the API #### playintegrity:v1 The following keys were changed: - schemas.AccountActivity.description - schemas.AccountActivity.properties.activityLevel.enumDescriptions - schemas.AccountDetails.properties.accountActivity.description - schemas.DeviceIntegrity.properties.deviceRecognitionVerdict.items.enumDescriptions - schemas.UserRemediationDetails.description - schemas.UserRemediationDetails.properties.remediation.enumDescriptions * feat(redis): update the API #### redis:v1 The following keys were added: - resources.projects.resources.locations.resources.clusters.methods.create.description - resources.projects.resources.locations.resources.clusters.methods.create.flatPath - resources.projects.resources.locations.resources.clusters.methods.create.httpMethod - resources.projects.resources.locations.resources.clusters.methods.create.id - resources.projects.resources.locations.resources.clusters.methods.create.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.create.parameters.clusterId.description - resources.projects.resources.locations.resources.clusters.methods.create.parameters.clusterId.location - resources.projects.resources.locations.resources.clusters.methods.create.parameters.clusterId.type - resources.projects.resources.locations.resources.clusters.methods.create.parameters.parent.description - resources.projects.resources.locations.resources.clusters.methods.create.parameters.parent.location - resources.projects.resources.locations.resources.clusters.methods.create.parameters.parent.pattern - resources.projects.resources.locations.resources.clusters.methods.create.parameters.parent.required - resources.projects.resources.locations.resources.clusters.methods.create.parameters.parent.type - resources.projects.resources.locations.resources.clusters.methods.create.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.create.parameters.requestId.location - resources.projects.resources.locations.resources.clusters.methods.create.parameters.requestId.type - resources.projects.resources.locations.resources.clusters.methods.create.path - resources.projects.resources.locations.resources.clusters.methods.create.request.$ref - resources.projects.resources.locations.resources.clusters.methods.create.response.$ref - resources.projects.resources.locations.resources.clusters.methods.create.scopes - resources.projects.resources.locations.resources.clusters.methods.delete.description - resources.projects.resources.locations.resources.clusters.methods.delete.flatPath - resources.projects.resources.locations.resources.clusters.methods.delete.httpMethod - resources.projects.resources.locations.resources.clusters.methods.delete.id - resources.projects.resources.locations.resources.clusters.methods.delete.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.requestId.location - resources.projects.resources.locations.resources.clusters.methods.delete.parameters.requestId.type - resources.projects.resources.locations.resources.clusters.methods.delete.path - resources.projects.resources.locations.resources.clusters.methods.delete.response.$ref - resources.projects.resources.locations.resources.clusters.methods.delete.scopes - resources.projects.resources.locations.resources.clusters.methods.get.description - resources.projects.resources.locations.resources.clusters.methods.get.flatPath - resources.projects.resources.locations.resources.clusters.methods.get.httpMethod - resources.projects.resources.locations.resources.clusters.methods.get.id - resources.projects.resources.locations.resources.clusters.methods.get.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.get.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.get.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.get.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.get.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.get.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.get.path - resources.projects.resources.locations.resources.clusters.methods.get.response.$ref - resources.projects.resources.locations.resources.clusters.methods.get.scopes - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.description - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.flatPath - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.httpMethod - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.id - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.path - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.response.$ref - resources.projects.resources.locations.resources.clusters.methods.getCertificateAuthority.scopes - resources.projects.resources.locations.resources.clusters.methods.list.description - resources.projects.resources.locations.resources.clusters.methods.list.flatPath - resources.projects.resources.locations.resources.clusters.methods.list.httpMethod - resources.projects.resources.locations.resources.clusters.methods.list.id - resources.projects.resources.locations.resources.clusters.methods.list.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageSize.description - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageSize.format - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageSize.location - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageSize.type - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageToken.description - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageToken.location - resources.projects.resources.locations.resources.clusters.methods.list.parameters.pageToken.type - resources.projects.resources.locations.resources.clusters.methods.list.parameters.parent.description - resources.projects.resources.locations.resources.clusters.methods.list.parameters.parent.location - resources.projects.resources.locations.resources.clusters.methods.list.parameters.parent.pattern - resources.projects.resources.locations.resources.clusters.methods.list.parameters.parent.required - resources.projects.resources.locations.resources.clusters.methods.list.parameters.parent.type - resources.projects.resources.locations.resources.clusters.methods.list.path - resources.projects.resources.locations.resources.clusters.methods.list.response.$ref - resources.projects.resources.locations.resources.clusters.methods.list.scopes - resources.projects.resources.locations.resources.clusters.methods.patch.description - resources.projects.resources.locations.resources.clusters.methods.patch.flatPath - resources.projects.resources.locations.resources.clusters.methods.patch.httpMethod - resources.projects.resources.locations.resources.clusters.methods.patch.id - resources.projects.resources.locations.resources.clusters.methods.patch.parameterOrder - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.name.description - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.name.location - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.name.pattern - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.name.required - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.name.type - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.requestId.description - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.requestId.location - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.requestId.type - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.updateMask.description - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.updateMask.format - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.updateMask.location - resources.projects.resources.locations.resources.clusters.methods.patch.parameters.updateMask.type - resources.projects.resources.locations.resources.clusters.methods.patch.path - resources.projects.resources.locations.resources.clusters.methods.patch.request.$ref - resources.projects.resources.locations.resources.clusters.methods.patch.response.$ref - resources.projects.resources.locations.resources.clusters.methods.patch.scopes - schemas.CertChain.id - schemas.CertChain.properties.certificates.description - schemas.CertChain.properties.certificates.items.type - schemas.CertChain.properties.certificates.type - schemas.CertChain.type - schemas.CertificateAuthority.description - schemas.CertificateAuthority.id - schemas.CertificateAuthority.properties.managedServerCa.$ref - schemas.CertificateAuthority.type - schemas.Cluster.description - schemas.Cluster.id - schemas.Cluster.properties.authorizationMode.description - schemas.Cluster.properties.authorizationMode.enum - schemas.Cluster.properties.authorizationMode.enumDescriptions - schemas.Cluster.properties.authorizationMode.type - schemas.Cluster.properties.createTime.description - schemas.Cluster.properties.createTime.format - schemas.Cluster.properties.createTime.readOnly - schemas.Cluster.properties.createTime.type - schemas.Cluster.properties.discoveryEndpoints.description - schemas.Cluster.properties.discoveryEndpoints.items.$ref - schemas.Cluster.properties.discoveryEndpoints.readOnly - schemas.Cluster.properties.discoveryEndpoints.type - schemas.Cluster.properties.name.description - schemas.Cluster.properties.name.type - schemas.Cluster.properties.pscConfigs.description - schemas.Cluster.properties.pscConfigs.items.$ref - schemas.Cluster.properties.pscConfigs.type - schemas.Cluster.properties.pscConnections.description - schemas.Cluster.properties.pscConnections.items.$ref - schemas.Cluster.properties.pscConnections.readOnly - schemas.Cluster.properties.pscConnections.type - schemas.Cluster.properties.replicaCount.description - schemas.Cluster.properties.replicaCount.format - schemas.Cluster.properties.replicaCount.type - schemas.Cluster.properties.shardCount.description - schemas.Cluster.properties.shardCount.format - schemas.Cluster.properties.shardCount.type - schemas.Cluster.properties.sizeGb.description - schemas.Cluster.properties.sizeGb.format - schemas.Cluster.properties.sizeGb.readOnly - schemas.Cluster.properties.sizeGb.type - schemas.Cluster.properties.state.description - schemas.Cluster.properties.state.enum - schemas.Cluster.properties.state.enumDescriptions - schemas.Cluster.properties.state.readOnly - schemas.Cluster.properties.state.type - schemas.Cluster.properties.stateInfo.$ref - schemas.Cluster.properties.stateInfo.description - schemas.Cluster.properties.stateInfo.readOnly - schemas.Cluster.properties.transitEncryptionMode.description - schemas.Cluster.properties.transitEncryptionMode.enum - schemas.Cluster.properties.transitEncryptionMode.enumDescriptions - schemas.Cluster.properties.transitEncryptionMode.type - schemas.Cluster.properties.uid.description - schemas.Cluster.properties.uid.readOnly - schemas.Cluster.properties.uid.type - schemas.Cluster.type - schemas.DiscoveryEndpoint.description - schemas.DiscoveryEndpoint.id - schemas.DiscoveryEndpoint.properties.address.description - schemas.DiscoveryEndpoint.properties.address.readOnly - schemas.DiscoveryEndpoint.properties.address.type - schemas.DiscoveryEndpoint.properties.port.description - schemas.DiscoveryEndpoint.properties.port.format - schemas.DiscoveryEndpoint.properties.port.readOnly - schemas.DiscoveryEndpoint.properties.port.type - schemas.DiscoveryEndpoint.properties.pscConfig.$ref - schemas.DiscoveryEndpoint.properties.pscConfig.description - schemas.DiscoveryEndpoint.properties.pscConfig.readOnly - schemas.DiscoveryEndpoint.type - schemas.ListClustersResponse.description - schemas.ListClustersResponse.id - schemas.ListClustersResponse.properties.clusters.description - schemas.ListClustersResponse.properties.clusters.items.$ref - schemas.ListClustersResponse.properties.clusters.type - schemas.ListClustersResponse.properties.nextPageToken.description - schemas.ListClustersResponse.properties.nextPageToken.type - schemas.ListClustersResponse.properties.unreachable.description - schemas.ListClustersResponse.properties.unreachable.items.type - schemas.ListClustersResponse.properties.unreachable.type - schemas.ListClustersResponse.type - schemas.ManagedCertificateAuthority.id - schemas.ManagedCertificateAuthority.properties.caCerts.description - schemas.ManagedCertificateAuthority.properties.caCerts.items.$ref - schemas.ManagedCertificateAuthority.properties.caCerts.type - schemas.ManagedCertificateAuthority.type - schemas.OperationMetadata.description - schemas.OperationMetadata.id - schemas.OperationMetadata.properties.apiVersion.description - schemas.OperationMetadata.properties.apiVersion.readOnly - schemas.OperationMetadata.properties.apiVersion.type - schemas.OperationMetadata.properties.createTime.description - schemas.OperationMetadata.properties.createTime.format - schemas.OperationMetadata.properties.createTime.readOnly - schemas.OperationMetadata.properties.createTime.type - schemas.OperationMetadata.properties.endTime.description - schemas.OperationMetadata.properties.endTime.format - schemas.OperationMetadata.properties.endTime.readOnly - schemas.OperationMetadata.properties.endTime.type - schemas.OperationMetadata.properties.requestedCancellation.description - schemas.OperationMetadata.properties.requestedCancellation.readOnly - schemas.OperationMetadata.properties.requestedCancellation.type - schemas.OperationMetadata.properties.statusMessage.description - schemas.OperationMetadata.properties.statusMessage.readOnly - schemas.OperationMetadata.properties.statusMessage.type - schemas.OperationMetadata.properties.target.description - schemas.OperationMetadata.properties.target.readOnly - schemas.OperationMetadata.properties.target.type - schemas.OperationMetadata.properties.verb.description - schemas.OperationMetadata.properties.verb.readOnly - schemas.OperationMetadata.properties.verb.type - schemas.OperationMetadata.type - schemas.PscConfig.id - schemas.PscConfig.properties.network.description - schemas.PscConfig.properties.network.type - schemas.PscConfig.type - schemas.PscConnection.description - schemas.PscConnection.id - schemas.PscConnection.properties.address.description - schemas.PscConnection.properties.address.readOnly - schemas.PscConnection.properties.address.type - schemas.PscConnection.properties.forwardingRule.description - schemas.PscConnection.properties.forwardingRule.readOnly - schemas.PscConnection.properties.forwardingRule.type - schemas.PscConnection.properties.network.description - schemas.PscConnection.properties.network.type - schemas.PscConnection.properties.projectId.description - schemas.PscConnection.properties.projectId.readOnly - schemas.PscConnection.properties.projectId.type - schemas.PscConnection.properties.pscConnectionId.description - schemas.PscConnection.properties.pscConnectionId.readOnly - schemas.PscConnection.properties.pscConnectionId.type - schemas.PscConnection.type - schemas.StateInfo.description - schemas.StateInfo.id - schemas.StateInfo.properties.updateInfo.$ref - schemas.StateInfo.properties.updateInfo.description - schemas.StateInfo.type - schemas.UpdateInfo.description - schemas.UpdateInfo.id - schemas.UpdateInfo.properties.targetReplicaCount.description - schemas.UpdateInfo.properties.targetReplicaCount.format - schemas.UpdateInfo.properties.targetReplicaCount.type - schemas.UpdateInfo.properties.targetShardCount.description - schemas.UpdateInfo.properties.targetShardCount.format - schemas.UpdateInfo.properties.targetShardCount.type - schemas.UpdateInfo.type * feat(retail): update the API #### retail:v2alpha The following keys were added: - resources.projects.methods.getLoggingConfig.description - resources.projects.methods.getLoggingConfig.flatPath - resources.projects.methods.getLoggingConfig.httpMethod - resources.projects.methods.getLoggingConfig.id - resources.projects.methods.getLoggingConfig.parameterOrder - resources.projects.methods.getLoggingConfig.parameters.name.description - resources.projects.methods.getLoggingConfig.parameters.name.location - resources.projects.methods.getLoggingConfig.parameters.name.pattern - resources.projects.methods.getLoggingConfig.parameters.name.required - resources.projects.methods.getLoggingConfig.parameters.name.type - resources.projects.methods.getLoggingConfig.path - resources.projects.methods.getLoggingConfig.response.$ref - resources.projects.methods.getLoggingConfig.scopes - resources.projects.methods.updateLoggingConfig.description - resources.projects.methods.updateLoggingConfig.flatPath - resources.projects.methods.updateLoggingConfig.httpMethod - resources.projects.methods.updateLoggingConfig.id - resources.projects.methods.updateLoggingConfig.parameterOrder - resources.projects.methods.updateLoggingConfig.parameters.name.description - resources.projects.methods.updateLoggingConfig.parameters.name.location - resources.projects.methods.updateLoggingConfig.parameters.name.pattern - resources.projects.methods.updateLoggingConfig.parameters.name.required - resources.projects.methods.updateLoggingConfig.parameters.name.type - resources.projects.methods.updateLoggingConfig.parameters.updateMask.description - resources.projects.methods.updateLoggingConfig.parameters.updateMask.format - resources.projects.methods.updateLoggingConfig.parameters.updateMask.location - resources.projects.methods.updateLoggingConfig.parameters.updateMask.type - resources.projects.methods.updateLoggingConfig.path - resources.projects.methods.updateLoggingConfig.request.$ref - resources.projects.methods.updateLoggingConfig.response.$ref - resources.projects.methods.updateLoggingConfig.scopes - schemas.GoogleCloudRetailV2alphaLoggingConfig.description - schemas.GoogleCloudRetailV2alphaLoggingConfig.id - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.defaultLogGenerationRule.$ref - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.defaultLogGenerationRule.description - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.name.description - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.name.type - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.serviceLogGenerationRules.description - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.serviceLogGenerationRules.items.$ref - schemas.GoogleCloudRetailV2alphaLoggingConfig.properties.serviceLogGenerationRules.type - schemas.GoogleCloudRetailV2alphaLoggingConfig.type - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.description - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.id - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.infoLogSampleRate.description - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.infoLogSampleRate.format - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.infoLogSampleRate.type - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.loggingLevel.description - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.loggingLevel.enum - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.loggingLevel.enumDescriptions - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.properties.loggingLevel.type - schemas.GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule.type - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.description - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.id - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.properties.logGenerationRule.$ref - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.properties.logGenerationRule.description - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.properties.serviceName.description - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.properties.serviceName.type - schemas.GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule.type * feat(run)!: update the API BREAKING CHANGE: This release has breaking changes. #### run:v1 The following keys were changed: - schemas.EnvVar.properties.name.description - schemas.ObjectMeta.properties.annotations.description - schemas.Service.properties.metadata.description - schemas.ServiceStatus.properties.observedGeneration.description #### run:v2 The following keys were deleted: - schemas.GoogleCloudRunV2Service.properties.trafficTagsCleanupThreshold.description - schemas.GoogleCloudRunV2Service.properties.trafficTagsCleanupThreshold.format - schemas.GoogleCloudRunV2Service.properties.trafficTagsCleanupThreshold.type The following keys were changed: - schemas.GoogleCloudRunV2EnvVar.properties.name.description * fix(safebrowsing): update the API * feat(sasportal): update the API #### sasportal:v1alpha1 The following keys were added: - schemas.SasPortalSetupSasAnalyticsRequest.properties.userId.description - schemas.SasPortalSetupSasAnalyticsRequest.properties.userId.type * feat(securitycenter)!: update the API BREAKING CHANGE: This release has breaking changes. #### securitycenter:v1beta1 The following keys were added: - schemas.Finding.properties.loadBalancers.description - schemas.Finding.properties.loadBalancers.items.$ref - schemas.Finding.properties.loadBalancers.type - schemas.Finding.properties.securityPosture.$ref - schemas.Finding.properties.securityPosture.description - schemas.Kubernetes.properties.objects.description - schemas.Kubernetes.properties.objects.items.$ref - schemas.Kubernetes.properties.objects.type - schemas.LoadBalancer.description - schemas.LoadBalancer.id - schemas.LoadBalancer.properties.name.description - schemas.LoadBalancer.properties.name.type - schemas.LoadBalancer.type - schemas.Object.description - schemas.Object.id - schemas.Object.properties.group.description - schemas.Object.properties.group.type - schemas.Object.properties.kind.description - schemas.Object.properties.kind.type - schemas.Object.properties.name.description - schemas.Object.properties.name.type - schemas.Object.properties.ns.description - schemas.Object.properties.ns.type - schemas.Object.type - schemas.SecurityPosture.description - schemas.SecurityPosture.id - schemas.SecurityPosture.properties.changedPolicy.description - schemas.SecurityPosture.properties.changedPolicy.type - schemas.SecurityPosture.properties.name.description - schemas.SecurityPosture.properties.name.type - schemas.SecurityPosture.properties.postureDeployment.description - schemas.SecurityPosture.properties.postureDeployment.type - schemas.SecurityPosture.properties.postureDeploymentResource.description - schemas.SecurityPosture.properties.postureDeploymentResource.type - schemas.SecurityPosture.properties.revisionId.description - schemas.SecurityPosture.properties.revisionId.type - schemas.SecurityPosture.type The following keys were changed: - schemas.GoogleCloudSecuritycenterV1ResourceValueConfig.description #### securitycenter:v1beta2 The following keys were deleted: - resources.folders.methods.getOnboardingState.description - resources.folders.methods.getOnboardingState.flatPath - resources.folders.methods.getOnboardingState.httpMethod - resources.folders.methods.getOnboardingState.id - resources.folders.methods.getOnboardingState.parameterOrder - resources.folders.methods.getOnboardingState.parameters.name.description - resources.folders.methods.getOnboardingState.parameters.name.location - resources.folders.methods.getOnboardingState.parameters.name.pattern - resources.folders.methods.getOnboardingState.parameters.name.required - resources.folders.methods.getOnboardingState.parameters.name.type - resources.folders.methods.getOnboardingState.path - resources.folders.methods.getOnboardingState.response.$ref - resources.folders.methods.getOnboardingState.scopes - resources.organizations.methods.getOnboardingState.description - resources.organizations.methods.getOnboardingState.flatPath - resources.organizations.methods.getOnboardingState.httpMethod - resources.organizations.methods.getOnboardingState.id - resources.organizations.methods.getOnboardingState.parameterOrder - resources.organizations.methods.getOnboardingState.parameters.name.description - resources.organizations.methods.getOnboardingState.parameters.name.location - resources.organizations.methods.getOnboardingState.parameters.name.pattern - resources.organizations.methods.getOnboardingState.parameters.name.required - resources.organizations.methods.getOnboardingState.parameters.name.type - resources.organizations.methods.getOnboardingState.path - resources.organizations.methods.getOnboardingState.response.$ref - resources.organizations.methods.getOnboardingState.scopes - resources.projects.methods.getOnboardingState.description - resources.projects.methods.getOnboardingState.flatPath - resources.projects.methods.getOnboardingState.httpMethod - resources.projects.methods.getOnboardingState.id - resources.projects.methods.getOnboardingState.parameterOrder - resources.projects.methods.getOnboardingState.parameters.name.description - resources.projects.methods.getOnboardingState.parameters.name.location - resources.projects.methods.getOnboardingState.parameters.name.pattern - resources.projects.methods.getOnboardingState.parameters.name.required - resources.projects.methods.getOnboardingState.parameters.name.type - resources.projects.methods.getOnboardingState.path - resources.projects.methods.getOnboardingState.response.$ref - resources.projects.methods.getOnboardingState.scopes - schemas.OnboardingState.description - schemas.OnboardingState.id - schemas.OnboardingState.properties.name.description - schemas.OnboardingState.properties.name.type - schemas.OnboardingState.properties.onboardingLevel.description - schemas.OnboardingState.properties.onboardingLevel.enum - schemas.OnboardingState.properties.onboardingLevel.enumDescriptions - schemas.OnboardingState.properties.onboardingLevel.type - schemas.OnboardingState.type The following keys were added: - schemas.Finding.properties.loadBalancers.description - schemas.Finding.properties.loadBalancers.items.$ref - schemas.Finding.properties.loadBalancers.type - schemas.Finding.properties.securityPosture.$ref - schemas.Finding.properties.securityPosture.description - schemas.Kubernetes.properties.objects.description - schemas.Kubernetes.properties.objects.items.$ref - schemas.Kubernetes.properties.objects.type - schemas.LoadBalancer.description - schemas.LoadBalancer.id - schemas.LoadBalancer.properties.name.description - schemas.LoadBalancer.properties.name.type - schemas.LoadBalancer.type - schemas.Object.description - schemas.Object.id - schemas.Object.properties.group.description - schemas.Object.properties.group.type - schemas.Object.properties.kind.description - schemas.Object.properties.kind.type - schemas.Object.properties.name.description - schemas.Object.properties.name.type - schemas.Object.properties.ns.description - schemas.Object.properties.ns.type - schemas.Object.type - schemas.SecurityPosture.description - schemas.SecurityPosture.id - schemas.SecurityPosture.properties.changedPolicy.description - schemas.SecurityPosture.properties.changedPolicy.type - schemas.SecurityPosture.properties.name.description - schemas.SecurityPosture.properties.name.type - schemas.SecurityPosture.properties.postureDeployment.description - schemas.SecurityPosture.properties.postureDeployment.type - schemas.SecurityPosture.properties.postureDeploymentResource.description - schemas.SecurityPosture.properties.postureDeploymentResource.type - schemas.SecurityPosture.properties.revisionId.description - schemas.SecurityPosture.properties.revisionId.type - schemas.SecurityPosture.type The following keys were changed: - schemas.GoogleCloudSecuritycenterV1ResourceValueConfig.description #### securitycenter:v1 The following keys were added: - schemas.Finding.properties.loadBalancers.description - schemas.Finding.properties.loadBalancers.items.$ref - schemas.Finding.properties.loadBalancers.type - schemas.Finding.properties.securityPosture.$ref - schemas.Finding.properties.securityPosture.description - schemas.Kubernetes.properties.objects.description - schemas.Kubernetes.properties.objects.items.$ref - schemas.Kubernetes.properties.objects.type - schemas.LoadBalancer.description - schemas.LoadBalancer.id - schemas.LoadBalancer.properties.name.description - schemas.LoadBalancer.properties.name.type - schemas.LoadBalancer.type - schemas.Object.description - schemas.Object.id - schemas.Object.properties.group.description - schemas.Object.properties.group.type - schemas.Object.properties.kind.description - schemas.Object.properties.kind.type - schemas.Object.properties.name.description - schemas.Object.properties.name.type - schemas.Object.properties.ns.description - schemas.Object.properties.ns.type - schemas.Object.type - schemas.SecurityPosture.description - schemas.SecurityPosture.id - schemas.SecurityPosture.properties.changedPolicy.description - schemas.SecurityPosture.properties.changedPolicy.type - schemas.SecurityPosture.properties.name.description - schemas.SecurityPosture.properties.name.type - schemas.SecurityPosture.properties.postureDeployment.description - schemas.SecurityPosture.properties.postureDeployment.type - schemas.SecurityPosture.properties.postureDeploymentResource.description - schemas.SecurityPosture.properties.postureDeploymentResource.type - schemas.SecurityPosture.properties.revisionId.description - schemas.SecurityPosture.properties.revisionId.type - schemas.SecurityPosture.type The following keys were changed: - schemas.GoogleCloudSecuritycenterV1ResourceValueConfig.description - schemas.Source.properties.canonicalName.description * fix(spanner): update the API #### spanner:v1 The following keys were changed: - resources.projects.resources.instances.resources.databases.resources.sessions.methods.batchWrite.description - schemas.PartitionQueryRequest.properties.sql.description * feat(storage): update the API #### storage:v1 The following keys were added: - resources.objects.methods.restore.parameters.copySourceAcl.description - resources.objects.methods.restore.parameters.copySourceAcl.location - resources.objects.methods.restore.parameters.copySourceAcl.type - schemas.Object.properties.hardDeleteTime.description - schemas.Object.properties.hardDeleteTime.format - schemas.Object.properties.hardDeleteTime.type - schemas.Object.properties.softDeleteTime.description - schemas.Object.properties.softDeleteTime.format - schemas.Object.properties.softDeleteTime.type The following keys were changed: - schemas.Object.properties.timeDeleted.description * feat(tagmanager): update the API #### tagmanager:v2 The following keys were added: - schemas.Entity.properties.builtInVariable.$ref - schemas.Entity.properties.builtInVariable.description - schemas.Entity.properties.customTemplate.$ref - schemas.Entity.properties.customTemplate.description - schemas.Entity.properties.gtagConfig.$ref - schemas.Entity.properties.gtagConfig.description - schemas.Entity.properties.zone.$ref - schemas.Entity.properties.zone.description * fix(translate): update the API #### translate:v3beta1 The following keys were changed: - schemas.BatchTranslateDocumentRequest.properties.formatConversions.description #### translate:v3 The following keys were changed: - resources.projects.methods.getSupportedLanguages.scopes - resources.projects.resources.locations.methods.getSupportedLanguages.scopes - resources.projects.resources.locations.resources.glossaries.methods.delete.scopes - resources.projects.resources.locations.resources.glossaries.methods.get.scopes - resources.projects.resources.locations.resources.glossaries.methods.list.scopes - resources.projects.resources.locations.resources.glossaries.resources.glossaryEntries.methods.get.scopes - resources.projects.resources.locations.resources.glossaries.resources.glossaryEntries.methods.list.scopes - schemas.BatchTranslateDocumentRequest.properties.formatConversions.description * fix(vmwareengine): update the API * feat(youtube): update the API #### youtube:v3 The following keys were added: - resources.channels.methods.list.parameters.forHandle.description - resources.channels.methods.list.parameters.forHandle.location - resources.channels.methods.list.parameters.forHandle.type * feat: regenerate index files * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Yoshi Automation Co-authored-by: Owl Bot --- discovery/admin-directory_v1.json | 5 +- discovery/admob-v1beta.json | 8 +- discovery/aiplatform-v1.json | 433 +- discovery/aiplatform-v1beta1.json | 2465 +- discovery/alloydb-v1.json | 298 +- discovery/alloydb-v1alpha.json | 183 +- discovery/alloydb-v1beta.json | 183 +- discovery/analyticsadmin-v1alpha.json | 1257 +- discovery/analyticsadmin-v1beta.json | 16 +- discovery/analyticshub-v1.json | 16 +- discovery/analyticshub-v1beta1.json | 16 +- discovery/androidmanagement-v1.json | 50 +- discovery/androidpublisher-v3.json | 19 +- discovery/apigee-v1.json | 604 +- discovery/apigeeregistry-v1.json | 93 +- discovery/artifactregistry-v1.json | 51 +- discovery/artifactregistry-v1beta1.json | 53 +- discovery/artifactregistry-v1beta2.json | 53 +- discovery/backupdr-v1.json | 1068 + discovery/baremetalsolution-v2.json | 31 +- discovery/batch-v1.json | 6 +- discovery/beyondcorp-v1alpha.json | 20 +- discovery/bigqueryreservation-v1.json | 9 +- discovery/binaryauthorization-v1.json | 6 +- discovery/blockchainnodeengine-v1.json | 6 +- discovery/chat-v1.json | 48 +- discovery/chromepolicy-v1.json | 113 +- discovery/cloudasset-v1.json | 68 +- discovery/cloudbuild-v1.json | 16 +- discovery/cloudbuild-v2.json | 20 +- discovery/clouddeploy-v1.json | 25 +- discovery/cloudsupport-v2.json | 4 +- discovery/cloudsupport-v2beta.json | 4 +- discovery/cloudtasks-v2beta3.json | 81 +- discovery/composer-v1.json | 13 +- discovery/composer-v1beta1.json | 13 +- discovery/compute-alpha.json | 335 +- discovery/compute-beta.json | 1047 +- discovery/compute-v1.json | 1265 +- discovery/connectors-v1.json | 13 +- discovery/contactcenterinsights-v1.json | 60 +- discovery/container-v1.json | 38 +- discovery/container-v1beta1.json | 66 +- discovery/containeranalysis-v1.json | 24 +- discovery/containeranalysis-v1alpha1.json | 20 +- discovery/containeranalysis-v1beta1.json | 24 +- discovery/content-v2.1.json | 8 +- discovery/contentwarehouse-v1.json | 610 +- discovery/dataflow-v1b3.json | 9 +- discovery/datalabeling-v1beta1.json | 6 +- discovery/dataplex-v1.json | 92 +- discovery/dataproc-v1.json | 35 +- discovery/deploymentmanager-v2.json | 12 +- discovery/dialogflow-v2.json | 160 +- discovery/dialogflow-v2beta1.json | 160 +- discovery/dialogflow-v3.json | 314 +- discovery/dialogflow-v3beta1.json | 314 +- discovery/discoveryengine-v1alpha.json | 298 +- discovery/discoveryengine-v1beta.json | 201 +- discovery/displayvideo-v1.json | 73 +- discovery/displayvideo-v2.json | 91 +- discovery/displayvideo-v3.json | 21774 ++++++++++++++++++ discovery/dlp-v2.json | 13 +- discovery/docs-v1.json | 14 +- discovery/documentai-v1.json | 10 +- discovery/documentai-v1beta2.json | 4 +- discovery/documentai-v1beta3.json | 140 +- discovery/eventarc-v1.json | 6 +- discovery/firestore-v1.json | 34 +- discovery/firestore-v1beta1.json | 4 +- discovery/gkebackup-v1.json | 54 +- discovery/gkehub-v1.json | 6 +- discovery/gkehub-v1alpha.json | 6 +- discovery/gkehub-v1beta.json | 709 +- discovery/gkeonprem-v1.json | 6 +- discovery/gmail-v1.json | 36 +- discovery/healthcare-v1.json | 384 +- discovery/healthcare-v1beta1.json | 416 +- discovery/iap-v1.json | 10 +- discovery/index.json | 49 +- discovery/indexing-v3.json | 6 +- discovery/integrations-v1alpha.json | 569 +- discovery/logging-v2.json | 4 +- discovery/metastore-v1.json | 20 +- discovery/metastore-v1alpha.json | 20 +- discovery/metastore-v1beta.json | 20 +- discovery/migrationcenter-v1.json | 10 +- discovery/migrationcenter-v1alpha1.json | 76 +- discovery/monitoring-v1.json | 36 +- discovery/networkconnectivity-v1.json | 82 +- discovery/networksecurity-v1beta1.json | 14 +- discovery/networkservices-v1.json | 34 +- discovery/networkservices-v1beta1.json | 661 +- discovery/notebooks-v1.json | 118 +- discovery/ondemandscanning-v1.json | 6 +- discovery/ondemandscanning-v1beta1.json | 6 +- discovery/oslogin-v1alpha.json | 35 +- discovery/oslogin-v1beta.json | 35 +- discovery/places-v1.json | 46 +- discovery/playintegrity-v1.json | 22 +- discovery/pubsub-v1.json | 6 +- discovery/pubsub-v1beta1a.json | 6 +- discovery/pubsub-v1beta2.json | 6 +- discovery/redis-v1.json | 509 +- discovery/retail-v2alpha.json | 128 +- discovery/run-v1.json | 10 +- discovery/run-v2.json | 9 +- discovery/safebrowsing-v5.json | 212 + discovery/sasportal-v1alpha1.json | 9 +- discovery/securitycenter-v1.json | 85 +- discovery/securitycenter-v1beta1.json | 83 +- discovery/securitycenter-v1beta2.json | 165 +- discovery/spanner-v1.json | 6 +- discovery/storage-v1.json | 21 +- discovery/tagmanager-v2.json | 18 +- discovery/translate-v3.json | 25 +- discovery/translate-v3beta1.json | 4 +- discovery/vmmigration-v1.json | 20 +- discovery/vmmigration-v1alpha1.json | 20 +- discovery/vmwareengine-v1.json | 3400 +++ discovery/youtube-v3.json | 7 +- release-please-config.json | 4 +- src/apis/admin/directory_v1.ts | 2 +- src/apis/aiplatform/v1.ts | 663 +- src/apis/aiplatform/v1beta1.ts | 4965 +++- src/apis/alloydb/v1.ts | 351 +- src/apis/alloydb/v1alpha.ts | 96 +- src/apis/alloydb/v1beta.ts | 96 +- src/apis/analyticsadmin/v1alpha.ts | 3044 +-- src/apis/analyticsadmin/v1beta.ts | 14 +- src/apis/analyticshub/v1.ts | 12 +- src/apis/analyticshub/v1beta1.ts | 12 +- src/apis/androidmanagement/v1.ts | 18 +- src/apis/androidpublisher/v3.ts | 2 +- src/apis/apigeeregistry/v1.ts | 319 + src/apis/artifactregistry/v1.ts | 2 +- src/apis/artifactregistry/v1beta1.ts | 2 +- src/apis/backupdr/README.md | 28 + src/apis/backupdr/index.ts | 44 + src/apis/backupdr/package.json | 43 + src/apis/backupdr/tsconfig.json | 10 + src/apis/backupdr/v1.ts | 1825 ++ src/apis/backupdr/webpack.config.js | 79 + src/apis/batch/v1.ts | 4 + src/apis/beyondcorp/v1alpha.ts | 13 + src/apis/binaryauthorization/v1.ts | 4 + src/apis/blockchainnodeengine/v1.ts | 4 + src/apis/chat/v1.ts | 42 +- src/apis/chromepolicy/v1.ts | 49 +- src/apis/cloudasset/v1.ts | 50 +- src/apis/cloudbuild/v1.ts | 12 + src/apis/cloudsupport/v2.ts | 2 +- src/apis/cloudsupport/v2beta.ts | 2 +- src/apis/cloudtasks/v2beta3.ts | 211 + src/apis/composer/v1.ts | 11 +- src/apis/composer/v1beta1.ts | 11 +- src/apis/compute/alpha.ts | 246 +- src/apis/compute/beta.ts | 1711 +- src/apis/compute/v1.ts | 1502 +- src/apis/connectors/v1.ts | 8 + src/apis/contactcenterinsights/v1.ts | 46 +- src/apis/container/v1.ts | 29 +- src/apis/container/v1beta1.ts | 35 +- src/apis/containeranalysis/v1.ts | 12 +- src/apis/containeranalysis/v1alpha1.ts | 8 + src/apis/containeranalysis/v1beta1.ts | 12 +- src/apis/content/v2.1.ts | 6 +- src/apis/contentwarehouse/v1.ts | 132 +- src/apis/datalabeling/v1beta1.ts | 2 +- src/apis/dataplex/v1.ts | 43 + src/apis/dataproc/v1.ts | 25 + src/apis/deploymentmanager/v2.ts | 10 +- src/apis/dialogflow/v2.ts | 112 + src/apis/dialogflow/v2beta1.ts | 112 + src/apis/dialogflow/v3.ts | 371 + src/apis/dialogflow/v3beta1.ts | 371 + src/apis/discoveryengine/v1alpha.ts | 572 +- src/apis/discoveryengine/v1beta.ts | 323 +- src/apis/displayvideo/index.ts | 12 +- src/apis/displayvideo/v1.ts | 45 +- src/apis/displayvideo/v2.ts | 61 +- src/apis/displayvideo/v3.ts | 24049 ++++++++++++++++++++ src/apis/dlp/v2.ts | 4 + src/apis/docs/v1.ts | 12 + src/apis/documentai/v1.ts | 8 +- src/apis/documentai/v1beta2.ts | 2 +- src/apis/documentai/v1beta3.ts | 178 +- src/apis/eventarc/v1.ts | 4 - src/apis/firestore/v1.ts | 27 +- src/apis/firestore/v1beta1.ts | 2 +- src/apis/gkebackup/v1.ts | 187 +- src/apis/gkehub/v1.ts | 4 - src/apis/gkehub/v1alpha.ts | 4 - src/apis/gkehub/v1beta.ts | 1068 +- src/apis/gkeonprem/v1.ts | 4 - src/apis/gmail/v1.ts | 30 +- src/apis/healthcare/v1.ts | 537 +- src/apis/healthcare/v1beta1.ts | 541 +- src/apis/iap/v1.ts | 4 + src/apis/index.ts | 6 + src/apis/indexing/README.md | 2 +- src/apis/indexing/v3.ts | 4 +- src/apis/metastore/v1.ts | 13 + src/apis/metastore/v1alpha.ts | 13 + src/apis/metastore/v1beta.ts | 13 + src/apis/migrationcenter/v1.ts | 8 +- src/apis/migrationcenter/v1alpha1.ts | 46 +- src/apis/networkconnectivity/v1.ts | 76 +- src/apis/networksecurity/v1beta1.ts | 12 +- src/apis/networkservices/v1.ts | 26 + src/apis/networkservices/v1beta1.ts | 1269 ++ src/apis/notebooks/v1.ts | 232 + src/apis/ondemandscanning/v1.ts | 4 + src/apis/ondemandscanning/v1beta1.ts | 4 + src/apis/oslogin/v1alpha.ts | 117 + src/apis/oslogin/v1beta.ts | 117 + src/apis/places/v1.ts | 27 +- src/apis/playintegrity/v1.ts | 6 +- src/apis/redis/v1.ts | 811 + src/apis/retail/v2alpha.ts | 252 + src/apis/run/v1.ts | 8 +- src/apis/run/v2.ts | 6 +- src/apis/safebrowsing/index.ts | 17 +- src/apis/safebrowsing/v5.ts | 272 + src/apis/sasportal/v1alpha1.ts | 7 +- src/apis/securitycenter/v1.ts | 71 +- src/apis/securitycenter/v1beta1.ts | 69 +- src/apis/securitycenter/v1beta2.ts | 348 +- src/apis/spanner/v1.ts | 4 +- src/apis/storage/v1.ts | 14 +- src/apis/tagmanager/v2.ts | 16 + src/apis/translate/v3.ts | 2 +- src/apis/translate/v3beta1.ts | 2 +- src/apis/vmwareengine/README.md | 37 + src/apis/vmwareengine/index.ts | 46 + src/apis/vmwareengine/package.json | 43 + src/apis/vmwareengine/tsconfig.json | 10 + src/apis/vmwareengine/v1.ts | 6637 ++++++ src/apis/vmwareengine/webpack.config.js | 79 + src/apis/youtube/v3.ts | 4 + src/index.ts | 4 + 241 files changed, 92670 insertions(+), 5474 deletions(-) create mode 100644 discovery/backupdr-v1.json create mode 100644 discovery/displayvideo-v3.json create mode 100644 discovery/safebrowsing-v5.json create mode 100644 discovery/vmwareengine-v1.json create mode 100644 src/apis/backupdr/README.md create mode 100644 src/apis/backupdr/index.ts create mode 100644 src/apis/backupdr/package.json create mode 100644 src/apis/backupdr/tsconfig.json create mode 100644 src/apis/backupdr/v1.ts create mode 100644 src/apis/backupdr/webpack.config.js create mode 100644 src/apis/displayvideo/v3.ts create mode 100644 src/apis/safebrowsing/v5.ts create mode 100644 src/apis/vmwareengine/README.md create mode 100644 src/apis/vmwareengine/index.ts create mode 100644 src/apis/vmwareengine/package.json create mode 100644 src/apis/vmwareengine/tsconfig.json create mode 100644 src/apis/vmwareengine/v1.ts create mode 100644 src/apis/vmwareengine/webpack.config.js diff --git a/discovery/admin-directory_v1.json b/discovery/admin-directory_v1.json index 9195238b8c..c6dbe9fa4b 100644 --- a/discovery/admin-directory_v1.json +++ b/discovery/admin-directory_v1.json @@ -4643,7 +4643,7 @@ } } }, - "revision": "20230918", + "revision": "20231005", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Alias": { @@ -6812,7 +6812,8 @@ "id": "OrgUnit", "properties": { "blockInheritance": { - "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. We recommend using the default value because setting `block_inheritance` to `true` can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).", + "deprecated": true, + "description": "Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. This field is deprecated. Setting it to `true` is no longer supported and can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075).", "type": "boolean" }, "description": { diff --git a/discovery/admob-v1beta.json b/discovery/admob-v1beta.json index b9dec8d49e..3b297d13dc 100644 --- a/discovery/admob-v1beta.json +++ b/discovery/admob-v1beta.json @@ -758,7 +758,7 @@ } } }, - "revision": "20230921", + "revision": "20231010", "rootUrl": "https://admob.googleapis.com/", "schemas": { "AdSource": { @@ -1115,7 +1115,8 @@ "CLICK_THROUGH_RATE", "INSTALLS", "ESTIMATED_COST", - "AVERAGE_CPI" + "AVERAGE_CPI", + "INTERACTIONS" ], "enumDescriptions": [ "Default value for an unset field. Do not use.", @@ -1124,7 +1125,8 @@ "The number of clicks an ad receives divided by the number of times the ad is shown.", "The number of times apps were downloaded to devices.", "The estimated cost of serving a campaign ad instead of an ad that earns revenue. The currency is the reporting currency for campaigns.", - "The average cost per install. This means the average amount that was spent to acquire a new user. The currency is the reporting currency for campaigns." + "The average cost per install. This means the average amount that was spent to acquire a new user. The currency is the reporting currency for campaigns.", + "The number of times a user interacts with an ad. This consists of clicks and engagements." ], "type": "string" }, diff --git a/discovery/aiplatform-v1.json b/discovery/aiplatform-v1.json index 2ae6f808b7..0a160b64d1 100644 --- a/discovery/aiplatform-v1.json +++ b/discovery/aiplatform-v1.json @@ -20,19 +20,19 @@ "documentationLink": "https://cloud.google.com/vertex-ai/", "endpoints": [ { - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", + "location": "asia-east1", "description": "Locational Endpoint", - "location": "asia-east1" + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" }, { - "location": "asia-east2", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", + "location": "asia-east2", "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", - "location": "asia-northeast1", - "description": "Locational Endpoint" + "location": "asia-northeast1" }, { "endpointUrl": "https://asia-northeast2-aiplatform.googleapis.com/", @@ -40,29 +40,29 @@ "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "location": "asia-northeast3", + "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast3-aiplatform.googleapis.com/" }, { - "location": "asia-south1", "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", + "location": "asia-south1", "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", - "location": "asia-southeast1" + "location": "asia-southeast1", + "description": "Locational Endpoint" }, { + "description": "Locational Endpoint", "location": "asia-southeast2", - "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/" }, { + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "location": "australia-southeast1", - "description": "Locational Endpoint", - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/" + "description": "Locational Endpoint" }, { "location": "australia-southeast2", @@ -70,9 +70,9 @@ "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", - "location": "europe-central2" + "location": "europe-central2", + "description": "Locational Endpoint" }, { "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/", @@ -80,9 +80,9 @@ "description": "Locational Endpoint" }, { - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", + "location": "europe-southwest1", "description": "Locational Endpoint", - "location": "europe-southwest1" + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", @@ -90,58 +90,58 @@ "description": "Locational Endpoint" }, { - "location": "europe-west2", "description": "Locational Endpoint", + "location": "europe-west2", "endpointUrl": "https://europe-west2-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", - "location": "europe-west3", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "europe-west3" }, { - "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west4" + "location": "europe-west4", + "endpointUrl": "https://europe-west4-aiplatform.googleapis.com/" }, { + "location": "europe-west6", "description": "Locational Endpoint", - "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", - "location": "europe-west6" + "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", + "location": "europe-west8", "description": "Locational Endpoint", - "location": "europe-west8" + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "location": "europe-west9", - "description": "Locational Endpoint" + "location": "europe-west9" }, { - "description": "Locational Endpoint", "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "location": "me-west1" + "location": "me-west1", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "location": "northamerica-northeast1" + "location": "northamerica-northeast1", + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "northamerica-northeast2", - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { + "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "southamerica-east1", - "endpointUrl": "https://southamerica-east1-aiplatform.googleapis.com/" + "location": "southamerica-east1" }, { - "description": "Locational Endpoint", "endpointUrl": "https://southamerica-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "southamerica-west1" }, { @@ -150,14 +150,14 @@ "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "us-central2", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "location": "us-east1", "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "us-east1" }, { "location": "us-east4", @@ -165,9 +165,9 @@ "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", "location": "us-south1", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -175,19 +175,19 @@ "endpointUrl": "https://us-west1-aiplatform.googleapis.com/" }, { + "location": "us-west2", "description": "Locational Endpoint", - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", - "location": "us-west2" + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", "location": "us-west3" }, { - "location": "us-west4", "description": "Locational Endpoint", - "endpointUrl": "https://us-west4-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "location": "us-west4" } ], "fullyEncodeReservedExpansion": true, @@ -2067,6 +2067,171 @@ } } }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.datasetVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/datasetVersions", + "response": { + "$ref": "GoogleCloudAiplatformV1ListDatasetVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -3944,12 +4109,11 @@ ], "parameters": { "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .", + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -3977,7 +4141,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`", + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, @@ -4002,7 +4166,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, @@ -4054,7 +4218,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -8595,7 +8759,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -8788,7 +8952,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -12833,7 +12997,7 @@ } } }, - "revision": "20230914", + "revision": "20231002", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -14238,7 +14402,7 @@ "type": "object" }, "GoogleCloudAiplatformV1CreateFeatureRequest": { - "description": "Request message for FeaturestoreService.CreateFeature.", + "description": "Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.", "id": "GoogleCloudAiplatformV1CreateFeatureRequest", "properties": { "feature": { @@ -14246,11 +14410,10 @@ "description": "Required. The Feature to create." }, "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .", + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "type": "string" } }, @@ -14838,6 +15001,39 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1DatasetVersion": { + "description": "Describes the dataset version.", + "id": "GoogleCloudAiplatformV1DatasetVersion", + "properties": { + "bigQueryDatasetName": { + "description": "Output only. Name of the associated BigQuery dataset.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when this DatasetVersion was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the DatasetVersion.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this DatasetVersion was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1DedicatedResources": { "description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1DedicatedResources", @@ -18064,6 +18260,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1ListDatasetVersionsResponse": { + "description": "Response message for DatasetService.ListDatasetVersions.", + "id": "GoogleCloudAiplatformV1ListDatasetVersionsResponse", + "properties": { + "datasetVersions": { + "description": "A list of DatasetVersions that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1DatasetVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1ListDatasetsResponse": { "description": "Response message for DatasetService.ListDatasets.", "id": "GoogleCloudAiplatformV1ListDatasetsResponse", @@ -18137,7 +18351,7 @@ "type": "object" }, "GoogleCloudAiplatformV1ListFeaturesResponse": { - "description": "Response message for FeaturestoreService.ListFeatures.", + "description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.", "id": "GoogleCloudAiplatformV1ListFeaturesResponse", "properties": { "features": { @@ -18697,6 +18911,10 @@ "machineType": { "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" + }, + "tpuTopology": { + "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", + "type": "string" } }, "type": "object" @@ -19836,6 +20054,13 @@ "enableLogging": { "description": "Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging.", "type": "boolean" + }, + "notificationChannels": { + "description": "Resource names of the NotificationChannels to send alert. Must be of the format `projects//notificationChannels/`", + "items": { + "type": "string" + }, + "type": "array" } }, "type": "object" @@ -20735,7 +20960,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime: * \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id. * \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"BigQuery\" or \"Vertex\"; if absent, it should be \"Vertex\". This is to describe the entry service, either BigQuery or Vertex.", + "description": "The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime: * \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id. * \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"bigquery\" or \"vertex\"; if absent, it should be \"vertex\". This is to describe the entry service, either BigQuery or Vertex.", "type": "object" }, "name": { @@ -20748,6 +20973,21 @@ "description": "Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.", "readOnly": true }, + "notebookRuntimeType": { + "description": "Output only. The type of the notebook runtime.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], + "enumDescriptions": [ + "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", + "runtime or template with coustomized configurations from user.", + "runtime or template with system defined configurations." + ], + "readOnly": true, + "type": "string" + }, "proxyUri": { "description": "Output only. The proxy endpoint used to access the NotebookRuntime.", "readOnly": true, @@ -20856,6 +21096,20 @@ "$ref": "GoogleCloudAiplatformV1NetworkSpec", "description": "Optional. Network spec." }, + "notebookRuntimeType": { + "description": "Optional. Immutable. The type of the notebook runtime template.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], + "enumDescriptions": [ + "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", + "runtime or template with coustomized configurations from user.", + "runtime or template with system defined configurations." + ], + "type": "string" + }, "serviceAccount": { "description": "The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", "type": "string" @@ -21025,7 +21279,7 @@ "readOnly": true }, "templateUri": { - "description": "A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.", + "description": "A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.", "type": "string" }, "updateTime": { @@ -23595,6 +23849,45 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig": { + "description": "The configuration for grounding checking.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", + "properties": { + "sources": { + "description": "The sources for the grounding checking.", + "items": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry": { + "description": "Single source entry for the grounding checking.", + "id": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry", + "properties": { + "enterpriseDatastore": { + "description": "The uri of the Enterprise Search data source.", + "type": "string" + }, + "type": { + "description": "The type of the grounding checking source.", + "enum": [ + "UNSPECIFIED", + "WEB", + "ENTERPRISE" + ], + "enumDescriptions": [ + "", + "Uses Web Search to check the grounding.", + "Uses Enterprise Search to check the grounding." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams": { "description": "Prediction model parameters for Image Classification.", "id": "GoogleCloudAiplatformV1SchemaPredictParamsImageClassificationPredictionParams", @@ -24313,10 +24606,19 @@ "description": "The metadata of Datasets that contain Text Prompt data.", "id": "GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata", "properties": { + "candidateCount": { + "description": "Number of candidates.", + "format": "int64", + "type": "string" + }, "gcsUri": { "description": "The Google Cloud Storage URI that stores the prompt data.", "type": "string" }, + "groundingConfig": { + "$ref": "GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig", + "description": "Grounding checking configuration." + }, "maxOutputTokens": { "description": "Value of the maximum number of tokens generated set when the dataset was saved.", "format": "int64", @@ -24326,6 +24628,13 @@ "description": "Type of the prompt dataset.", "type": "string" }, + "stopSequences": { + "description": "Customized stop sequences.", + "items": { + "type": "string" + }, + "type": "array" + }, "temperature": { "description": "Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness.", "format": "float", diff --git a/discovery/aiplatform-v1beta1.json b/discovery/aiplatform-v1beta1.json index bb2ab4719a..5a0198963f 100644 --- a/discovery/aiplatform-v1beta1.json +++ b/discovery/aiplatform-v1beta1.json @@ -21,17 +21,17 @@ "endpoints": [ { "location": "asia-east1", - "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://asia-east1-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://asia-east2-aiplatform.googleapis.com/", - "location": "asia-east2", - "description": "Locational Endpoint" + "location": "asia-east2" }, { - "description": "Locational Endpoint", "endpointUrl": "https://asia-northeast1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "asia-northeast1" }, { @@ -45,48 +45,48 @@ "location": "asia-northeast3" }, { - "location": "asia-south1", "endpointUrl": "https://asia-south1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-south1" }, { - "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://asia-southeast1-aiplatform.googleapis.com/", "location": "asia-southeast1" }, { "endpointUrl": "https://asia-southeast2-aiplatform.googleapis.com/", - "location": "asia-southeast2", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "location": "asia-southeast2" }, { - "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://australia-southeast1-aiplatform.googleapis.com/", "location": "australia-southeast1" }, { - "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "australia-southeast2", - "description": "Locational Endpoint" + "endpointUrl": "https://australia-southeast2-aiplatform.googleapis.com/" }, { "location": "europe-central2", - "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "description": "Locational Endpoint", + "endpointUrl": "https://europe-central2-aiplatform.googleapis.com/" }, { - "description": "Locational Endpoint", "location": "europe-north1", + "description": "Locational Endpoint", "endpointUrl": "https://europe-north1-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/", - "location": "europe-southwest1" + "location": "europe-southwest1", + "endpointUrl": "https://europe-southwest1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", "description": "Locational Endpoint", + "endpointUrl": "https://europe-west1-aiplatform.googleapis.com/", "location": "europe-west1" }, { @@ -95,9 +95,9 @@ "location": "europe-west2" }, { - "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/", + "location": "europe-west3", "description": "Locational Endpoint", - "location": "europe-west3" + "endpointUrl": "https://europe-west3-aiplatform.googleapis.com/" }, { "location": "europe-west4", @@ -105,34 +105,34 @@ "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://europe-west6-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "europe-west6" }, { - "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "europe-west8" + "location": "europe-west8", + "endpointUrl": "https://europe-west8-aiplatform.googleapis.com/" }, { "endpointUrl": "https://europe-west9-aiplatform.googleapis.com/", - "description": "Locational Endpoint", - "location": "europe-west9" + "location": "europe-west9", + "description": "Locational Endpoint" }, { "description": "Locational Endpoint", - "endpointUrl": "https://me-west1-aiplatform.googleapis.com/", - "location": "me-west1" + "location": "me-west1", + "endpointUrl": "https://me-west1-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "location": "northamerica-northeast1", - "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://northamerica-northeast1-aiplatform.googleapis.com/" }, { - "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/", + "location": "northamerica-northeast2", "description": "Locational Endpoint", - "location": "northamerica-northeast2" + "endpointUrl": "https://northamerica-northeast2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", @@ -145,48 +145,48 @@ "description": "Locational Endpoint" }, { - "endpointUrl": "https://us-central1-aiplatform.googleapis.com/", "description": "Locational Endpoint", - "location": "us-central1" + "location": "us-central1", + "endpointUrl": "https://us-central1-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "location": "us-central2", - "endpointUrl": "https://us-central2-aiplatform.googleapis.com/", - "description": "Locational Endpoint" + "endpointUrl": "https://us-central2-aiplatform.googleapis.com/" }, { + "description": "Locational Endpoint", "endpointUrl": "https://us-east1-aiplatform.googleapis.com/", - "location": "us-east1", - "description": "Locational Endpoint" + "location": "us-east1" }, { - "description": "Locational Endpoint", "location": "us-east4", + "description": "Locational Endpoint", "endpointUrl": "https://us-east4-aiplatform.googleapis.com/" }, { "location": "us-south1", - "description": "Locational Endpoint", - "endpointUrl": "https://us-south1-aiplatform.googleapis.com/" + "endpointUrl": "https://us-south1-aiplatform.googleapis.com/", + "description": "Locational Endpoint" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west1-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west1" }, { - "endpointUrl": "https://us-west2-aiplatform.googleapis.com/", + "location": "us-west2", "description": "Locational Endpoint", - "location": "us-west2" + "endpointUrl": "https://us-west2-aiplatform.googleapis.com/" }, { "description": "Locational Endpoint", - "location": "us-west3", - "endpointUrl": "https://us-west3-aiplatform.googleapis.com/" + "endpointUrl": "https://us-west3-aiplatform.googleapis.com/", + "location": "us-west3" }, { - "description": "Locational Endpoint", "endpointUrl": "https://us-west4-aiplatform.googleapis.com/", + "description": "Locational Endpoint", "location": "us-west4" } ], @@ -2067,6 +2067,171 @@ } } }, + "datasetVersions": { + "methods": { + "create": { + "description": "Create a version from a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.datasets.datasetVersions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the Dataset resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasetVersions", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a Dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.datasets.datasetVersions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets a Dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the Dataset version to delete. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists DatasetVersions in a Dataset.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project}/locations/{location}/datasets/{dataset}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/datasetVersions", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "restore": { + "description": "Restores a dataset version.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/datasetVersions/{datasetVersionsId}:restore", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.datasets.datasetVersions.restore", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the DatasetVersion resource. Format: `projects/{project}/locations/{location}/datasets/{dataset}/datasetVersions/{dataset_version}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/datasetVersions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:restore", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "cancel": { @@ -4017,93 +4182,439 @@ } }, "featureGroups": { - "resources": { - "features": { - "resources": { - "operations": { - "methods": { - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.operations.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/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`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", - "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.features.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": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", - "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" - } + "methods": { + "create": { + "description": "Creates a new FeatureGroup in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureGroupId": { + "description": "Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project}/locations/{location}'`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureGroups", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureGroup to be deleted. Format: `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureGroup resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureGroups in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureGroups created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureGroups with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureGroupAdminService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService.ListFeatureGroups must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureGroups", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "features": { + "methods": { + "create": { + "description": "Creates a new Feature in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.features.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureId": { + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", + "location": "query", + "type": "string" + }, + "parent": { + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists Features in a given FeatureGroup.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, >, >=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --> Features whose type is DOUBLE. * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any Feature which has a label with 'env' as the key.", + "location": "query", + "type": "string" + }, + "latestStatsCount": { + "description": "If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Mask specifying which fields to read.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/features", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeaturesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single Feature.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureGroups.features.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Immutable. Name of the Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1Feature" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.features.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+/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`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/features/{featuresId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.features.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": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/features/[^/]+$", + "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": { @@ -4144,142 +4655,641 @@ "https://www.googleapis.com/auth/cloud-platform" ] } - } + } + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/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`.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureGroups.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": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", + "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" + ] + }, + "wait": { + "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to wait on.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + }, + "timeout": { + "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", + "format": "google-duration", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}:wait", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } + } + } + }, + "featureOnlineStores": { + "methods": { + "create": { + "description": "Creates a new FeatureOnlineStore in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureOnlineStoreId": { + "description": "Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project}/locations/{location}'`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureOnlineStores", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, - "operations": { + "delete": { + "description": "Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "DELETE", + "id": "aiplatform.projects.locations.featureOnlineStores.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.)", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureOnlineStore resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureOnlineStores in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `<=`, and `>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time > \"2020-01-01\" OR update_time > \"2020-01-01\"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = \"prod\"` FeatureOnlineStores with label \"env\" set to \"prod\".", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported Fields: * `create_time` * `update_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project}/locations/{location}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureOnlineStores", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `labels` * `sync_config`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "featureViews": { "methods": { + "create": { + "description": "Creates a new FeatureView in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "featureViewId": { + "description": "Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + }, + "runSyncImmediately": { + "description": "Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1beta1/{+parent}/featureViews", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "description": "Deletes a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "DELETE", - "id": "aiplatform.projects.locations.featureGroups.operations.delete", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource to be deleted.", + "description": "Required. The name of the FeatureView to be deleted. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "fetchFeatureValues": { + "description": "Fetch feature values under a FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:fetchFeatureValues", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.fetchFeatureValues", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+featureView}:fetchFeatureValues", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "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/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}", + "description": "Gets details of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.get", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "The name of the operation resource.", + "description": "Required. The name of the FeatureView resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" } }, "path": "v1beta1/{+name}", "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" }, "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`.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations", + "description": "Lists FeatureViews in a given FeatureOnlineStore.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews", "httpMethod": "GET", - "id": "aiplatform.projects.locations.featureGroups.operations.list", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.list", "parameterOrder": [ - "name" + "parent" ], "parameters": { "filter": { - "description": "The standard list filter.", + "description": "Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\" OR update_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --> Any FeatureView which has a label with 'env' as the key.", "location": "query", "type": "string" }, - "name": { - "description": "The name of the operation's parent resource.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+$", - "required": true, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time`", + "location": "query", "type": "string" }, "pageSize": { - "description": "The standard list page size.", + "description": "The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "The standard list page token.", + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureViews", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}", + "httpMethod": "PATCH", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels`", + "format": "google-fieldmask", "location": "query", "type": "string" } }, - "path": "v1beta1/{+name}/operations", + "path": "v1beta1/{+name}", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, "response": { - "$ref": "GoogleLongrunningListOperationsResponse" + "$ref": "GoogleLongrunningOperation" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, - "wait": { - "description": "Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureGroups/{featureGroupsId}/operations/{operationsId}:wait", + "searchNearestEntities": { + "description": "Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:searchNearestEntities", "httpMethod": "POST", - "id": "aiplatform.projects.locations.featureGroups.operations.wait", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.searchNearestEntities", "parameterOrder": [ - "name" + "featureView" ], "parameters": { - "name": { - "description": "The name of the operation resource to wait on.", + "featureView": { + "description": "Required. FeatureView resource format `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}/featureViews/{featureView}`", "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/featureGroups/[^/]+/operations/[^/]+$", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", "required": true, "type": "string" - }, - "timeout": { - "description": "The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.", - "format": "google-duration", - "location": "query", + } + }, + "path": "v1beta1/{+featureView}:searchNearestEntities", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest" + }, + "response": { + "$ref": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "sync": { + "description": "Triggers on-demand sync for the FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}:sync", + "httpMethod": "POST", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.sync", + "parameterOrder": [ + "featureView" + ], + "parameters": { + "featureView": { + "description": "Required. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, "type": "string" } }, - "path": "v1beta1/{+name}:wait", + "path": "v1beta1/{+featureView}:sync", + "request": { + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest" + }, "response": { - "$ref": "GoogleLongrunningOperation" + "$ref": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] } - } - } - } - }, - "featureOnlineStores": { - "resources": { - "featureViews": { + }, "resources": { + "featureViewSyncs": { + "methods": { + "get": { + "description": "Gets details of a single FeatureViewSync.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs/{featureViewSyncsId}", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the FeatureViewSync resource. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+/featureViewSyncs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists FeatureViewSyncs in a given FeatureView.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/featureOnlineStores/{featureOnlineStoresId}/featureViews/{featureViewsId}/featureViewSyncs", + "httpMethod": "GET", + "id": "aiplatform.projects.locations.featureOnlineStores.featureViews.featureViewSyncs.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `>`, `>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time > \\\"2020-01-31T15:30:00.000000Z\\\"` --> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending. Supported fields: * `create_time`", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/featureOnlineStores/[^/]+/featureViews/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/featureViewSyncs", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "operations": { "methods": { "delete": { @@ -5343,12 +6353,11 @@ ], "parameters": { "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .", + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "location": "query", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -5376,7 +6385,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}`", + "description": "Required. The name of the Features to be deleted. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}/features/{feature}` `projects/{project}/locations/{location}/featureGroups/{feature_group}/features/{feature}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, @@ -5401,7 +6410,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "Required. The name of the Feature resource. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+/features/[^/]+$", "required": true, @@ -5453,7 +6462,7 @@ "type": "string" }, "parent": { - "description": "Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", + "description": "Required. The resource name of the Location to list Features. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}` `projects/{project}/locations/{location}/featureGroups/{feature_group}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/featurestores/[^/]+/entityTypes/[^/]+$", "required": true, @@ -10120,7 +11129,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`", + "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, @@ -10148,7 +11157,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`", + "description": "Required. The name of the NotebookExecutionJob resource. Format: `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_jobs}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookExecutionJobs/[^/]+$", "required": true, @@ -10157,10 +11166,10 @@ }, "path": "v1beta1/{+name}:reportEvent", "request": { - "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest" + "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest" }, "response": { - "$ref": "GoogleCloudAiplatformV1beta1ReportRuntimeEventResponse" + "$ref": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" @@ -10294,7 +11303,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels.\"a key\"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName=\"myDisplayName\"` * `labels.myKey=\"myValue\"` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -10462,7 +11471,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the NotebookRuntime resource. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}`", + "description": "Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project}/locations/{location}/notebookRuntimes/{notebook_runtime}` `projects/{project}/locations/{location}/notebookExecutionJobs/{notebook_execution_job}`", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/notebookRuntimes/[^/]+$", "required": true, @@ -10515,7 +11524,7 @@ ], "parameters": { "filter": { - "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED`", + "description": "Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime=\"notebookRuntime123\"` * `displayName=\"myDisplayName\"` and `displayName=~\"myDisplayNameRegex\"` * `notebookRuntimeTemplate=\"notebookRuntimeTemplate321\"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser=\"test@google.com\"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED`", "location": "query", "type": "string" }, @@ -15009,13 +16018,81 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "list": { + "description": "Lists publisher models in Model Garden.", + "flatPath": "v1beta1/publishers/{publishersId}/models", + "httpMethod": "GET", + "id": "aiplatform.publishers.models.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. The standard list filter.", + "location": "query", + "type": "string" + }, + "languageCode": { + "description": "Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. A comma-separated list of fields to order by, sorted in ascending order. Use \"desc\" after a field name for descending.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard list page size.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}`", + "location": "path", + "pattern": "^publishers/[^/]+$", + "required": true, + "type": "string" + }, + "view": { + "description": "Optional. PublisherModel view specifying which fields to read.", + "enum": [ + "PUBLISHER_MODEL_VIEW_UNSPECIFIED", + "PUBLISHER_MODEL_VIEW_BASIC", + "PUBLISHER_MODEL_VIEW_FULL", + "PUBLISHER_MODEL_VERSION_VIEW_BASIC" + ], + "enumDescriptions": [ + "The default / unset value. The API will default to the BASIC view.", + "Include basic metadata about the publisher model, but not the full contents.", + "Include everything.", + "Include: VersionId, ModelVersionExternalName, and SupportedActions." + ], + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/models", + "response": { + "$ref": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } } } }, - "revision": "20230914", + "revision": "20231002", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -16503,6 +17580,28 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata": { + "description": "Details of operations that perform create FeatureGroup.", + "id": "GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureGroup." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1CreateFeatureOnlineStoreOperationMetadata": { + "description": "Details of operations that perform create FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1beta1CreateFeatureOnlineStoreOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureOnlineStore." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CreateFeatureOperationMetadata": { "description": "Details of operations that perform create Feature.", "id": "GoogleCloudAiplatformV1beta1CreateFeatureOperationMetadata", @@ -16515,7 +17614,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1CreateFeatureRequest": { - "description": "Request message for FeaturestoreService.CreateFeature.", + "description": "Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature.", "id": "GoogleCloudAiplatformV1beta1CreateFeatureRequest", "properties": { "feature": { @@ -16523,16 +17622,26 @@ "description": "Required. The Feature to create." }, "featureId": { - "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType .", + "description": "Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup.", "type": "string" }, "parent": { - "description": "Required. The resource name of the EntityType to create a Feature. Format: `projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entity_type}`", "type": "string" } }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CreateFeatureViewOperationMetadata": { + "description": "Details of operations that perform create FeatureView.", + "id": "GoogleCloudAiplatformV1beta1CreateFeatureViewOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureView Create." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CreateFeaturestoreOperationMetadata": { "description": "Details of operations that perform create Featurestore.", "id": "GoogleCloudAiplatformV1beta1CreateFeaturestoreOperationMetadata", @@ -16622,6 +17731,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata": { + "description": "Details of operations that perform create FeatureGroup.", + "id": "GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for Feature." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata": { "description": "Runtime operation information for SolverService.CreateSolver.", "id": "GoogleCloudAiplatformV1beta1CreateSolverOperationMetadata", @@ -17141,6 +18261,39 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1DatasetVersion": { + "description": "Describes the dataset version.", + "id": "GoogleCloudAiplatformV1beta1DatasetVersion", + "properties": { + "bigQueryDatasetName": { + "description": "Output only. Name of the associated BigQuery dataset.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when this DatasetVersion was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the DatasetVersion.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this DatasetVersion was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1DedicatedResources": { "description": "A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration.", "id": "GoogleCloudAiplatformV1beta1DedicatedResources", @@ -19006,6 +20159,67 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureGroup": { + "description": "Vertex AI Feature Group.", + "id": "GoogleCloudAiplatformV1beta1FeatureGroup", + "properties": { + "bigQuery": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery", + "description": "Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source." + }, + "createTime": { + "description": "Output only. Timestamp when this FeatureGroup was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. Description of the FeatureGroup.", + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureGroup was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery": { + "description": "Input source type for BigQuery Tables and Views.", + "id": "GoogleCloudAiplatformV1beta1FeatureGroupBigQuery", + "properties": { + "bigQuerySource": { + "$ref": "GoogleCloudAiplatformV1beta1BigQuerySource", + "description": "Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View." + }, + "entityIdColumns": { + "description": "Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to `entity_id`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly": { "description": "A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending.", "id": "GoogleCloudAiplatformV1beta1FeatureMonitoringStatsAnomaly", @@ -19063,6 +20277,122 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureOnlineStore": { + "description": "Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container.", + "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStore", + "properties": { + "bigtable": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable", + "description": "Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore." + }, + "createTime": { + "description": "Output only. Timestamp when this FeatureOnlineStore was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dedicatedServingEndpoint": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", + "description": "Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint." + }, + "embeddingManagement": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement", + "description": "Optional. The settings for embedding management in FeatureOnlineStore." + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the FeatureOnlineStore. Format: `projects/{project}/locations/{location}/featureOnlineStores/{featureOnlineStore}`", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the featureOnlineStore.", + "enum": [ + "STATE_UNSPECIFIED", + "STABLE", + "UPDATING" + ], + "enumDescriptions": [ + "Default value. This value is unused.", + "State when the featureOnlineStore configuration is not being updated and the fields reflect the current configuration of the featureOnlineStore. The featureOnlineStore is usable in this state.", + "The state of the featureOnlineStore configuration when it is being updated. During an update, the fields reflect either the original configuration or the updated configuration of the featureOnlineStore. The featureOnlineStore is still usable in this state." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureOnlineStore was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable": { + "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable", + "properties": { + "autoScaling": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling", + "description": "Required. Autoscaling config applied to Bigtable Instance." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling": { + "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling", + "properties": { + "cpuUtilizationTarget": { + "description": "Optional. A percentage of the cluster's CPU capacity. Can be from 10% to 80%. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set will default to 50%.", + "format": "int32", + "type": "integer" + }, + "maxNodeCount": { + "description": "Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint": { + "description": "The dedicated serving endpoint for this FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint", + "properties": { + "publicEndpointDomainName": { + "description": "Output only. This field will be populated with the domain name to use for this FeatureOnlineStore", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement": { + "description": "Contains settings for embedding management.", + "id": "GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement", + "properties": { + "enabled": { + "description": "Optional. Immutable. Whether to enable embedding management in this FeatureOnlineStore. It's immutable after creation to ensure the FeatureOnlineStore availability.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FeatureSelector": { "description": "Selector for Features of an EntityType.", "id": "GoogleCloudAiplatformV1beta1FeatureSelector", @@ -19209,6 +20539,211 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FeatureView": { + "description": "FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.", + "id": "GoogleCloudAiplatformV1beta1FeatureView", + "properties": { + "bigQuerySource": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource", + "description": "Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore." + }, + "createTime": { + "description": "Output only. Timestamp when this FeatureView was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "etag": { + "description": "Optional. Used to perform consistent read-modify-write updates. If not set, a blind \"overwrite\" update happens.", + "type": "string" + }, + "featureRegistrySource": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource", + "description": "Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded).\" System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable.", + "type": "object" + }, + "name": { + "description": "Output only. Name of the FeatureView. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}`", + "readOnly": true, + "type": "string" + }, + "syncConfig": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig", + "description": "Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving." + }, + "updateTime": { + "description": "Output only. Timestamp when this FeatureView was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vectorSearchConfig": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", + "description": "Optional. Configuration for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource": { + "id": "GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource", + "properties": { + "entityIdColumns": { + "description": "Required. Columns to construct entity_id / row keys. Start by supporting 1 only.", + "items": { + "type": "string" + }, + "type": "array" + }, + "uri": { + "description": "Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource": { + "description": "A Feature Registry source for features that need to be synced to Online Store.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource", + "properties": { + "featureGroups": { + "description": "Required. List of features that need to be synced to Online Store.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup": { + "description": "Features belonging to a single feature group that will be synced to Online Store.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup", + "properties": { + "featureGroupId": { + "description": "Required. Identifier of the feature group.", + "type": "string" + }, + "featureIds": { + "description": "Required. Identifiers of features under the feature group.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewSync": { + "description": "FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewSync", + "properties": { + "createTime": { + "description": "Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "finalStatus": { + "$ref": "GoogleRpcStatus", + "description": "Output only. Final status of the FeatureViewSync.", + "readOnly": true + }, + "name": { + "description": "Output only. Name of the FeatureViewSync. Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "readOnly": true, + "type": "string" + }, + "runTime": { + "$ref": "GoogleTypeInterval", + "description": "Output only. Time when this FeatureViewSync is finished.", + "readOnly": true + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig": { + "id": "GoogleCloudAiplatformV1beta1FeatureViewSyncConfig", + "properties": { + "cron": { + "description": "Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: \"CRON_TZ=${IANA_TIME_ZONE}\" or \"TZ=${IANA_TIME_ZONE}\". The ${IANA_TIME_ZONE} may only be a valid string from IANA time zone database. For example, \"CRON_TZ=America/New_York 1 * * * *\", or \"TZ=America/New_York 1 * * * *\".", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig": { + "description": "Configuration for vector search.", + "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig", + "properties": { + "bruteForceConfig": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig", + "description": "Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search." + }, + "crowdingColumn": { + "description": "Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute.", + "type": "string" + }, + "distanceMeasureType": { + "description": "Optional. The distance measure used in nearest neighbor search.", + "enum": [ + "DISTANCE_MEASURE_TYPE_UNSPECIFIED", + "SQUARED_L2_DISTANCE", + "COSINE_DISTANCE", + "DOT_PRODUCT_DISTANCE" + ], + "enumDescriptions": [ + "Should not be set.", + "Euclidean (L_2) Distance.", + "Cosine Distance. Defined as 1 - cosine similarity. We strongly suggest using DOT_PRODUCT_DISTANCE + UNIT_L2_NORM instead of COSINE distance. Our algorithms have been more optimized for DOT_PRODUCT distance which, when combined with UNIT_L2_NORM, is mathematically equivalent to COSINE distance and results in the same ranking.", + "Dot Product Distance. Defined as a negative of the dot product." + ], + "type": "string" + }, + "embeddingColumn": { + "description": "Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search.", + "type": "string" + }, + "embeddingDimension": { + "description": "Optional. The number of dimensions of the input embedding.", + "format": "int32", + "type": "integer" + }, + "filterColumns": { + "description": "Optional. Columns of features that're used to filter vector search results.", + "items": { + "type": "string" + }, + "type": "array" + }, + "treeAhConfig": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig", + "description": "Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig": { + "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig": { + "id": "GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig", + "properties": { + "leafNodeEmbeddingCount": { + "description": "Optional. Number of embeddings on each leaf node. The default value is 1000 if not set.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Featurestore": { "description": "Vertex AI Feature Store provides a centralized repository for organizing, storing, and serving ML features. The Featurestore is a top-level container for your features and their values.", "id": "GoogleCloudAiplatformV1beta1Featurestore", @@ -19411,6 +20946,79 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest": { + "description": "Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned.", + "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest", + "properties": { + "format": { + "description": "Specify response data format. If not set, KeyValue format will be used.", + "enum": [ + "FORMAT_UNSPECIFIED", + "KEY_VALUE", + "PROTO_STRUCT" + ], + "enumDescriptions": [ + "Not set. Will be treated as the KeyValue format.", + "Return response data in key-value format.", + "Return response data in proto Struct format." + ], + "type": "string" + }, + "id": { + "description": "Simple ID. The whole string will be used as is to identify Entity to fetch feature values for.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse": { + "description": "Response message for FeatureOnlineStoreService.FetchFeatureValues", + "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse", + "properties": { + "keyValues": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList", + "description": "Feature values in KeyValue format." + }, + "protoStruct": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Feature values in proto Struct format.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList": { + "description": "Response structure in the format of key (feature name) and (feature) value pair.", + "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList", + "properties": { + "features": { + "description": "List of feature names and values.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair": { + "description": "Feature name & value pair.", + "id": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair", + "properties": { + "name": { + "description": "Feature short name.", + "type": "string" + }, + "value": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureValue", + "description": "Feature value." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1FilterSplit": { "description": "Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. ", "id": "GoogleCloudAiplatformV1beta1FilterSplit", @@ -19640,6 +21248,17 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1GenieSource": { + "description": "Contains information about the source of the models generated from Generative AI Studio.", + "id": "GoogleCloudAiplatformV1beta1GenieSource", + "properties": { + "baseModelUri": { + "description": "Required. The public base model URI.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1HyperparameterTuningJob": { "description": "Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification.", "id": "GoogleCloudAiplatformV1beta1HyperparameterTuningJob", @@ -20509,6 +22128,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse": { + "description": "Response message for DatasetService.ListDatasetVersions.", + "id": "GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse", + "properties": { + "datasetVersions": { + "description": "A list of DatasetVersions that matches the specified filter in the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1DatasetVersion" + }, + "type": "array" + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListDatasetsResponse": { "description": "Response message for DatasetService.ListDatasets.", "id": "GoogleCloudAiplatformV1beta1ListDatasetsResponse", @@ -20599,8 +22236,80 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse": { + "description": "Response message for FeatureRegistryService.ListFeatureGroups.", + "id": "GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse", + "properties": { + "featureGroups": { + "description": "The FeatureGroups matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as ListFeatureGroupsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores.", + "id": "GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse", + "properties": { + "featureOnlineStores": { + "description": "The FeatureOnlineStores matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureOnlineStore" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as ListFeatureOnlineStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs.", + "id": "GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse", + "properties": { + "featureViewSyncs": { + "description": "The FeatureViewSyncs matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureViewSync" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as ListFeatureViewSyncsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse": { + "description": "Response message for FeatureOnlineStoreAdminService.ListFeatureViews.", + "id": "GoogleCloudAiplatformV1beta1ListFeatureViewsResponse", + "properties": { + "featureViews": { + "description": "The FeatureViews matching the request.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1FeatureView" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListFeaturesResponse": { - "description": "Response message for FeaturestoreService.ListFeatures.", + "description": "Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures.", "id": "GoogleCloudAiplatformV1beta1ListFeaturesResponse", "properties": { "features": { @@ -20942,6 +22651,24 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse": { + "description": "Response message for ModelGardenService.ListPublisherModels.", + "id": "GoogleCloudAiplatformV1beta1ListPublisherModelsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass to ListPublisherModels.page_token to obtain that page.", + "type": "string" + }, + "publisherModels": { + "description": "List of PublisherModels in the requested page.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1PublisherModel" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse": { "description": "Response message for DatasetService.ListSavedQueries.", "id": "GoogleCloudAiplatformV1beta1ListSavedQueriesResponse", @@ -21181,6 +22908,10 @@ "machineType": { "description": "Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required.", "type": "string" + }, + "tpuTopology": { + "description": "Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: \"2x2x1\").", + "type": "string" } }, "type": "object" @@ -21642,6 +23373,10 @@ "$ref": "GoogleCloudAiplatformV1beta1ExplanationSpec", "description": "The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob." }, + "generatedModelSource": { + "$ref": "GoogleCloudAiplatformV1beta1ModelGeneratedModelSource", + "description": "Optional. Used to specify the source of the Model Garden model or Genie models. Only present for models created or tuned from Model Garden and Genie." + }, "labels": { "additionalProperties": { "type": "string" @@ -22320,6 +24055,32 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1ModelGardenSource": { + "description": "Contains information about the source of the models generated from Model Garden.", + "id": "GoogleCloudAiplatformV1beta1ModelGardenSource", + "properties": { + "publicModelName": { + "description": "Required. The model garden source model resource name.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ModelGeneratedModelSource": { + "description": "Used to specify the source of the Model Garden model or Genie models. Only present for models created or tuned from Model Garden and Genie.", + "id": "GoogleCloudAiplatformV1beta1ModelGeneratedModelSource", + "properties": { + "genieSource": { + "$ref": "GoogleCloudAiplatformV1beta1GenieSource", + "description": "Information about the base model of Genie models." + }, + "modelGardenSource": { + "$ref": "GoogleCloudAiplatformV1beta1ModelGardenSource", + "description": "Source information of Model Garden models." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig": { "id": "GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig", "properties": { @@ -23039,6 +24800,99 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1NearestNeighborQuery": { + "description": "A query to find a number of similar entities.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborQuery", + "properties": { + "embedding": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding", + "description": "Optional. The embedding vector that be used for similar search." + }, + "entityId": { + "description": "Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.", + "type": "string" + }, + "neighborCount": { + "description": "Optional. The number of similar entities to be retrieved from feature view for each query.", + "format": "int32", + "type": "integer" + }, + "parameters": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", + "description": "Optional. Parameters that can be set to tune query on the fly." + }, + "perCrowdingAttributeNeighborCount": { + "description": "Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity.", + "format": "int32", + "type": "integer" + }, + "stringFilters": { + "description": "Optional. The list of string filters.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding": { + "description": "The embedding vector.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding", + "properties": { + "value": { + "description": "Optional. Individual value in the embedding.", + "items": { + "format": "float", + "type": "number" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters": { + "description": "Parameters that can be overrided in each query to tune query latency and recall.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters", + "properties": { + "approximateNeighborCandidates": { + "description": "Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.", + "format": "int32", + "type": "integer" + }, + "leafNodesSearchFraction": { + "description": "Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter": { + "description": "String filter is used to search a subset of the entities by using boolean rules. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue}, deny_tokens = {purple}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter", + "properties": { + "allowTokens": { + "description": "Optional. The allowed tokens.", + "items": { + "type": "string" + }, + "type": "array" + }, + "denyTokens": { + "description": "Optional. The denied tokens.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required. Column names in BigQuery that used as filters.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata": { "description": "Runtime operation metadata with regard to Matching Engine Index.", "id": "GoogleCloudAiplatformV1beta1NearestNeighborSearchOperationMetadata", @@ -23131,6 +24985,40 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1NearestNeighbors": { + "description": "Nearest neighbors for one query.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighbors", + "properties": { + "neighbors": { + "description": "All its neighbors.", + "items": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor": { + "description": "A neighbor of the query vector.", + "id": "GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor", + "properties": { + "distance": { + "description": "The distance between the neighbor and the query vector.", + "format": "double", + "type": "number" + }, + "entityId": { + "description": "The id of the similar entity.", + "type": "string" + }, + "entityKeyValues": { + "$ref": "GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse", + "description": "The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when \"return_full_entity\" is set to true. Otherwise, only the \"entity_id\" and \"distance\" fields are populated." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Neighbor": { "description": "Neighbors for example-based explanations.", "id": "GoogleCloudAiplatformV1beta1Neighbor", @@ -23262,7 +25150,7 @@ "additionalProperties": { "type": "string" }, - "description": "The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime: * \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id. * \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"BigQuery\" or \"Vertex\"; if absent, it should be \"Vertex\". This is to describe the entry service, either BigQuery or Vertex.", + "description": "The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with \"aiplatform.googleapis.com/\" and are immutable. Following system labels exist for NotebookRuntime: * \"aiplatform.googleapis.com/notebook_runtime_gce_instance_id\": output only, its value is the Compute Engine instance id. * \"aiplatform.googleapis.com/colab_enterprise_entry_service\": its value is either \"bigquery\" or \"vertex\"; if absent, it should be \"vertex\". This is to describe the entry service, either BigQuery or Vertex.", "type": "object" }, "name": { @@ -23275,6 +25163,21 @@ "description": "Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from.", "readOnly": true }, + "notebookRuntimeType": { + "description": "Output only. The type of the notebook runtime.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], + "enumDescriptions": [ + "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", + "runtime or template with coustomized configurations from user.", + "runtime or template with system defined configurations." + ], + "readOnly": true, + "type": "string" + }, "proxyUri": { "description": "Output only. The proxy endpoint used to access the NotebookRuntime.", "readOnly": true, @@ -23383,6 +25286,20 @@ "$ref": "GoogleCloudAiplatformV1beta1NetworkSpec", "description": "Optional. Network spec." }, + "notebookRuntimeType": { + "description": "Optional. Immutable. The type of the notebook runtime template.", + "enum": [ + "NOTEBOOK_RUNTIME_TYPE_UNSPECIFIED", + "USER_DEFINED", + "ONE_CLICK" + ], + "enumDescriptions": [ + "Unspecified notebook runtime type, NotebookRuntimeType will default to USER_DEFINED.", + "runtime or template with coustomized configurations from user.", + "runtime or template with system defined configurations." + ], + "type": "string" + }, "serviceAccount": { "description": "The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used.", "type": "string" @@ -23470,11 +25387,11 @@ "type": "string" }, "network": { - "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources is not peered with any network.", + "description": "Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.", "type": "string" }, "reservedIpRanges": { - "description": "Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided ip ranges. Otherwise, the persistent resource will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", + "description": "Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].", "items": { "type": "string" }, @@ -23494,7 +25411,7 @@ }, "resourceRuntimeSpec": { "$ref": "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec", - "description": "Optional. Persistent Resource runtime spec. Used for e.g. Ray cluster configuration." + "description": "Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration." }, "startTime": { "description": "Output only. Time when the PersistentResource for the first time entered the `RUNNING` state.", @@ -23647,7 +25564,7 @@ "readOnly": true }, "templateUri": { - "description": "A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded.", + "description": "A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template.", "type": "string" }, "updateTime": { @@ -24662,18 +26579,18 @@ "id": "GoogleCloudAiplatformV1beta1RaySpec", "properties": { "headNodeResourcePoolId": { - "description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field is not set.", + "description": "Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set.", "type": "string" }, "imageUri": { - "description": "Optional. Default image for user to choose a preferred ML framework(e.g. tensorflow or Pytorch) by choosing from Vertex prebuild images(https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image, Otherwise, use the {@code resource_pool_images} field.", + "description": "Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images} field.", "type": "string" }, "resourcePoolImages": { "additionalProperties": { "type": "string" }, - "description": "Optional. Required if image_uri is not set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }", + "description": "Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { \"ray_head_node_pool\": \"head image\" \"ray_worker_node_pool1\": \"worker image\" \"ray_worker_node_pool2\": \"another worker image\" }", "type": "object" } }, @@ -24924,6 +26841,39 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest": { + "description": "Request message for NotebookInternalService.ReportExecutionEvent.", + "id": "GoogleCloudAiplatformV1beta1ReportExecutionEventRequest", + "properties": { + "eventType": { + "description": "Required. The type of the event.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "ACTIVE", + "DONE", + "FAILED" + ], + "enumDescriptions": [ + "Unspecified.", + "Notebook execution process has started. Expect this message within expected time to provision compute.", + "Notebook execution process is completed. Expect this message within timeout.", + "Notebook execution process has failed. Expect this message within timeout." + ], + "type": "string" + }, + "vmToken": { + "description": "Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse": { + "description": "Response message for NotebookInternalService.ReportExecutionEvent.", + "id": "GoogleCloudAiplatformV1beta1ReportExecutionEventResponse", + "properties": {}, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest": { "description": "LINT.IfChange(report_event_message_types) Request message for NotebookInternalService.ReportRuntimeEvent.", "id": "GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest", @@ -24968,7 +26918,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ResourcePool": { - "description": "Represents the spec a group of resources of same type, e.g. machine, disk and accelerators, in a PersistentResource.", + "description": "Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource.", "id": "GoogleCloudAiplatformV1beta1ResourcePool", "properties": { "autoscalingSpec": { @@ -24980,7 +26930,7 @@ "description": "Optional. Disk spec for the machine in this node pool." }, "id": { - "description": "Immutable. The unique ID in a PersistentResource to refer the this resource pool. User can specify it if need to use it, otherwise we will generate it automatically.", + "description": "Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically.", "type": "string" }, "machineSpec": { @@ -25039,7 +26989,7 @@ "type": "object" }, "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec": { - "description": "Configure runtime on a PersistentResource instance, including but may not limited to: * Service accounts used to run the workloads; * Whether make it a dedicated Ray Cluster;", + "description": "Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster.", "id": "GoogleCloudAiplatformV1beta1ResourceRuntimeSpec", "properties": { "raySpec": { @@ -29103,16 +31053,42 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest": { + "description": "The request message for FeatureOnlineStoreService.SearchNearestEntities.", + "id": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest", + "properties": { + "query": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighborQuery", + "description": "Required. The query." + }, + "returnFullEntity": { + "description": "Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse": { + "description": "Response message for FeatureOnlineStoreService.SearchNearestEntities", + "id": "GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse", + "properties": { + "nearestNeighbors": { + "$ref": "GoogleCloudAiplatformV1beta1NearestNeighbors", + "description": "The nearest neighbors of the query entity." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1ServiceAccountSpec": { "description": "Configuration for the use of custom service account to run the workloads.", "id": "GoogleCloudAiplatformV1beta1ServiceAccountSpec", "properties": { "enableCustomServiceAccount": { - "description": "Required. If true, custom user-managed service account is enforced to run any workloads (e.g. Vertex Jobs) on the resource; Otherwise, will always use [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents)", + "description": "Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents).", "type": "boolean" }, "serviceAccount": { - "description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, e.g. Ray; * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers specified in `ResourceRuntimeSpec`.", + "description": "Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`.", "type": "string" } }, @@ -29864,6 +31840,23 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest": { + "description": "Request message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse": { + "description": "Respose message for FeatureOnlineStoreAdminService.SyncFeatureView.", + "id": "GoogleCloudAiplatformV1beta1SyncFeatureViewResponse", + "properties": { + "featureViewSync": { + "description": "Format: `projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}/featureViewSyncs/{feature_view_sync}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1TFRecordDestination": { "description": "The storage details for TFRecord output content.", "id": "GoogleCloudAiplatformV1beta1TFRecordDestination", @@ -30791,6 +32784,50 @@ "properties": {}, "type": "object" }, + "GoogleCloudAiplatformV1beta1UpdateFeatureGroupOperationMetadata": { + "description": "Details of operations that perform update FeatureGroup.", + "id": "GoogleCloudAiplatformV1beta1UpdateFeatureGroupOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureGroup." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UpdateFeatureOnlineStoreOperationMetadata": { + "description": "Details of operations that perform update FeatureOnlineStore.", + "id": "GoogleCloudAiplatformV1beta1UpdateFeatureOnlineStoreOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureOnlineStore." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UpdateFeatureOperationMetadata": { + "description": "Details of operations that perform update Feature.", + "id": "GoogleCloudAiplatformV1beta1UpdateFeatureOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for Feature Update." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1UpdateFeatureViewOperationMetadata": { + "description": "Details of operations that perform update FeatureView.", + "id": "GoogleCloudAiplatformV1beta1UpdateFeatureViewOperationMetadata", + "properties": { + "genericMetadata": { + "$ref": "GoogleCloudAiplatformV1beta1GenericOperationMetadata", + "description": "Operation metadata for FeatureView Update." + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1UpdateFeaturestoreOperationMetadata": { "description": "Details of operations that perform update Featurestore.", "id": "GoogleCloudAiplatformV1beta1UpdateFeaturestoreOperationMetadata", diff --git a/discovery/alloydb-v1.json b/discovery/alloydb-v1.json index 7f7069a67a..cf38dfd786 100644 --- a/discovery/alloydb-v1.json +++ b/discovery/alloydb-v1.json @@ -517,6 +517,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "generateClientCertificate": { + "description": "Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:generateClientCertificate", + "httpMethod": "POST", + "id": "alloydb.projects.locations.clusters.generateClientCertificate", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource. The required format is: * projects/{project}/locations/{location}/clusters/{cluster}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}:generateClientCertificate", + "request": { + "$ref": "GenerateClientCertificateRequest" + }, + "response": { + "$ref": "GenerateClientCertificateResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets details of a single Cluster.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", @@ -906,6 +934,36 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getConnectionInfo": { + "description": "Get instance metadata used for a connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}/connectionInfo", + "httpMethod": "GET", + "id": "alloydb.projects.locations.clusters.instances.getConnectionInfo", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent resource. The required format is: projects/{project}/locations/{location}/clusters/{cluster}/instances/{instance}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/connectionInfo", + "response": { + "$ref": "ConnectionInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "injectFault": { "description": "Injects fault in an instance. Imperative only.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/instances/{instancesId}:injectFault", @@ -1431,7 +1489,7 @@ } } }, - "revision": "20230821", + "revision": "20230918", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AutomatedBackupPolicy": { @@ -1816,7 +1874,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -1884,6 +1942,27 @@ }, "type": "object" }, + "ConnectionInfo": { + "description": "ConnectionInfo singleton resource. https://google.aip.dev/156", + "id": "ConnectionInfo", + "properties": { + "instanceUid": { + "description": "Output only. The unique ID of the Instance.", + "readOnly": true, + "type": "string" + }, + "ipAddress": { + "description": "Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "The name of the ConnectionInfo singleton resource, e.g.: projects/{project}/locations/{location}/clusters/*/instances/*/connectionInfo This field currently has no semantic meaning.", + "type": "string" + } + }, + "type": "object" + }, "ContinuousBackupConfig": { "description": "ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster.", "id": "ContinuousBackupConfig", @@ -2034,6 +2113,45 @@ }, "type": "object" }, + "GenerateClientCertificateRequest": { + "description": "Message for requests to generate a client certificate signed by the Cluster CA.", + "id": "GenerateClientCertificateRequest", + "properties": { + "certDuration": { + "description": "Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration.", + "format": "google-duration", + "type": "string" + }, + "publicKey": { + "description": "Optional. The public key from the client.", + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "GenerateClientCertificateResponse": { + "description": "Message returned by a GenerateClientCertificate operation.", + "id": "GenerateClientCertificateResponse", + "properties": { + "caCert": { + "description": "Optional. The pem-encoded cluster ca X.509 certificate.", + "type": "string" + }, + "pemCertificateChain": { + "description": "Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudLocationListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "GoogleCloudLocationListLocationsResponse", @@ -2508,7 +2626,7 @@ "type": "string" }, "network": { - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", "type": "string" } }, @@ -2890,6 +3008,10 @@ "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "description": "Backup retention settings." + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", + "type": "boolean" } }, "type": "object" @@ -2929,6 +3051,21 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainCompliance": { + "description": "Contains compliance information about a security standard indicating unmet recommendations.", + "id": "StorageDatabasecenterPartnerapiV1mainCompliance", + "properties": { + "standard": { + "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", + "type": "string" + }, + "version": { + "description": "Version of the standard or benchmark, for example, 1.1", + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -2944,23 +3081,134 @@ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", "OBSERVABILITY_DATA", - "COMPLIANCE_DATA" + "SECURITY_FINDING_DATA" ], "enumDescriptions": [ "", "Database resource metadata feed from control plane", "Database resource monitoring data", - "Database resource compliance feed" + "Database resource security health signal data" ], "type": "string" }, + "resourceHealthSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "description": "More feed data would be added in subsequent CLs" + }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Primary key associated with the Resource" }, "resourceMetadata": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", - "description": "More feed data would be added in subsequent CLs" + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { + "description": "Common model for database resource health signal data.", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any other additional metadata", + "type": "object" + }, + "compliance": { + "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", + "items": { + "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" + }, + "type": "array" + }, + "description": { + "description": "Description associated with signal", + "type": "string" + }, + "eventTime": { + "description": "The last time at which the event described by this signal took place", + "format": "google-datetime", + "type": "string" + }, + "externalUri": { + "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", + "type": "string" + }, + "name": { + "description": "The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", + "type": "string" + }, + "provider": { + "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "resourceContainer": { + "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", + "type": "string" + }, + "resourceName": { + "description": "Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalClass": { + "description": "The class of the signal, such as if it's a THREAT or VULNERABILITY.", + "enum": [ + "CLASS_UNSPECIFIED", + "THREAT", + "VULNERABILITY", + "MISCONFIGURATION", + "OBSERVATION", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified signal class.", + "Describes unwanted or malicious activity.", + "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", + "Describes a potential weakness in cloud resource/asset configuration that increases risk.", + "Describes a security observation that is for informational purposes.", + "Describes an error that prevents some SCC functionality." + ], + "type": "string" + }, + "signalId": { + "description": "Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "MUTED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The signal requires attention and has not been addressed yet.", + "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", + "The signal has been muted." + ], + "type": "string" } }, "type": "object" @@ -2985,14 +3233,18 @@ "Google cloud platform provider", "Amazon web service", "Azure web service", - "On-prem database provider", - "Self-managed database provider", - "For rest of the other category" + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." ], "type": "string" }, + "providerDescription": { + "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", + "type": "string" + }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED", + "description": "Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -3029,28 +3281,44 @@ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" }, + "customMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any custom metadata associated with the resource (a JSON field)", + "type": "object" + }, "expectedState": { - "description": "The actual instance state.", + "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" @@ -3081,18 +3349,18 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform." + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." }, "resourceContainer": { - "description": "Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: \"projects/123\".", + "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", "type": "string" }, "resourceName": { - "description": "Required. Different from unique_id, a resource name can be reused over time. That is after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source.", + "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "updationTime": { diff --git a/discovery/alloydb-v1alpha.json b/discovery/alloydb-v1alpha.json index 63ac9ce384..4a86dae7dd 100644 --- a/discovery/alloydb-v1alpha.json +++ b/discovery/alloydb-v1alpha.json @@ -1489,7 +1489,7 @@ } } }, - "revision": "20230821", + "revision": "20230918", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AutomatedBackupPolicy": { @@ -1884,7 +1884,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -2147,7 +2147,7 @@ }, "pemCsr": { "deprecated": true, - "description": "Optional. A pem-encoded X.509 certificate signing request (CSR).", + "description": "Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead.", "type": "string" }, "publicKey": { @@ -2174,6 +2174,7 @@ "type": "string" }, "pemCertificate": { + "deprecated": true, "description": "Output only. The pem-encoded, signed X.509 certificate.", "readOnly": true, "type": "string" @@ -2671,7 +2672,7 @@ "type": "string" }, "network": { - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", "type": "string" } }, @@ -3053,6 +3054,10 @@ "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "description": "Backup retention settings." + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", + "type": "boolean" } }, "type": "object" @@ -3092,6 +3097,21 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainCompliance": { + "description": "Contains compliance information about a security standard indicating unmet recommendations.", + "id": "StorageDatabasecenterPartnerapiV1mainCompliance", + "properties": { + "standard": { + "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", + "type": "string" + }, + "version": { + "description": "Version of the standard or benchmark, for example, 1.1", + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3107,23 +3127,134 @@ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", "OBSERVABILITY_DATA", - "COMPLIANCE_DATA" + "SECURITY_FINDING_DATA" ], "enumDescriptions": [ "", "Database resource metadata feed from control plane", "Database resource monitoring data", - "Database resource compliance feed" + "Database resource security health signal data" ], "type": "string" }, + "resourceHealthSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "description": "More feed data would be added in subsequent CLs" + }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Primary key associated with the Resource" }, "resourceMetadata": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", - "description": "More feed data would be added in subsequent CLs" + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { + "description": "Common model for database resource health signal data.", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any other additional metadata", + "type": "object" + }, + "compliance": { + "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", + "items": { + "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" + }, + "type": "array" + }, + "description": { + "description": "Description associated with signal", + "type": "string" + }, + "eventTime": { + "description": "The last time at which the event described by this signal took place", + "format": "google-datetime", + "type": "string" + }, + "externalUri": { + "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", + "type": "string" + }, + "name": { + "description": "The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", + "type": "string" + }, + "provider": { + "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "resourceContainer": { + "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", + "type": "string" + }, + "resourceName": { + "description": "Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalClass": { + "description": "The class of the signal, such as if it's a THREAT or VULNERABILITY.", + "enum": [ + "CLASS_UNSPECIFIED", + "THREAT", + "VULNERABILITY", + "MISCONFIGURATION", + "OBSERVATION", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified signal class.", + "Describes unwanted or malicious activity.", + "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", + "Describes a potential weakness in cloud resource/asset configuration that increases risk.", + "Describes a security observation that is for informational purposes.", + "Describes an error that prevents some SCC functionality." + ], + "type": "string" + }, + "signalId": { + "description": "Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "MUTED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The signal requires attention and has not been addressed yet.", + "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", + "The signal has been muted." + ], + "type": "string" } }, "type": "object" @@ -3148,14 +3279,18 @@ "Google cloud platform provider", "Amazon web service", "Azure web service", - "On-prem database provider", - "Self-managed database provider", - "For rest of the other category" + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." ], "type": "string" }, + "providerDescription": { + "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", + "type": "string" + }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED", + "description": "Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -3192,28 +3327,44 @@ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" }, + "customMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any custom metadata associated with the resource (a JSON field)", + "type": "object" + }, "expectedState": { - "description": "The actual instance state.", + "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" @@ -3244,18 +3395,18 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform." + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." }, "resourceContainer": { - "description": "Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: \"projects/123\".", + "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", "type": "string" }, "resourceName": { - "description": "Required. Different from unique_id, a resource name can be reused over time. That is after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source.", + "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "updationTime": { diff --git a/discovery/alloydb-v1beta.json b/discovery/alloydb-v1beta.json index 31af0ce468..937fdc02fb 100644 --- a/discovery/alloydb-v1beta.json +++ b/discovery/alloydb-v1beta.json @@ -1486,7 +1486,7 @@ } } }, - "revision": "20230821", + "revision": "20230918", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AutomatedBackupPolicy": { @@ -1871,7 +1871,7 @@ }, "network": { "deprecated": true, - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project}/global/networks/{network_id}\". This is required to create a cluster. Deprecated, use network_config.network instead.", "type": "string" }, "networkConfig": { @@ -2130,7 +2130,7 @@ }, "pemCsr": { "deprecated": true, - "description": "Optional. A pem-encoded X.509 certificate signing request (CSR).", + "description": "Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead.", "type": "string" }, "publicKey": { @@ -2157,6 +2157,7 @@ "type": "string" }, "pemCertificate": { + "deprecated": true, "description": "Output only. The pem-encoded, signed X.509 certificate.", "readOnly": true, "type": "string" @@ -2650,7 +2651,7 @@ "type": "string" }, "network": { - "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster. It can be updated, but it cannot be removed.", + "description": "Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: \"projects/{project_number}/global/networks/{network_id}\". This is required to create a cluster.", "type": "string" } }, @@ -3032,6 +3033,10 @@ "backupRetentionSettings": { "$ref": "StorageDatabasecenterPartnerapiV1mainRetentionSettings", "description": "Backup retention settings." + }, + "pointInTimeRecoveryEnabled": { + "description": "Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted.", + "type": "boolean" } }, "type": "object" @@ -3071,6 +3076,21 @@ }, "type": "object" }, + "StorageDatabasecenterPartnerapiV1mainCompliance": { + "description": "Contains compliance information about a security standard indicating unmet recommendations.", + "id": "StorageDatabasecenterPartnerapiV1mainCompliance", + "properties": { + "standard": { + "description": "Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP.", + "type": "string" + }, + "version": { + "description": "Version of the standard or benchmark, for example, 1.1", + "type": "string" + } + }, + "type": "object" + }, "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed": { "description": "DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform.", "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceFeed", @@ -3086,23 +3106,134 @@ "FEEDTYPE_UNSPECIFIED", "RESOURCE_METADATA", "OBSERVABILITY_DATA", - "COMPLIANCE_DATA" + "SECURITY_FINDING_DATA" ], "enumDescriptions": [ "", "Database resource metadata feed from control plane", "Database resource monitoring data", - "Database resource compliance feed" + "Database resource security health signal data" ], "type": "string" }, + "resourceHealthSignalData": { + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "description": "More feed data would be added in subsequent CLs" + }, "resourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", "description": "Required. Primary key associated with the Resource" }, "resourceMetadata": { - "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata", - "description": "More feed data would be added in subsequent CLs" + "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata" + } + }, + "type": "object" + }, + "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData": { + "description": "Common model for database resource health signal data.", + "id": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData", + "properties": { + "additionalMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any other additional metadata", + "type": "object" + }, + "compliance": { + "description": "Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards.", + "items": { + "$ref": "StorageDatabasecenterPartnerapiV1mainCompliance" + }, + "type": "array" + }, + "description": { + "description": "Description associated with signal", + "type": "string" + }, + "eventTime": { + "description": "The last time at which the event described by this signal took place", + "format": "google-datetime", + "type": "string" + }, + "externalUri": { + "description": "The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals.", + "type": "string" + }, + "name": { + "description": "The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc.", + "type": "string" + }, + "provider": { + "description": "Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged", + "enum": [ + "PROVIDER_UNSPECIFIED", + "GCP", + "AWS", + "AZURE", + "ONPREM", + "SELFMANAGED", + "PROVIDER_OTHER" + ], + "enumDescriptions": [ + "", + "Google cloud platform provider", + "Amazon web service", + "Azure web service", + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." + ], + "type": "string" + }, + "resourceContainer": { + "description": "Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", + "type": "string" + }, + "resourceName": { + "description": "Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", + "type": "string" + }, + "signalClass": { + "description": "The class of the signal, such as if it's a THREAT or VULNERABILITY.", + "enum": [ + "CLASS_UNSPECIFIED", + "THREAT", + "VULNERABILITY", + "MISCONFIGURATION", + "OBSERVATION", + "ERROR" + ], + "enumDescriptions": [ + "Unspecified signal class.", + "Describes unwanted or malicious activity.", + "Describes a potential weakness in software that increases risk to Confidentiality & Integrity & Availability.", + "Describes a potential weakness in cloud resource/asset configuration that increases risk.", + "Describes a security observation that is for informational purposes.", + "Describes an error that prevents some SCC functionality." + ], + "type": "string" + }, + "signalId": { + "description": "Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal.", + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "RESOLVED", + "MUTED" + ], + "enumDescriptions": [ + "Unspecified state.", + "The signal requires attention and has not been addressed yet.", + "The signal has been fixed, triaged as a non-issue or otherwise addressed and is no longer active.", + "The signal has been muted." + ], + "type": "string" } }, "type": "object" @@ -3127,14 +3258,18 @@ "Google cloud platform provider", "Amazon web service", "Azure web service", - "On-prem database provider", - "Self-managed database provider", - "For rest of the other category" + "On-prem database resources.", + "Self-managed database provider. These are resources on a cloud platform, e.g., database resource installed in a GCE VM, but not a managed database service.", + "For the rest of the other categories. Other refers to the rest of other database service providers, this could be smaller cloud provider. This needs to be provided when the provider is known, but it is not present in the existing set of enum values." ], "type": "string" }, + "providerDescription": { + "description": "Optional. Needs to be used only when the provider is PROVIDER_OTHER.", + "type": "string" + }, "resourceType": { - "description": "Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED", + "description": "Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel", "type": "string" }, "uniqueId": { @@ -3171,28 +3306,44 @@ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" }, + "customMetadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Any custom metadata associated with the resource (a JSON field)", + "type": "object" + }, "expectedState": { - "description": "The actual instance state.", + "description": "The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY.", "enum": [ "STATE_UNSPECIFIED", "HEALTHY", "UNHEALTHY", + "SUSPENDED", + "DELETED", "STATE_OTHER" ], "enumDescriptions": [ "", "The instance is running.", "Instance being created, updated, deleted or under maintenance", + "When instance is suspended", + "Instance is deleted.", "For rest of the other category" ], "type": "string" @@ -3223,18 +3374,18 @@ }, "primaryResourceId": { "$ref": "StorageDatabasecenterPartnerapiV1mainDatabaseResourceId", - "description": "Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform." + "description": "Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested" }, "product": { "$ref": "StorageDatabasecenterProtoCommonProduct", "description": "The product this resource represents." }, "resourceContainer": { - "description": "Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: \"projects/123\".", + "description": "Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of \"provider//\", such as \"gcp/projects/123\".", "type": "string" }, "resourceName": { - "description": "Required. Different from unique_id, a resource name can be reused over time. That is after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source.", + "description": "Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named \"ABC\" is deleted, the name \"ABC\" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel", "type": "string" }, "updationTime": { diff --git a/discovery/analyticsadmin-v1alpha.json b/discovery/analyticsadmin-v1alpha.json index 3eabc6dce4..75d226de20 100644 --- a/discovery/analyticsadmin-v1alpha.json +++ b/discovery/analyticsadmin-v1alpha.json @@ -149,7 +149,7 @@ "accounts": { "methods": { "delete": { - "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", + "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", "flatPath": "v1alpha/accounts/{accountsId}", "httpMethod": "DELETE", "id": "analyticsadmin.accounts.delete", @@ -632,304 +632,6 @@ ] } } - }, - "userLinks": { - "methods": { - "audit": { - "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks:audit", - "httpMethod": "POST", - "id": "analyticsadmin.accounts.userLinks.audit", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks:audit", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "batchCreate": { - "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchCreate", - "httpMethod": "POST", - "id": "analyticsadmin.accounts.userLinks.batchCreate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks:batchCreate", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "batchDelete": { - "description": "Deletes information about multiple users' links to an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchDelete", - "httpMethod": "POST", - "id": "analyticsadmin.accounts.userLinks.batchDelete", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks:batchDelete", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "batchGet": { - "description": "Gets information about multiple users' links to an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchGet", - "httpMethod": "GET", - "id": "analyticsadmin.accounts.userLinks.batchGet", - "parameterOrder": [ - "parent" - ], - "parameters": { - "names": { - "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", - "location": "query", - "repeated": true, - "type": "string" - }, - "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks:batchGet", - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "batchUpdate": { - "description": "Updates information about multiple users' links to an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks:batchUpdate", - "httpMethod": "POST", - "id": "analyticsadmin.accounts.userLinks.batchUpdate", - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks:batchUpdate", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "create": { - "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks", - "httpMethod": "POST", - "id": "analyticsadmin.accounts.userLinks.create", - "parameterOrder": [ - "parent" - ], - "parameters": { - "notifyNewUser": { - "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", - "location": "query", - "type": "boolean" - }, - "parent": { - "description": "Required. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "delete": { - "description": "Deletes a user link on an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", - "httpMethod": "DELETE", - "id": "analyticsadmin.accounts.userLinks.delete", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Example format: accounts/1234/userLinks/5678", - "location": "path", - "pattern": "^accounts/[^/]+/userLinks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - }, - "get": { - "description": "Gets information about a user's link to an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", - "httpMethod": "GET", - "id": "analyticsadmin.accounts.userLinks.get", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. Example format: accounts/1234/userLinks/5678", - "location": "path", - "pattern": "^accounts/[^/]+/userLinks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "list": { - "description": "Lists all user links on an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks", - "httpMethod": "GET", - "id": "analyticsadmin.accounts.userLinks.list", - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageSize": { - "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", - "format": "int32", - "location": "query", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", - "location": "query", - "type": "string" - }, - "parent": { - "description": "Required. Example format: accounts/1234", - "location": "path", - "pattern": "^accounts/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+parent}/userLinks", - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" - ] - }, - "patch": { - "description": "Updates a user link on an account or property.", - "flatPath": "v1alpha/accounts/{accountsId}/userLinks/{userLinksId}", - "httpMethod": "PATCH", - "id": "analyticsadmin.accounts.userLinks.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. Example format: properties/1234/userLinks/5678", - "location": "path", - "pattern": "^accounts/[^/]+/userLinks/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" - ] - } - } } } }, @@ -999,8 +701,44 @@ "https://www.googleapis.com/auth/analytics.edit" ] }, + "createRollupProperty": { + "description": "Create a roll-up property and all roll-up property source links.", + "flatPath": "v1alpha/properties:createRollupProperty", + "httpMethod": "POST", + "id": "analyticsadmin.properties.createRollupProperty", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/properties:createRollupProperty", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "createSubproperty": { + "description": "Create a subproperty and a subproperty event filter that applies to the created subproperty.", + "flatPath": "v1alpha/properties:createSubproperty", + "httpMethod": "POST", + "id": "analyticsadmin.properties.createSubproperty", + "parameterOrder": [], + "parameters": {}, + "path": "v1alpha/properties:createSubproperty", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, "delete": { - "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.", + "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.", "flatPath": "v1alpha/properties/{propertiesId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.delete", @@ -2740,6 +2478,32 @@ "https://www.googleapis.com/auth/analytics.readonly" ] }, + "getDataRedactionSettings": { + "description": "Lookup for a single DataRedactionSettings.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/dataRedactionSettings", + "httpMethod": "GET", + "id": "analyticsadmin.properties.dataStreams.getDataRedactionSettings", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the settings to lookup. Format: properties/{property}/dataStreams/{data_stream}/dataRedactionSettings Example: \"properties/1000/dataStreams/2000/dataRedactionSettings\"", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/dataRedactionSettings$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaDataRedactionSettings" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" + ] + }, "getEnhancedMeasurementSettings": { "description": "Returns the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect.", "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/enhancedMeasurementSettings", @@ -2833,20 +2597,54 @@ "description": "Updates a DataStream on a property.", "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}", "httpMethod": "PATCH", - "id": "analyticsadmin.properties.dataStreams.patch", + "id": "analyticsadmin.properties.dataStreams.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", + "location": "path", + "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "request": { + "$ref": "GoogleAnalyticsAdminV1alphaDataStream" + }, + "response": { + "$ref": "GoogleAnalyticsAdminV1alphaDataStream" + }, + "scopes": [ + "https://www.googleapis.com/auth/analytics.edit" + ] + }, + "updateDataRedactionSettings": { + "description": "Updates a DataRedactionSettings on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/dataStreams/{dataStreamsId}/dataRedactionSettings", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.dataStreams.updateDataRedactionSettings", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. Resource name of this Data Stream. Format: properties/{property_id}/dataStreams/{stream_id} Example: \"properties/1000/dataStreams/2000\"", + "description": "Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: \"properties/1000/dataStreams/2000/dataRedactionSettings\"", "location": "path", - "pattern": "^properties/[^/]+/dataStreams/[^/]+$", + "pattern": "^properties/[^/]+/dataStreams/[^/]+/dataRedactionSettings$", "required": true, "type": "string" }, "updateMask": { - "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "description": "Required. The list of fields to be updated. Field names must be in snake case (e.g., \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -2854,10 +2652,10 @@ }, "path": "v1alpha/{+name}", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaDataStream" + "$ref": "GoogleAnalyticsAdminV1alphaDataRedactionSettings" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaDataStream" + "$ref": "GoogleAnalyticsAdminV1alphaDataRedactionSettings" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" @@ -4069,49 +3867,49 @@ } } }, - "searchAds360Links": { + "rollupPropertySourceLinks": { "methods": { "create": { - "description": "Creates a SearchAds360Link.", - "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links", + "description": "Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.", + "flatPath": "v1alpha/properties/{propertiesId}/rollupPropertySourceLinks", "httpMethod": "POST", - "id": "analyticsadmin.properties.searchAds360Links.create", + "id": "analyticsadmin.properties.rollupPropertySourceLinks.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. Example format: properties/1234", + "description": "Required. Format: properties/{property_id} Example: properties/1234", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/searchAds360Links", + "path": "v1alpha/{+parent}/rollupPropertySourceLinks", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" + "$ref": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" + "$ref": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit" ] }, "delete": { - "description": "Deletes a SearchAds360Link on a property.", - "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", + "description": "Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.", + "flatPath": "v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}", "httpMethod": "DELETE", - "id": "analyticsadmin.properties.searchAds360Links.delete", + "id": "analyticsadmin.properties.rollupPropertySourceLinks.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678", + "description": "Required. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/1234/rollupPropertySourceLinks/5678", "location": "path", - "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", + "pattern": "^properties/[^/]+/rollupPropertySourceLinks/[^/]+$", "required": true, "type": "string" } @@ -4125,25 +3923,25 @@ ] }, "get": { - "description": "Look up a single SearchAds360Link", - "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", + "description": "Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.", + "flatPath": "v1alpha/properties/{propertiesId}/rollupPropertySourceLinks/{rollupPropertySourceLinksId}", "httpMethod": "GET", - "id": "analyticsadmin.properties.searchAds360Links.get", + "id": "analyticsadmin.properties.rollupPropertySourceLinks.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678", + "description": "Required. The name of the roll-up property source link to lookup. Format: properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link_id} Example: properties/123/rollupPropertySourceLinks/456", "location": "path", - "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", + "pattern": "^properties/[^/]+/rollupPropertySourceLinks/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" + "$ref": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", @@ -4151,271 +3949,241 @@ ] }, "list": { - "description": "Lists all SearchAds360Links on a property.", - "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links", + "description": "Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties.", + "flatPath": "v1alpha/properties/{propertiesId}/rollupPropertySourceLinks", "httpMethod": "GET", - "id": "analyticsadmin.properties.searchAds360Links.list", + "id": "analyticsadmin.properties.rollupPropertySourceLinks.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { - "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", + "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token.", + "description": "Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Example format: properties/1234", + "description": "Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id} Example: properties/1234", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/searchAds360Links", + "path": "v1alpha/{+parent}/rollupPropertySourceLinks", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse" + "$ref": "GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse" }, "scopes": [ "https://www.googleapis.com/auth/analytics.edit", "https://www.googleapis.com/auth/analytics.readonly" ] - }, - "patch": { - "description": "Updates a SearchAds360Link on a property.", - "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", - "httpMethod": "PATCH", - "id": "analyticsadmin.properties.searchAds360Links.patch", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", - "location": "path", - "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", - "format": "google-fieldmask", - "location": "query", - "type": "string" - } - }, - "path": "v1alpha/{+name}", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" - }, - "response": { - "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" - }, - "scopes": [ - "https://www.googleapis.com/auth/analytics.edit" - ] } } }, - "userLinks": { + "searchAds360Links": { "methods": { - "audit": { - "description": "Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks:audit", + "create": { + "description": "Creates a SearchAds360Link.", + "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links", "httpMethod": "POST", - "id": "analyticsadmin.properties.userLinks.audit", + "id": "analyticsadmin.properties.searchAds360Links.create", "parameterOrder": [ "parent" ], "parameters": { "parent": { - "description": "Required. Example format: accounts/1234", + "description": "Required. Example format: properties/1234", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks:audit", + "path": "v1alpha/{+parent}/searchAds360Links", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest" + "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse" + "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" + "https://www.googleapis.com/auth/analytics.edit" ] }, - "batchCreate": { - "description": "Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchCreate", - "httpMethod": "POST", - "id": "analyticsadmin.properties.userLinks.batchCreate", + "delete": { + "description": "Deletes a SearchAds360Link on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", + "httpMethod": "DELETE", + "id": "analyticsadmin.properties.searchAds360Links.delete", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "name": { + "description": "Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678", "location": "path", - "pattern": "^properties/[^/]+$", + "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks:batchCreate", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest" - }, + "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse" + "$ref": "GoogleProtobufEmpty" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit" ] }, - "batchDelete": { - "description": "Deletes information about multiple users' links to an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchDelete", - "httpMethod": "POST", - "id": "analyticsadmin.properties.userLinks.batchDelete", + "get": { + "description": "Look up a single SearchAds360Link", + "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", + "httpMethod": "GET", + "id": "analyticsadmin.properties.searchAds360Links.get", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234", + "name": { + "description": "Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678", "location": "path", - "pattern": "^properties/[^/]+$", + "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks:batchDelete", - "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest" - }, + "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" ] }, - "batchGet": { - "description": "Gets information about multiple users' links to an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchGet", + "list": { + "description": "Lists all SearchAds360Links on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links", "httpMethod": "GET", - "id": "analyticsadmin.properties.userLinks.batchGet", + "id": "analyticsadmin.properties.searchAds360Links.list", "parameterOrder": [ "parent" ], "parameters": { - "names": { - "description": "Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId}/userLinks/{userLinkId}", + "pageSize": { + "description": "The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token.", "location": "query", - "repeated": true, "type": "string" }, "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234", + "description": "Required. Example format: properties/1234", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks:batchGet", + "path": "v1alpha/{+parent}/searchAds360Links", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse" + "$ref": "GoogleAnalyticsAdminV1alphaListSearchAds360LinksResponse" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" ] }, - "batchUpdate": { - "description": "Updates information about multiple users' links to an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks:batchUpdate", - "httpMethod": "POST", - "id": "analyticsadmin.properties.userLinks.batchUpdate", + "patch": { + "description": "Updates a SearchAds360Link on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/searchAds360Links/{searchAds360LinksId}", + "httpMethod": "PATCH", + "id": "analyticsadmin.properties.searchAds360Links.patch", "parameterOrder": [ - "parent" + "name" ], "parameters": { - "parent": { - "description": "Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234", + "name": { + "description": "Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId}/searchAds360Links/{linkId} Note: linkId is not the Search Ads 360 advertiser ID", "location": "path", - "pattern": "^properties/[^/]+$", + "pattern": "^properties/[^/]+/searchAds360Links/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks:batchUpdate", + "path": "v1alpha/{+name}", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest" + "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse" + "$ref": "GoogleAnalyticsAdminV1alphaSearchAds360Link" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit" ] - }, + } + } + }, + "subpropertyEventFilters": { + "methods": { "create": { - "description": "Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks", + "description": "Creates a subproperty Event Filter.", + "flatPath": "v1alpha/properties/{propertiesId}/subpropertyEventFilters", "httpMethod": "POST", - "id": "analyticsadmin.properties.userLinks.create", + "id": "analyticsadmin.properties.subpropertyEventFilters.create", "parameterOrder": [ "parent" ], "parameters": { - "notifyNewUser": { - "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", - "location": "query", - "type": "boolean" - }, "parent": { - "description": "Required. Example format: accounts/1234", + "description": "Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks", + "path": "v1alpha/{+parent}/subpropertyEventFilters", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit" ] }, "delete": { - "description": "Deletes a user link on an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", + "description": "Deletes a subproperty event filter.", + "flatPath": "v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}", "httpMethod": "DELETE", - "id": "analyticsadmin.properties.userLinks.delete", + "id": "analyticsadmin.properties.subpropertyEventFilters.delete", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Example format: accounts/1234/userLinks/5678", + "description": "Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456", "location": "path", - "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "pattern": "^properties/[^/]+/subpropertyEventFilters/[^/]+$", "required": true, "type": "string" } @@ -4425,98 +4193,104 @@ "$ref": "GoogleProtobufEmpty" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit" ] }, "get": { - "description": "Gets information about a user's link to an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", + "description": "Lookup for a single subproperty Event Filter.", + "flatPath": "v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}", "httpMethod": "GET", - "id": "analyticsadmin.properties.userLinks.get", + "id": "analyticsadmin.properties.subpropertyEventFilters.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Required. Example format: accounts/1234/userLinks/5678", + "description": "Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456", "location": "path", - "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "pattern": "^properties/[^/]+/subpropertyEventFilters/[^/]+$", "required": true, "type": "string" } }, "path": "v1alpha/{+name}", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" ] }, "list": { - "description": "Lists all user links on an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks", + "description": "List all subproperty Event Filters on a property.", + "flatPath": "v1alpha/properties/{propertiesId}/subpropertyEventFilters", "httpMethod": "GET", - "id": "analyticsadmin.properties.userLinks.list", + "id": "analyticsadmin.properties.subpropertyEventFilters.list", "parameterOrder": [ "parent" ], "parameters": { "pageSize": { - "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500.", + "description": "Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)", "format": "int32", "location": "query", "type": "integer" }, "pageToken": { - "description": "A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token.", + "description": "Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { - "description": "Required. Example format: accounts/1234", + "description": "Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123", "location": "path", "pattern": "^properties/[^/]+$", "required": true, "type": "string" } }, - "path": "v1alpha/{+parent}/userLinks", + "path": "v1alpha/{+parent}/subpropertyEventFilters", "response": { - "$ref": "GoogleAnalyticsAdminV1alphaListUserLinksResponse" + "$ref": "GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users", - "https://www.googleapis.com/auth/analytics.manage.users.readonly" + "https://www.googleapis.com/auth/analytics.edit", + "https://www.googleapis.com/auth/analytics.readonly" ] }, "patch": { - "description": "Updates a user link on an account or property.", - "flatPath": "v1alpha/properties/{propertiesId}/userLinks/{userLinksId}", + "description": "Updates a subproperty Event Filter.", + "flatPath": "v1alpha/properties/{propertiesId}/subpropertyEventFilters/{subpropertyEventFiltersId}", "httpMethod": "PATCH", - "id": "analyticsadmin.properties.userLinks.patch", + "id": "analyticsadmin.properties.subpropertyEventFilters.patch", "parameterOrder": [ "name" ], "parameters": { "name": { - "description": "Output only. Example format: properties/1234/userLinks/5678", + "description": "Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678", "location": "path", - "pattern": "^properties/[^/]+/userLinks/[^/]+$", + "pattern": "^properties/[^/]+/subpropertyEventFilters/[^/]+$", "required": true, "type": "string" + }, + "updateMask": { + "description": "Required. The list of fields to update. Field names must be in snake case (for example, \"field_to_update\"). Omitted fields will not be updated. To replace the entire entity, use one path with the string \"*\" to match all fields.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "v1alpha/{+name}", "request": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "response": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "scopes": [ - "https://www.googleapis.com/auth/analytics.manage.users" + "https://www.googleapis.com/auth/analytics.edit" ] } } @@ -4524,7 +4298,7 @@ } } }, - "revision": "20230923", + "revision": "20231006", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1alphaAccessBetweenFilter": { @@ -5508,99 +5282,36 @@ "Scope is not specified.", "User joins the Audience if the filter condition is met within one event.", "User joins the Audience if the filter condition is met within one session.", - "User joins the Audience if the filter condition is met by any event across any session." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaAudienceSimpleFilter": { - "description": "Defines a simple filter that a user must satisfy to be a member of the Audience.", - "id": "GoogleAnalyticsAdminV1alphaAudienceSimpleFilter", - "properties": { - "filterExpression": { - "$ref": "GoogleAnalyticsAdminV1alphaAudienceFilterExpression", - "description": "Required. Immutable. A logical expression of Audience dimension, metric, or event filters." - }, - "scope": { - "description": "Required. Immutable. Specifies the scope for this filter.", - "enum": [ - "AUDIENCE_FILTER_SCOPE_UNSPECIFIED", - "AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT", - "AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION", - "AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS" - ], - "enumDescriptions": [ - "Scope is not specified.", - "User joins the Audience if the filter condition is met within one event.", - "User joins the Audience if the filter condition is met within one session.", - "User joins the Audience if the filter condition is met by any event across any session." - ], - "type": "string" - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaAuditUserLink": { - "description": "Read-only resource used to summarize a principal's effective roles.", - "id": "GoogleAnalyticsAdminV1alphaAuditUserLink", - "properties": { - "directRoles": { - "description": "Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role.", - "items": { - "type": "string" - }, - "type": "array" - }, - "effectiveRoles": { - "description": "Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer", - "items": { - "type": "string" - }, - "type": "array" - }, - "emailAddress": { - "description": "Email address of the linked user", - "type": "string" - }, - "name": { - "description": "Example format: properties/1234/userLinks/5678", - "type": "string" - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest": { - "description": "Request message for AuditUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksRequest", - "properties": { - "pageSize": { - "description": "The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000.", - "format": "int32", - "type": "integer" - }, - "pageToken": { - "description": "A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token.", + "User joins the Audience if the filter condition is met by any event across any session." + ], "type": "string" } }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse": { - "description": "Response message for AuditUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaAuditUserLinksResponse", + "GoogleAnalyticsAdminV1alphaAudienceSimpleFilter": { + "description": "Defines a simple filter that a user must satisfy to be a member of the Audience.", + "id": "GoogleAnalyticsAdminV1alphaAudienceSimpleFilter", "properties": { - "nextPageToken": { - "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", - "type": "string" + "filterExpression": { + "$ref": "GoogleAnalyticsAdminV1alphaAudienceFilterExpression", + "description": "Required. Immutable. A logical expression of Audience dimension, metric, or event filters." }, - "userLinks": { - "description": "List of AuditUserLinks. These will be ordered stably, but in an arbitrary order.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaAuditUserLink" - }, - "type": "array" + "scope": { + "description": "Required. Immutable. Specifies the scope for this filter.", + "enum": [ + "AUDIENCE_FILTER_SCOPE_UNSPECIFIED", + "AUDIENCE_FILTER_SCOPE_WITHIN_SAME_EVENT", + "AUDIENCE_FILTER_SCOPE_WITHIN_SAME_SESSION", + "AUDIENCE_FILTER_SCOPE_ACROSS_ALL_SESSIONS" + ], + "enumDescriptions": [ + "Scope is not specified.", + "User joins the Audience if the filter condition is met within one event.", + "User joins the Audience if the filter condition is met within one session.", + "User joins the Audience if the filter condition is met by any event across any session." + ], + "type": "string" } }, "type": "object" @@ -5633,38 +5344,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest": { - "description": "Request message for BatchCreateUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest", - "properties": { - "notifyNewUsers": { - "description": "Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored.", - "type": "boolean" - }, - "requests": { - "description": "Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse": { - "description": "Response message for BatchCreateUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse", - "properties": { - "userLinks": { - "description": "The user links created.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest": { "description": "Request message for BatchDeleteAccessBindings RPC.", "id": "GoogleAnalyticsAdminV1alphaBatchDeleteAccessBindingsRequest", @@ -5679,20 +5358,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest": { - "description": "Request message for BatchDeleteUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest", - "properties": { - "requests": { - "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse": { "description": "Response message for BatchGetAccessBindings RPC.", "id": "GoogleAnalyticsAdminV1alphaBatchGetAccessBindingsResponse", @@ -5707,20 +5372,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse": { - "description": "Response message for BatchGetUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse", - "properties": { - "userLinks": { - "description": "The requested user links.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest": { "description": "Request message for BatchUpdateAccessBindings RPC.", "id": "GoogleAnalyticsAdminV1alphaBatchUpdateAccessBindingsRequest", @@ -5749,34 +5400,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest": { - "description": "Request message for BatchUpdateUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest", - "properties": { - "requests": { - "description": "Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest" - }, - "type": "array" - } - }, - "type": "object" - }, - "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse": { - "description": "Response message for BatchUpdateUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse", - "properties": { - "userLinks": { - "description": "The user links updated.", - "items": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" - }, - "type": "array" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaBigQueryLink": { "description": "A link between a GA4 Property and BigQuery project.", "id": "GoogleAnalyticsAdminV1alphaBigQueryLink", @@ -5910,6 +5533,10 @@ "$ref": "GoogleAnalyticsAdminV1alphaCustomMetric", "description": "A snapshot of a CustomMetric resource in change history." }, + "dataRedactionSettings": { + "$ref": "GoogleAnalyticsAdminV1alphaDataRedactionSettings", + "description": "A snapshot of DataRedactionSettings resource in change history." + }, "dataRetentionSettings": { "$ref": "GoogleAnalyticsAdminV1alphaDataRetentionSettings", "description": "A snapshot of a data retention settings resource in change history." @@ -6291,21 +5918,72 @@ "properties": {}, "type": "object" }, - "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest": { - "description": "Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the \"primary\" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the \"primary\" email address. As a result, the input and output email address for this request may differ.", - "id": "GoogleAnalyticsAdminV1alphaCreateUserLinkRequest", + "GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest": { + "description": "Request message for CreateRollupProperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest", "properties": { - "notifyNewUser": { - "description": "Optional. If set, then email the new user notifying them that they've been granted permissions to the resource.", - "type": "boolean" + "rollupProperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "Required. The roll-up property to create." + }, + "sourceProperties": { + "description": "Optional. The resource names of properties that will be sources to the created roll-up property.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse": { + "description": "Response message for CreateRollupProperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse", + "properties": { + "rollupProperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "The created roll-up property." }, + "rollupPropertySourceLinks": { + "description": "The created roll-up property source links.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest": { + "description": "Request message for CreateSubproperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest", + "properties": { "parent": { - "description": "Required. Example format: accounts/1234", + "description": "Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: properties/123", "type": "string" }, - "userLink": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink", - "description": "Required. The user link to create." + "subproperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "Required. The subproperty to create." + }, + "subpropertyEventFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", + "description": "Optional. The subproperty event filter to create on an ordinary property." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse": { + "description": "Response message for CreateSubproperty RPC.", + "id": "GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse", + "properties": { + "subproperty": { + "$ref": "GoogleAnalyticsAdminV1alphaProperty", + "description": "The created subproperty." + }, + "subpropertyEventFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", + "description": "The created subproperty event filter." } }, "type": "object" @@ -6437,6 +6115,33 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaDataRedactionSettings": { + "description": "Settings for client-side data redaction. Singleton resource under a Web Stream.", + "id": "GoogleAnalyticsAdminV1alphaDataRedactionSettings", + "properties": { + "emailRedactionEnabled": { + "description": "If enabled, any event parameter or user property values that look like an email will be redacted.", + "type": "boolean" + }, + "name": { + "description": "Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id}/dataStreams/{data_stream}/dataRedactionSettings Example: \"properties/1000/dataStreams/2000/dataRedactionSettings\"", + "readOnly": true, + "type": "string" + }, + "queryParameterKeys": { + "description": "The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas.", + "items": { + "type": "string" + }, + "type": "array" + }, + "queryParameterRedactionEnabled": { + "description": "Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaDataRetentionSettings": { "description": "Settings values for data retention. This is a singleton resource.", "id": "GoogleAnalyticsAdminV1alphaDataRetentionSettings", @@ -6640,17 +6345,6 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest": { - "description": "Request message for DeleteUserLink RPC.", - "id": "GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest", - "properties": { - "name": { - "description": "Required. Example format: accounts/1234/userLinks/5678", - "type": "string" - } - }, - "type": "object" - }, "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink": { "description": "A link between a GA4 property and a Display & Video 360 advertiser.", "id": "GoogleAnalyticsAdminV1alphaDisplayVideo360AdvertiserLink", @@ -7572,6 +7266,24 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse": { + "description": "Response message for ListRollupPropertySourceLinks RPC.", + "id": "GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "rollupPropertySourceLinks": { + "description": "List of RollupPropertySourceLinks.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaListSKAdNetworkConversionValueSchemasResponse": { "description": "Response message for ListSKAdNetworkConversionValueSchemas RPC", "id": "GoogleAnalyticsAdminV1alphaListSKAdNetworkConversionValueSchemasResponse", @@ -7608,18 +7320,18 @@ }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaListUserLinksResponse": { - "description": "Response message for ListUserLinks RPC.", - "id": "GoogleAnalyticsAdminV1alphaListUserLinksResponse", + "GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse": { + "description": "Response message for ListSubpropertyEventFilter RPC.", + "id": "GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse", "properties": { "nextPageToken": { "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", "type": "string" }, - "userLinks": { - "description": "List of UserLinks. These will be ordered stably, but in an arbitrary order.", + "subpropertyEventFilters": { + "description": "List of subproperty event filters.", "items": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink" + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter" }, "type": "array" } @@ -7860,7 +7572,7 @@ "type": "string" }, "propertyType": { - "description": "Immutable. The property type for this Property resource. When creating a property, if the type is \"PROPERTY_TYPE_UNSPECIFIED\", then \"ORDINARY_PROPERTY\" will be implied. \"SUBPROPERTY\" and \"ROLLUP_PROPERTY\" types cannot yet be created with the Google Analytics Admin API.", + "description": "Immutable. The property type for this Property resource. When creating a property, if the type is \"PROPERTY_TYPE_UNSPECIFIED\", then \"ORDINARY_PROPERTY\" will be implied.", "enum": [ "PROPERTY_TYPE_UNSPECIFIED", "PROPERTY_TYPE_ORDINARY", @@ -7964,6 +7676,22 @@ }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink": { + "description": "A link that references a source property under the parent rollup property.", + "id": "GoogleAnalyticsAdminV1alphaRollupPropertySourceLink", + "properties": { + "name": { + "description": "Output only. Resource name of this RollupPropertySourceLink. Format: 'properties/{property_id}/rollupPropertySourceLinks/{rollup_property_source_link}' Format: 'properties/123/rollupPropertySourceLinks/456'", + "readOnly": true, + "type": "string" + }, + "sourceProperty": { + "description": "Immutable. Resource name of the source property. Format: properties/{property_id} Example: \"properties/789\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleAnalyticsAdminV1alphaRunAccessReportRequest": { "description": "The request for a Data Access Record Report.", "id": "GoogleAnalyticsAdminV1alphaRunAccessReportRequest", @@ -7986,6 +7714,14 @@ }, "type": "array" }, + "expandGroups": { + "description": "Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.", + "type": "boolean" + }, + "includeAllUsers": { + "description": "Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.", + "type": "boolean" + }, "limit": { "description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).", "format": "int64", @@ -8203,6 +7939,7 @@ "EXPANDED_DATA_SET", "CHANNEL_GROUP", "ENHANCED_MEASUREMENT_SETTINGS", + "DATA_REDACTION_SETTINGS", "SKADNETWORK_CONVERSION_VALUE_SCHEMA", "ADSENSE_LINK", "AUDIENCE", @@ -8228,6 +7965,7 @@ "ExpandedDataSet resource", "ChannelGroup resource", "EnhancedMeasurementSettings resource", + "DataRedactionSettings resource", "SKAdNetworkConversionValueSchema resource", "AdSenseLink resource", "Audience resource", @@ -8279,51 +8017,154 @@ "properties": {}, "type": "object" }, - "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest": { - "description": "Request message for UpdateAccessBinding RPC.", - "id": "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest", + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter": { + "description": "A resource message representing a GA4 Subproperty event filter.", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilter", "properties": { - "accessBinding": { - "$ref": "GoogleAnalyticsAdminV1alphaAccessBinding", - "description": "Required. The access binding to update." + "applyToProperty": { + "description": "Immutable. Resource name of the Subproperty that uses this filter.", + "type": "string" + }, + "filterClauses": { + "description": "Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty.", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause" + }, + "type": "array" + }, + "name": { + "description": "Output only. Format: properties/{ordinary_property_id}/subpropertyEventFilters/{sub_property_event_filter} Example: properties/1234/subpropertyEventFilters/5678", + "readOnly": true, + "type": "string" } }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest": { - "description": "Request message for UpdateUserLink RPC.", - "id": "GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest", + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause": { + "description": "A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data).", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause", "properties": { - "userLink": { - "$ref": "GoogleAnalyticsAdminV1alphaUserLink", - "description": "Required. The user link to update." + "filterClauseType": { + "description": "Required. The type for the filter clause.", + "enum": [ + "FILTER_CLAUSE_TYPE_UNSPECIFIED", + "INCLUDE", + "EXCLUDE" + ], + "enumDescriptions": [ + "Filter clause type unknown or not specified.", + "Events will be included in the Sub property if the filter clause is met.", + "Events will be excluded from the Sub property if the filter clause is met." + ], + "type": "string" + }, + "filterExpression": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression", + "description": "Required. The logical expression for what events are sent to the subproperty." } }, "type": "object" }, - "GoogleAnalyticsAdminV1alphaUserLink": { - "description": "A resource message representing a user's permissions on an Account or Property resource.", - "id": "GoogleAnalyticsAdminV1alphaUserLink", + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition": { + "description": "A specific filter expression", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition", "properties": { - "directRoles": { - "description": "Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted.", - "items": { - "type": "string" - }, - "type": "array" + "fieldName": { + "description": "Required. The field that is being filtered.", + "type": "string" + }, + "nullFilter": { + "description": "A filter for null values.", + "type": "boolean" + }, + "stringFilter": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter", + "description": "A filter for a string-type dimension that matches a particular pattern." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter": { + "description": "A filter for a string-type dimension that matches a particular pattern.", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter", + "properties": { + "caseSensitive": { + "description": "Optional. If true, the string value is case sensitive. If false, the match is case-insensitive.", + "type": "boolean" }, - "emailAddress": { - "description": "Immutable. Email address of the user to link", + "matchType": { + "description": "Required. The match type for the string filter.", + "enum": [ + "MATCH_TYPE_UNSPECIFIED", + "EXACT", + "BEGINS_WITH", + "ENDS_WITH", + "CONTAINS", + "FULL_REGEXP", + "PARTIAL_REGEXP" + ], + "enumDescriptions": [ + "Match type unknown or not specified.", + "Exact match of the string value.", + "Begins with the string value.", + "Ends with the string value.", + "Contains the string value.", + "Full regular expression matches with the string value.", + "Partial regular expression matches with the string value." + ], "type": "string" }, - "name": { - "description": "Output only. Example format: properties/1234/userLinks/5678", - "readOnly": true, + "value": { + "description": "Required. The string value used for the matching.", "type": "string" } }, "type": "object" }, + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression": { + "description": "A logical expression of Subproperty event filters.", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression", + "properties": { + "filterCondition": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition", + "description": "Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression." + }, + "notExpression": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression", + "description": "A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression." + }, + "orGroup": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList", + "description": "A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions." + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList": { + "description": "A list of Subproperty event filter expressions.", + "id": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList", + "properties": { + "filterExpressions": { + "description": "Required. Unordered list. A list of Subproperty event filter expressions", + "items": { + "$ref": "GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest": { + "description": "Request message for UpdateAccessBinding RPC.", + "id": "GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest", + "properties": { + "accessBinding": { + "$ref": "GoogleAnalyticsAdminV1alphaAccessBinding", + "description": "Required. The access binding to update." + } + }, + "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", diff --git a/discovery/analyticsadmin-v1beta.json b/discovery/analyticsadmin-v1beta.json index f2d27a122b..9b51f5bee1 100644 --- a/discovery/analyticsadmin-v1beta.json +++ b/discovery/analyticsadmin-v1beta.json @@ -143,7 +143,7 @@ "accounts": { "methods": { "delete": { - "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", + "description": "Marks target Account as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found.", "flatPath": "v1beta/accounts/{accountsId}", "httpMethod": "DELETE", "id": "analyticsadmin.accounts.delete", @@ -412,7 +412,7 @@ ] }, "delete": { - "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.", + "description": "Marks target Property as soft-deleted (ie: \"trashed\") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property.", "flatPath": "v1beta/properties/{propertiesId}", "httpMethod": "DELETE", "id": "analyticsadmin.properties.delete", @@ -1628,7 +1628,7 @@ } } }, - "revision": "20230814", + "revision": "20231006", "rootUrl": "https://analyticsadmin.googleapis.com/", "schemas": { "GoogleAnalyticsAdminV1betaAccessBetweenFilter": { @@ -2950,7 +2950,7 @@ "type": "string" }, "propertyType": { - "description": "Immutable. The property type for this Property resource. When creating a property, if the type is \"PROPERTY_TYPE_UNSPECIFIED\", then \"ORDINARY_PROPERTY\" will be implied. \"SUBPROPERTY\" and \"ROLLUP_PROPERTY\" types cannot yet be created with the Google Analytics Admin API.", + "description": "Immutable. The property type for this Property resource. When creating a property, if the type is \"PROPERTY_TYPE_UNSPECIFIED\", then \"ORDINARY_PROPERTY\" will be implied.", "enum": [ "PROPERTY_TYPE_UNSPECIFIED", "PROPERTY_TYPE_ORDINARY", @@ -3076,6 +3076,14 @@ }, "type": "array" }, + "expandGroups": { + "description": "Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned.", + "type": "boolean" + }, + "includeAllUsers": { + "description": "Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included.", + "type": "boolean" + }, "limit": { "description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination).", "format": "int64", diff --git a/discovery/analyticshub-v1.json b/discovery/analyticshub-v1.json index 7cfc1a4d01..239be5f954 100644 --- a/discovery/analyticshub-v1.json +++ b/discovery/analyticshub-v1.json @@ -964,7 +964,7 @@ } } }, - "revision": "20230911", + "revision": "20230923", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1470,7 +1470,7 @@ "type": "object" }, "OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", + "description": "Represents the metadata of a long-running operation in Analytics Hub.", "id": "OperationMetadata", "properties": { "apiVersion": { @@ -1478,11 +1478,6 @@ "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", @@ -1495,7 +1490,12 @@ "readOnly": true, "type": "string" }, - "statusDetail": { + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" diff --git a/discovery/analyticshub-v1beta1.json b/discovery/analyticshub-v1beta1.json index 022a00b068..4b937fbe40 100644 --- a/discovery/analyticshub-v1beta1.json +++ b/discovery/analyticshub-v1beta1.json @@ -695,7 +695,7 @@ } } }, - "revision": "20230911", + "revision": "20230923", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AuditConfig": { @@ -1114,7 +1114,7 @@ "type": "object" }, "OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", + "description": "Represents the metadata of a long-running operation in Analytics Hub.", "id": "OperationMetadata", "properties": { "apiVersion": { @@ -1122,11 +1122,6 @@ "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", @@ -1139,7 +1134,12 @@ "readOnly": true, "type": "string" }, - "statusDetail": { + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { "description": "Output only. Human-readable status of the operation, if any.", "readOnly": true, "type": "string" diff --git a/discovery/androidmanagement-v1.json b/discovery/androidmanagement-v1.json index 54e5745b7a..542b7a49b8 100644 --- a/discovery/androidmanagement-v1.json +++ b/discovery/androidmanagement-v1.json @@ -1095,7 +1095,7 @@ } } }, - "revision": "20230911", + "revision": "20231002", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -2256,7 +2256,7 @@ "description": "List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: * SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. * SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. * SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps. Supported on Android 14 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 14." }, "showWorkContactsInPersonalProfile": { - "description": "Whether contacts stored in the work profile can be shown in personal profile contact searches and incoming calls.", + "description": "Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile.", "enum": [ "SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_UNSPECIFIED", "SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED", @@ -2264,9 +2264,9 @@ "SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM" ], "enumDescriptions": [ - "Unspecified. Defaults to SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED.", - "Prevents work profile contacts from appearing in personal profile contact searches and incoming calls", - "Default. Allows work profile contacts to appear in personal profile contact searches and incoming calls", + "Unspecified. Defaults to SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. When this is set, exemptions_to_show_work_contacts_in_personal_profile must not be set.", + "Prevents personal apps from accessing work profile contacts and looking up work contacts. When this is set, personal apps specified in exemptions_to_show_work_contacts_in_personal_profile are allowlisted and can access work profile contacts directly. Supported on Android 7.0 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 7.0.", + "Default. Allows apps in the personal profile to access work profile contacts including contact searches and incoming calls. When this is set, personal apps specified in exemptions_to_show_work_contacts_in_personal_profile are blocklisted and can not access work profile contacts directly. Supported on Android 7.0 and above. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 7.0.", "Prevents most personal apps from accessing work profile contacts including contact searches and incoming calls, except for the OEM default Dialer, Messages, and Contacts apps. Neither user-configured Dialer, Messages, and Contacts apps, nor any other system or play installed apps, will be able to query work contacts directly. When this is set, personal apps specified in exemptions_to_show_work_contacts_in_personal_profile are allowlisted and can access work profile contacts. Supported on Android 14 and above. If this is set on a device with Android version less than 14, the behaviour falls back to SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED and a nonComplianceDetail with API_LEVEL is reported." ], "type": "string" @@ -2641,6 +2641,34 @@ ], "type": "string" }, + "cellularTwoGState": { + "description": "Controls whether cellular 2G setting can be toggled by the user or not.", + "enum": [ + "CELLULAR_TWO_G_STATE_UNSPECIFIED", + "CELLULAR_TWO_G_USER_CHOICE", + "CELLULAR_TWO_G_DISABLED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to CELLULAR_TWO_G_USER_CHOICE.", + "The user is allowed to toggle cellular 2G on or off.", + "Cellular 2G is disabled. The user is not allowed to toggle cellular 2G on via settings. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 14." + ], + "type": "string" + }, + "ultraWidebandState": { + "description": "Controls the state of the ultra wideband setting and whether the user can toggle it on or off.", + "enum": [ + "ULTRA_WIDEBAND_STATE_UNSPECIFIED", + "ULTRA_WIDEBAND_USER_CHOICE", + "ULTRA_WIDEBAND_DISABLED" + ], + "enumDescriptions": [ + "Unspecified. Defaults to ULTRA_WIDEBAND_USER_CHOICE.", + "The user is allowed to toggle ultra wideband on or off.", + "Ultra wideband is disabled. The user is not allowed to toggle ultra wideband on via settings. A nonComplianceDetail with API_LEVEL is reported if the Android version is less than 14." + ], + "type": "string" + }, "wifiState": { "description": "Controls current state of Wi-Fi and if user can change its state.", "enum": [ @@ -4319,7 +4347,7 @@ ], "enumDescriptions": [ "Unspecified. Defaults to AVAILABLE.", - "The app is blocked and can't be installed in the personal profile.", + "The app is blocked and can't be installed in the personal profile. If the app was previously installed in the device, it will be uninstalled.", "The app is available to install in the personal profile." ], "type": "string" @@ -4347,7 +4375,7 @@ "type": "boolean" }, "maxDaysWithWorkOff": { - "description": "Controls how long the work profile can stay off. The duration must be at least 3 days.", + "description": "Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to any value between 1-2 days, the feature is automatically set to 3 days. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter.", "format": "int32", "type": "integer" }, @@ -4642,6 +4670,7 @@ "FACE", "IRIS", "BIOMETRICS", + "SHORTCUTS", "ALL_FEATURES" ], "enumDescriptions": [ @@ -4655,6 +4684,7 @@ "Disable face authentication on secure keyguard screens.", "Disable iris authentication on secure keyguard screens.", "Disable all biometric authentication on secure keyguard screens.", + "Disable all shortcuts on secure keyguard screen on Android 14 and above.", "Disable all current and future keyguard customizations." ], "type": "string" @@ -5231,7 +5261,7 @@ "type": "object" }, "SigninDetail": { - "description": "A resource containing sign in details for an enterprise.", + "description": "A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration.", "id": "SigninDetail", "properties": { "allowPersonalUsage": { @@ -5259,6 +5289,10 @@ "signinUrl": { "description": "Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login.", "type": "string" + }, + "tokenTag": { + "description": "An EMM-specified metadata to distinguish between instances of SigninDetail.", + "type": "string" } }, "type": "object" diff --git a/discovery/androidpublisher-v3.json b/discovery/androidpublisher-v3.json index a19b124e1b..fe47be5327 100644 --- a/discovery/androidpublisher-v3.json +++ b/discovery/androidpublisher-v3.json @@ -632,7 +632,7 @@ "accept": [ "application/octet-stream" ], - "maxSize": "1258291200", + "maxSize": "1677721600", "protocols": { "resumable": { "multipart": true, @@ -4047,7 +4047,7 @@ } } }, - "revision": "20230921", + "revision": "20231010", "rootUrl": "https://androidpublisher.googleapis.com/", "schemas": { "Abi": { @@ -5413,7 +5413,8 @@ "CAN_MANAGE_ORDERS", "CAN_MANAGE_APP_CONTENT", "CAN_VIEW_NON_FINANCIAL_DATA", - "CAN_VIEW_APP_QUALITY" + "CAN_VIEW_APP_QUALITY", + "CAN_MANAGE_DEEPLINKS" ], "enumDeprecated": [ false, @@ -5429,6 +5430,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -5445,7 +5447,8 @@ "Manage orders and subscriptions.", "Manage policy related pages.", "View app information (read-only).", - "View app quality data such as Vitals, Crashes etc." + "View app quality data such as Vitals, Crashes etc.", + "Manage the deep links setup of an app." ], "type": "string" }, @@ -6854,7 +6857,7 @@ "id": "SubscriptionItemPriceChangeDetails", "properties": { "expectedNewPriceChargeTime": { - "description": "The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause.", + "description": "The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect.", "format": "google-datetime", "type": "string" }, @@ -7759,7 +7762,8 @@ "CAN_MANAGE_ORDERS_GLOBAL", "CAN_MANAGE_APP_CONTENT_GLOBAL", "CAN_VIEW_NON_FINANCIAL_DATA_GLOBAL", - "CAN_VIEW_APP_QUALITY_GLOBAL" + "CAN_VIEW_APP_QUALITY_GLOBAL", + "CAN_MANAGE_DEEPLINKS_GLOBAL" ], "enumDescriptions": [ "Unknown or unspecified permission.", @@ -7779,7 +7783,8 @@ "Manage orders and subscriptions.", "Manage policy related pages on all apps for the developer.", "View app information and download bulk reports (read-only).", - "View app quality information for all apps for the developer." + "View app quality information for all apps for the developer.", + "Manage the deep links setup for all apps for the developer." ], "type": "string" }, diff --git a/discovery/apigee-v1.json b/discovery/apigee-v1.json index 09f5b810ae..ddf2b92078 100644 --- a/discovery/apigee-v1.json +++ b/discovery/apigee-v1.json @@ -4077,6 +4077,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getAddonsConfig": { + "description": "Gets the add-ons config of an environment.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig", + "httpMethod": "GET", + "id": "apigee.organizations.environments.getAddonsConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the add-ons config. Must be in the format of `/organizations/{org}/environments/{env}/addonsConfig`", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/addonsConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1AddonsConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getApiSecurityRuntimeConfig": { "description": "Gets the API Security runtime configuration for an environment. This named ApiSecurityRuntimeConfig to prevent conflicts with ApiSecurityConfig from addon config.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/apiSecurityRuntimeConfig", @@ -4183,6 +4208,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getSecurityActionsConfig": { + "description": "GetSecurityActionConfig returns the current SecurityActions configuration.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig", + "httpMethod": "GET", + "id": "apigee.organizations.environments.getSecurityActionsConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SecurityActionsConfig to retrieve. This will always be: `organizations/{org}/environments/{env}/security_actions_config`", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/securityActionsConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1SecurityActionsConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getTraceConfig": { "description": "Get distributed trace configuration in an environment.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig", @@ -4446,6 +4496,40 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "updateSecurityActionsConfig": { + "description": "UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActionsConfig", + "httpMethod": "PATCH", + "id": "apigee.organizations.environments.updateSecurityActionsConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/securityActionsConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "The list of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "GoogleCloudApigeeV1SecurityActionsConfig" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityActionsConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateTraceConfig": { "description": "Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.", "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/traceConfig", @@ -4482,6 +4566,38 @@ } }, "resources": { + "addonsConfig": { + "methods": { + "setAddonEnablement": { + "description": "Updates an add-on enablement status of an environment.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/addonsConfig:setAddonEnablement", + "httpMethod": "POST", + "id": "apigee.organizations.environments.addonsConfig.setAddonEnablement", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the add-ons config. Must be in the format of `/organizations/{org}/environments/{env}/addonsConfig`", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/addonsConfig$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:setAddonEnablement", + "request": { + "$ref": "GoogleCloudApigeeV1SetAddonEnablementRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "analytics": { "resources": { "admin": { @@ -4662,7 +4778,7 @@ "type": "boolean" }, "sequencedRollout": { - "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The [generateDeployChangeReport API](generateDeployChangeReport) may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", + "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the routing rules for this deployment and the environment changes to add the deployment will be rolled out in a safe order. This reduces the risk of downtime that could be caused by changing the environment group's routing before the new destination for the affected traffic is ready to receive it. This should only be necessary if the new deployment will be capturing traffic from another environment under a shared environment group or if traffic will be rerouted to a different environment due to a base path removal. The generateDeployChangeReport API may be used to examine routing changes before issuing the deployment request, and its response will indicate if a sequenced rollout is recommended for the deployment.", "location": "query", "type": "boolean" }, @@ -4722,7 +4838,7 @@ "type": "string" }, "sequencedRollout": { - "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The [GenerateUndeployChangeReport API](GenerateUndeployChangeReport) may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", + "description": "Flag that specifies whether to enable sequenced rollout. If set to `true`, the environment group routing rules corresponding to this deployment will be removed before removing the deployment from the runtime. This is likely to be a rare use case; it is only needed when the intended effect of undeploying this proxy is to cause the traffic it currently handles to be rerouted to some other existing proxy in the environment group. The GenerateUndeployChangeReport API may be used to examine routing changes before issuing the undeployment request, and its response will indicate if a sequenced rollout is recommended for the undeployment.", "location": "query", "type": "boolean" } @@ -6374,6 +6490,165 @@ } } }, + "securityActions": { + "methods": { + "create": { + "description": "CreateSecurityAction creates a SecurityAction.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions", + "httpMethod": "POST", + "id": "apigee.organizations.environments.securityActions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The organization and environment that this SecurityAction applies to. Format: organizations/{org}/environments/{env}", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + }, + "securityActionId": { + "description": "Required. The ID to use for the SecurityAction, which will become the final component of the action's resource name. This value should be 0-61 characters, and valid format is (^[a-z]([a-z0-9-]{​0,61}[a-z0-9])?$).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/securityActions", + "request": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "disable": { + "description": "Disable a SecurityAction. The `state` of the SecurityAction after disabling is `DISABLED`. `DisableSecurityAction` can be called on SecurityActions in the state `ENABLED`; SecurityActions in a different state (including `DISABLED`) return an error.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:disable", + "httpMethod": "POST", + "id": "apigee.organizations.environments.securityActions.disable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SecurityAction to disable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:disable", + "request": { + "$ref": "GoogleCloudApigeeV1DisableSecurityActionRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "enable": { + "description": "Enable a SecurityAction. The `state` of the SecurityAction after enabling is `ENABLED`. `EnableSecurityAction` can be called on SecurityActions in the state `DISABLED`; SecurityActions in a different state (including `ENABLED) return an error.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}:enable", + "httpMethod": "POST", + "id": "apigee.organizations.environments.securityActions.enable", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the SecurityAction to enable. Format: organizations/{org}/environments/{env}/securityActions/{security_action}", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:enable", + "request": { + "$ref": "GoogleCloudApigeeV1EnableSecurityActionRequest" + }, + "response": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a SecurityAction by name.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions/{securityActionsId}", + "httpMethod": "GET", + "id": "apigee.organizations.environments.securityActions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The fully qualified name of the SecurityAction to retrieve. Format: organizations/{org}/environments/{env}/securityActions/{security_action}", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+/securityActions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns a list of SecurityActions. This returns both enabled and disabled actions.", + "flatPath": "v1/organizations/{organizationsId}/environments/{environmentsId}/securityActions", + "httpMethod": "GET", + "id": "apigee.organizations.environments.securityActions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "The filter expression to filter List results. https://google.aip.dev/160. Allows for filtering over: state and api_proxies. E.g.: state = ACTIVE AND apiProxies:foo. Filtering by action is not supported https://github.com/aip-dev/google.aip.dev/issues/624", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of SecurityActions to return. If unspecified, at most 50 SecurityActions 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 `ListSecurityActions` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSecurityActions` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent, which owns this collection of SecurityActions. Format: organizations/{org}/environments/{env}", + "location": "path", + "pattern": "^organizations/[^/]+/environments/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/securityActions", + "response": { + "$ref": "GoogleCloudApigeeV1ListSecurityActionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "securityIncidents": { "methods": { "get": { @@ -8618,7 +8893,7 @@ "type": "string" }, "securityProfileId": { - "description": "Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 4-63 characters, and valid characters are /(^[a-z]([a-z0-9-]{​0,61}[a-z0-9])?$/.", + "description": "Required. The ID to use for the SecurityProfile, which will become the final component of the action's resource name. This value should be 1-63 characters and validated by \"(^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$)\".", "location": "query", "type": "string" } @@ -9334,7 +9609,7 @@ } } }, - "revision": "20230818", + "revision": "20230929", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -9479,6 +9754,10 @@ "$ref": "GoogleCloudApigeeV1AdvancedApiOpsConfig", "description": "Configuration for the Advanced API Ops add-on." }, + "analyticsConfig": { + "$ref": "GoogleCloudApigeeV1AnalyticsConfig", + "description": "Configuration for the Analytics add-on." + }, "apiSecurityConfig": { "$ref": "GoogleCloudApigeeV1ApiSecurityConfig", "description": "Configuration for the API Security add-on." @@ -9576,6 +9855,48 @@ }, "type": "object" }, + "GoogleCloudApigeeV1AnalyticsConfig": { + "description": "Configuration for the Analytics add-on.", + "id": "GoogleCloudApigeeV1AnalyticsConfig", + "properties": { + "enabled": { + "description": "Whether the Analytics add-on is enabled.", + "type": "boolean" + }, + "expireTimeMillis": { + "description": "Output only. Time at which the Analytics add-on expires in milliseconds since epoch. If unspecified, the add-on will never expire.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the Analytics add-on.", + "enum": [ + "ADDON_STATE_UNSPECIFIED", + "ENABLING", + "ENABLED", + "DISABLING", + "DISABLED" + ], + "enumDescriptions": [ + "Default value.", + "Add-on is in progress of enabling.", + "Add-on is fully enabled and ready to use.", + "Add-on is in progress of disabling.", + "Add-on is fully disabled." + ], + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The latest update time.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ApiCategory": { "description": "the Api category resource wrapped with response status, error_code etc.", "id": "GoogleCloudApigeeV1ApiCategory", @@ -11817,6 +12138,18 @@ }, "type": "object" }, + "GoogleCloudApigeeV1DisableSecurityActionRequest": { + "description": "Message to disable an enabled SecurityAction.", + "id": "GoogleCloudApigeeV1DisableSecurityActionRequest", + "properties": {}, + "type": "object" + }, + "GoogleCloudApigeeV1EnableSecurityActionRequest": { + "description": "Message to enable a disabled SecurityAction.", + "id": "GoogleCloudApigeeV1EnableSecurityActionRequest", + "properties": {}, + "type": "object" + }, "GoogleCloudApigeeV1EndpointAttachment": { "description": "Apigee endpoint attachment. For more information, see [Southbound networking patterns] (https://cloud.google.com/apigee/docs/api-platform/architecture/southbound-networking-patterns-endpoints).", "id": "GoogleCloudApigeeV1EndpointAttachment", @@ -12035,6 +12368,10 @@ "GoogleCloudApigeeV1EnvironmentConfig": { "id": "GoogleCloudApigeeV1EnvironmentConfig", "properties": { + "addonsConfig": { + "$ref": "GoogleCloudApigeeV1RuntimeAddonsConfig", + "description": "The latest runtime configurations for add-ons." + }, "arcConfigLocation": { "description": "The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.", "type": "string" @@ -13380,6 +13717,24 @@ }, "type": "object" }, + "GoogleCloudApigeeV1ListSecurityActionsResponse": { + "description": "Contains a list of SecurityActions in response to a ListSecurityActionRequest.", + "id": "GoogleCloudApigeeV1ListSecurityActionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "securityActions": { + "description": "The SecurityActions for the specified environment.", + "items": { + "$ref": "GoogleCloudApigeeV1SecurityAction" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1ListSecurityIncidentsResponse": { "description": "Response for ListSecurityIncidents.", "id": "GoogleCloudApigeeV1ListSecurityIncidentsResponse", @@ -14002,6 +14357,21 @@ "readOnly": true, "type": "string" }, + "subscriptionPlan": { + "description": "Output only. Subscription plan that the customer has purchased. Output only.", + "enum": [ + "SUBSCRIPTION_PLAN_UNSPECIFIED", + "SUBSCRIPTION_2021", + "SUBSCRIPTION_2024" + ], + "enumDescriptions": [ + "Subscription plan not specified.", + "Traditional subscription plan.", + "New subscription plan that provides standard proxy and scaled proxy implementation." + ], + "readOnly": true, + "type": "string" + }, "subscriptionType": { "deprecated": true, "description": "Output only. DEPRECATED: This will eventually be replaced by BillingType. Subscription type of the Apigee organization. Valid values include trial (free, limited, and for evaluation purposes only) or paid (full subscription has been purchased). See [Apigee pricing](https://cloud.google.com/apigee/pricing/).", @@ -15051,6 +15421,59 @@ }, "type": "object" }, + "GoogleCloudApigeeV1RuntimeAddonsConfig": { + "description": "RuntimeAddonsConfig defines the runtime configurations for add-ons in an environment.", + "id": "GoogleCloudApigeeV1RuntimeAddonsConfig", + "properties": { + "analyticsConfig": { + "$ref": "GoogleCloudApigeeV1RuntimeAnalyticsConfig", + "description": "Runtime configuration for Analytics add-on." + }, + "apiSecurityConfig": { + "$ref": "GoogleCloudApigeeV1RuntimeApiSecurityConfig", + "description": "Runtime configuration for API Security add-on." + }, + "name": { + "description": "Name of the addons config in the format: `organizations/{org}/environments/{env}/addonsConfig`", + "type": "string" + }, + "revisionId": { + "description": "Revision number used by the runtime to detect config changes.", + "type": "string" + }, + "uid": { + "description": "UID is to detect if config is recreated after deletion. The add-on config will only be deleted when the environment itself gets deleted, thus it will always be the same as the UID of EnvironmentConfig.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1RuntimeAnalyticsConfig": { + "description": "Runtime configuration for the Analytics add-on.", + "id": "GoogleCloudApigeeV1RuntimeAnalyticsConfig", + "properties": { + "billingPipelineEnabled": { + "description": "If Runtime should send billing data to AX or not.", + "type": "boolean" + }, + "enabled": { + "description": "If the Analytics is enabled or not.", + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1RuntimeApiSecurityConfig": { + "description": "Runtime configuration for the API Security add-on.", + "id": "GoogleCloudApigeeV1RuntimeApiSecurityConfig", + "properties": { + "enabled": { + "description": "If the API Security is enabled or not.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1RuntimeConfig": { "description": "Runtime configuration for the organization. Response for GetRuntimeConfig.", "id": "GoogleCloudApigeeV1RuntimeConfig", @@ -15359,6 +15782,162 @@ }, "type": "object" }, + "GoogleCloudApigeeV1SecurityAction": { + "description": "A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction.", + "id": "GoogleCloudApigeeV1SecurityAction", + "properties": { + "allow": { + "$ref": "GoogleCloudApigeeV1SecurityActionAllow", + "description": "Allow a request through if it matches this SecurityAction." + }, + "conditionConfig": { + "$ref": "GoogleCloudApigeeV1SecurityActionConditionConfig", + "description": "Required. A valid SecurityAction must contain at least one condition." + }, + "createTime": { + "description": "Output only. The create time for this SecurityAction.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deny": { + "$ref": "GoogleCloudApigeeV1SecurityActionDeny", + "description": "Deny a request through if it matches this SecurityAction." + }, + "description": { + "description": "Optional. An optional user provided description of the SecurityAction.", + "type": "string" + }, + "expireTime": { + "description": "The expiration for this SecurityAction.", + "format": "google-datetime", + "type": "string" + }, + "flag": { + "$ref": "GoogleCloudApigeeV1SecurityActionFlag", + "description": "Flag a request through if it matches this SecurityAction." + }, + "name": { + "description": "Immutable. This field is ignored during creation as per AIP-133. Please set the `security_action_id` field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}", + "type": "string" + }, + "state": { + "description": "Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.", + "enum": [ + "STATE_UNSPECIFIED", + "ENABLED", + "DISABLED" + ], + "enumDescriptions": [ + "The default value. This only exists for forward compatibility. A create request with this value will be rejected.", + "An ENABLED SecurityAction is actively enforced if the `expiration_time` is in the future.", + "A disabled SecurityAction is never enforced." + ], + "type": "string" + }, + "ttl": { + "description": "Input only. The TTL for this SecurityAction.", + "format": "google-duration", + "type": "string" + }, + "updateTime": { + "description": "Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionAllow": { + "description": "Message that should be set in case of an Allow Action. This does not have any fields.", + "id": "GoogleCloudApigeeV1SecurityActionAllow", + "properties": {}, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionConditionConfig": { + "description": "The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: api_keys: [\"key1\", \"key2\"] and developers: [\"dev1\", \"dev2\"] then this is interpreted as: enforce the action if the incoming request has ((api_key = \"key1\" OR api_key=\"key\") AND (developer=\"dev1\" OR developer=\"dev2\"))", + "id": "GoogleCloudApigeeV1SecurityActionConditionConfig", + "properties": { + "botReasons": { + "description": "Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.", + "items": { + "type": "string" + }, + "type": "array" + }, + "ipAddressRanges": { + "description": "Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionDeny": { + "description": "Message that should be set in case of a Deny Action.", + "id": "GoogleCloudApigeeV1SecurityActionDeny", + "properties": { + "responseCode": { + "description": "Optional. The HTTP response code if the Action = DENY.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionFlag": { + "description": "The message that should be set in the case of a Flag action.", + "id": "GoogleCloudApigeeV1SecurityActionFlag", + "properties": { + "headers": { + "description": "Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.", + "items": { + "$ref": "GoogleCloudApigeeV1SecurityActionHttpHeader" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionHttpHeader": { + "description": "An HTTP header.", + "id": "GoogleCloudApigeeV1SecurityActionHttpHeader", + "properties": { + "name": { + "description": "The header name to be sent to the target.", + "type": "string" + }, + "value": { + "description": "The header value to be sent to the target.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1SecurityActionsConfig": { + "description": "SecurityActionsConfig reflects the current state of the SecurityActions feature. This is a singleton resource: https://google.aip.dev/156", + "id": "GoogleCloudApigeeV1SecurityActionsConfig", + "properties": { + "enabled": { + "description": "The flag that controls whether this feature is enabled. This is `unset` by default. When this flag is `false`, even if individual rules are enabled, no SecurityActions will be enforced.", + "type": "boolean" + }, + "name": { + "description": "This is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: `organizations/{org}/environments/{env}/security_actions_config`", + "type": "string" + }, + "updateTime": { + "description": "Output only. The update time for configuration.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1SecurityIncident": { "description": "Represents an SecurityIncident resource.", "id": "GoogleCloudApigeeV1SecurityIncident", @@ -15518,7 +16097,7 @@ "type": "string" }, "name": { - "description": "Immutable. Name of the profile-environment association resource. Format: organizations/{org}/securityProfiles/{profile}/environments/{env}", + "description": "Immutable. Name of the environment that the profile is attached to.", "type": "string" }, "securityProfileRevisionId": { @@ -15813,6 +16392,21 @@ }, "type": "object" }, + "GoogleCloudApigeeV1SetAddonEnablementRequest": { + "description": "Request for SetAddonEnablement.", + "id": "GoogleCloudApigeeV1SetAddonEnablementRequest", + "properties": { + "analyticsEnabled": { + "description": "If the Analytics should be enabled in the environment.", + "type": "boolean" + }, + "apiSecurityEnabled": { + "description": "If the API Security should be enabled in the environment.", + "type": "boolean" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1SetAddonsRequest": { "description": "Request for SetAddons.", "id": "GoogleCloudApigeeV1SetAddonsRequest", diff --git a/discovery/apigeeregistry-v1.json b/discovery/apigeeregistry-v1.json index a3128c8fbc..8388f6c602 100644 --- a/discovery/apigeeregistry-v1.json +++ b/discovery/apigeeregistry-v1.json @@ -2788,6 +2788,97 @@ } } }, + "documents": { + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:getIamPolicy", + "httpMethod": "GET", + "id": "apigeeregistry.projects.locations.documents.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/documents$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:setIamPolicy", + "httpMethod": "POST", + "id": "apigeeregistry.projects.locations.documents.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/[^/]+/documents$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/documents:testIamPermissions", + "httpMethod": "POST", + "id": "apigeeregistry.projects.locations.documents.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/[^/]+/documents$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "instances": { "methods": { "create": { @@ -3181,7 +3272,7 @@ } } }, - "revision": "20230920", + "revision": "20231004", "rootUrl": "https://apigeeregistry.googleapis.com/", "schemas": { "Api": { diff --git a/discovery/artifactregistry-v1.json b/discovery/artifactregistry-v1.json index c94c4cee0f..b3209fdd49 100644 --- a/discovery/artifactregistry-v1.json +++ b/discovery/artifactregistry-v1.json @@ -20,9 +20,54 @@ "documentationLink": "https://cloud.google.com/artifacts/docs/", "endpoints": [ { - "location": "me-central2", "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", + "location": "me-central2", "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://apt.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://docker.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://go.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://googet.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://kfp.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://maven.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://npm.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://python.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://yum.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -360,7 +405,7 @@ "type": "string" }, "repositoryId": { - "description": "The repository id to use for this repository.", + "description": "Required. The repository id to use for this repository.", "location": "query", "type": "string" } @@ -1668,7 +1713,7 @@ } } }, - "revision": "20230918", + "revision": "20231006", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/discovery/artifactregistry-v1beta1.json b/discovery/artifactregistry-v1beta1.json index 3c2ff8f62a..da70353f3a 100644 --- a/discovery/artifactregistry-v1beta1.json +++ b/discovery/artifactregistry-v1beta1.json @@ -21,8 +21,53 @@ "endpoints": [ { "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", - "description": "Regional Endpoint", - "location": "me-central2" + "location": "me-central2", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://apt.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://docker.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://go.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://googet.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://kfp.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://maven.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://npm.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://python.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://yum.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -238,7 +283,7 @@ "type": "string" }, "repositoryId": { - "description": "The repository id to use for this repository.", + "description": "Required. The repository id to use for this repository.", "location": "query", "type": "string" } @@ -936,7 +981,7 @@ } } }, - "revision": "20230918", + "revision": "20231006", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "Binding": { diff --git a/discovery/artifactregistry-v1beta2.json b/discovery/artifactregistry-v1beta2.json index 3822842d7b..b3d5c75b4d 100644 --- a/discovery/artifactregistry-v1beta2.json +++ b/discovery/artifactregistry-v1beta2.json @@ -21,8 +21,53 @@ "endpoints": [ { "endpointUrl": "https://artifactregistry.me-central2.rep.googleapis.com/", - "description": "Regional Endpoint", - "location": "me-central2" + "location": "me-central2", + "description": "Regional Endpoint" + }, + { + "endpointUrl": "https://apt.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://docker.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://go.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://googet.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://kfp.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://maven.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://npm.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://python.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" + }, + { + "endpointUrl": "https://yum.me-central2.rep.pkg.dev/", + "location": "me-central2", + "description": "Locational Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -300,7 +345,7 @@ "type": "string" }, "repositoryId": { - "description": "The repository id to use for this repository.", + "description": "Required. The repository id to use for this repository.", "location": "query", "type": "string" } @@ -1142,7 +1187,7 @@ } } }, - "revision": "20230913", + "revision": "20231006", "rootUrl": "https://artifactregistry.googleapis.com/", "schemas": { "AptArtifact": { diff --git a/discovery/backupdr-v1.json b/discovery/backupdr-v1.json new file mode 100644 index 0000000000..4bc0fe65ad --- /dev/null +++ b/discovery/backupdr-v1.json @@ -0,0 +1,1068 @@ +{ + "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://backupdr.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Backupdr", + "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": "backupdr:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://backupdr.mtls.googleapis.com/", + "name": "backupdr", + "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": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "backupdr.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": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "managementServers": { + "methods": { + "create": { + "description": "Creates a new ManagementServer in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "managementServerId": { + "description": "Required. The name of the management server to create. The name must be unique for the specified project and location.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The management server project and location in the format `projects/{project_id}/locations/{location}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/managementServers", + "request": { + "$ref": "ManagementServer" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a single ManagementServer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.managementServers.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the resource", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of a single ManagementServer.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the management server resource name, in the format `projects/{project_id}/locations/{location}/managementServers/{resource_name}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "ManagementServer" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:getIamPolicy", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists ManagementServers in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers", + "httpMethod": "GET", + "id": "backupdr.projects.locations.managementServers.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id}/locations/{location}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use \"-\" for the `{location}` value.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/managementServers", + "response": { + "$ref": "ListManagementServersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:setIamPolicy", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.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/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/managementServers/{managementServersId}:testIamPermissions", + "httpMethod": "POST", + "id": "backupdr.projects.locations.managementServers.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/[^/]+/managementServers/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "httpMethod": "POST", + "id": "backupdr.projects.locations.operations.cancel", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "backupdr.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "backupdr.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "backupdr.projects.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": "^projects/[^/]+/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": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20231001", + "rootUrl": "https://backupdr.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" + }, + "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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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.", + "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" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "id": "CancelOperationRequest", + "properties": {}, + "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" + }, + "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" + }, + "ListManagementServersResponse": { + "description": "Response message for listing management servers.", + "id": "ListManagementServersResponse", + "properties": { + "managementServers": { + "description": "The list of ManagementServer instances in the project for the specified location. If the `{location}` value in the request is \"-\", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations.", + "items": { + "$ref": "ManagementServer" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results the server should return.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "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": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud 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" + }, + "ManagementServer": { + "description": "ManagementServer describes a single BackupDR ManagementServer instance.", + "id": "ManagementServer", + "properties": { + "createTime": { + "description": "Output only. The time when the instance was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. The description of the ManagementServer instance (2048 characters or less).", + "type": "string" + }, + "etag": { + "description": "Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode.", + "type": "object" + }, + "managementUri": { + "$ref": "ManagementURI", + "description": "Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name.", + "readOnly": true, + "type": "string" + }, + "networks": { + "description": "Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported.", + "items": { + "$ref": "NetworkConfig" + }, + "type": "array" + }, + "oauth2ClientId": { + "description": "Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken).", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The ManagementServer state.", + "enum": [ + "INSTANCE_STATE_UNSPECIFIED", + "CREATING", + "READY", + "UPDATING", + "DELETING", + "REPAIRING", + "MAINTENANCE", + "ERROR" + ], + "enumDescriptions": [ + "State not set.", + "The instance is being created.", + "The instance has been created and is fully usable.", + "The instance configuration is being updated. Certain kinds of updates may cause the instance to become unusable while the update is in progress.", + "The instance is being deleted.", + "The instance is being repaired and may be unstable.", + "Maintenance is being performed on this instance.", + "The instance is experiencing an issue and might be unusable. You can get further details from the statusMessage field of Instance resource." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Required. The type of the ManagementServer resource.", + "enum": [ + "INSTANCE_TYPE_UNSPECIFIED", + "BACKUP_RESTORE" + ], + "enumDescriptions": [ + "Instance type is not mentioned.", + "Instance for backup and restore management (i.e., AGM)." + ], + "type": "string" + }, + "updateTime": { + "description": "Output only. The time when the instance was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ManagementURI": { + "description": "ManagementURI for the Management Server resource.", + "id": "ManagementURI", + "properties": { + "api": { + "description": "Output only. The ManagementServer AGM/RD API URL.", + "readOnly": true, + "type": "string" + }, + "webUi": { + "description": "Output only. The ManagementServer AGM/RD WebUI URL.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NetworkConfig": { + "description": "Network configuration for ManagementServer instance.", + "id": "NetworkConfig", + "properties": { + "network": { + "description": "Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected.", + "type": "string" + }, + "peeringMode": { + "description": "Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported.", + "enum": [ + "PEERING_MODE_UNSPECIFIED", + "PRIVATE_SERVICE_ACCESS" + ], + "enumDescriptions": [ + "Peering mode not set.", + "Connect using Private Service Access to the Management Server. Private services access provides an IP address range for multiple Google Cloud services, including Cloud BackupDR." + ], + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "id": "OperationMetadata", + "properties": { + "additionalInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. AdditionalInfo contains additional Info related to backup plan association resource.", + "readOnly": true, + "type": "object" + }, + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "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" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "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" + }, + "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" + }, + "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" + }, + "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": "Backup and DR Service API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/baremetalsolution-v2.json b/discovery/baremetalsolution-v2.json index 2a1aaff494..aceb6a76ad 100644 --- a/discovery/baremetalsolution-v2.json +++ b/discovery/baremetalsolution-v2.json @@ -345,7 +345,7 @@ "type": "string" }, "updateMask": { - "description": "The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image`", + "description": "The list of fields to update. The currently supported fields are: `labels` `hyperthreading_enabled` `os_image` `ssh_keys`", "format": "google-fieldmask", "location": "query", "type": "string" @@ -849,6 +849,31 @@ }, "osImages": { "methods": { + "get": { + "description": "Get details of a single OS image.", + "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/osImages/{osImagesId}", + "httpMethod": "GET", + "id": "baremetalsolution.projects.locations.osImages.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the OS image.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/osImages/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v2/{+name}", + "response": { + "$ref": "OSImage" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Retrieves the list of OS images which are currently approved.", "flatPath": "v2/projects/{projectsId}/locations/{locationsId}/osImages", @@ -870,7 +895,7 @@ "type": "string" }, "parent": { - "description": "Required. Parent value for ListProvisioningQuotasRequest.", + "description": "Required. Parent value for ListOSImagesRequest.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, @@ -1588,7 +1613,7 @@ } } }, - "revision": "20230906", + "revision": "20231004", "rootUrl": "https://baremetalsolution.googleapis.com/", "schemas": { "AllowedClient": { diff --git a/discovery/batch-v1.json b/discovery/batch-v1.json index a299d6a8de..0f95fa26e4 100644 --- a/discovery/batch-v1.json +++ b/discovery/batch-v1.json @@ -561,7 +561,7 @@ } } }, - "revision": "20230914", + "revision": "20230929", "rootUrl": "https://batch.googleapis.com/", "schemas": { "Accelerator": { @@ -1859,6 +1859,10 @@ "$ref": "Container", "description": "Container runnable." }, + "displayName": { + "description": "Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs.", + "type": "string" + }, "environment": { "$ref": "Environment", "description": "Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup)." diff --git a/discovery/beyondcorp-v1alpha.json b/discovery/beyondcorp-v1alpha.json index f3b9f6fcc0..4d09a6803e 100644 --- a/discovery/beyondcorp-v1alpha.json +++ b/discovery/beyondcorp-v1alpha.json @@ -3674,7 +3674,7 @@ } } }, - "revision": "20230911", + "revision": "20231002", "rootUrl": "https://beyondcorp.googleapis.com/", "schemas": { "AllocatedConnection": { @@ -5259,6 +5259,10 @@ "readOnly": true, "type": "string" }, + "proxyProtocolConfig": { + "$ref": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig", + "description": "Optional. Protocol config data for the Proxy." + }, "proxyUri": { "description": "Required. The URI of the proxy server.", "type": "string" @@ -5280,6 +5284,20 @@ }, "type": "object" }, + "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig": { + "description": "The protocol data that specifies how to communicate with Partner's Proxy.", + "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig", + "properties": { + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Untyped property bag to be sent back to the proxy using client specific mechanism.", + "type": "object" + } + }, + "type": "object" + }, "GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo": { "description": "Message contains the routing information to direct traffic to the proxy server.", "id": "GoogleCloudBeyondcorpPartnerservicesV1alphaRoutingInfo", diff --git a/discovery/bigqueryreservation-v1.json b/discovery/bigqueryreservation-v1.json index 525add630c..4516d73a72 100644 --- a/discovery/bigqueryreservation-v1.json +++ b/discovery/bigqueryreservation-v1.json @@ -18,6 +18,13 @@ "description": "A service to modify your BigQuery flat-rate reservations.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/bigquery/", + "endpoints": [ + { + "endpointUrl": "https://bigqueryreservation.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -824,7 +831,7 @@ } } }, - "revision": "20230801", + "revision": "20231007", "rootUrl": "https://bigqueryreservation.googleapis.com/", "schemas": { "Assignment": { diff --git a/discovery/binaryauthorization-v1.json b/discovery/binaryauthorization-v1.json index 39ce0ca2e6..0b5908ea9a 100644 --- a/discovery/binaryauthorization-v1.json +++ b/discovery/binaryauthorization-v1.json @@ -706,7 +706,7 @@ } } }, - "revision": "20230908", + "revision": "20230929", "rootUrl": "https://binaryauthorization.googleapis.com/", "schemas": { "AdmissionRule": { @@ -1105,6 +1105,10 @@ "description": "A public key in the PkixPublicKey [format](https://tools.ietf.org/html/rfc5280#section-4.1.2.7). Public keys of this type are typically textually encoded using the PEM format.", "id": "PkixPublicKey", "properties": { + "keyId": { + "description": "Optional. The ID of this public key. Signatures verified by Binary Authorization must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. This may be explicitly provided by the caller, but it MUST be a valid RFC3986 URI. If `key_id` is left blank and this `PkixPublicKey` is not used in the context of a wrapper (see next paragraph), a default key ID will be computed based on the digest of the DER encoding of the public key. If this `PkixPublicKey` is used in the context of a wrapper that has its own notion of key ID (e.g. `AttestorPublicKey`), then this field can either: * Match that value exactly. * Or be left blank, in which case it behaves exactly as though it is equal to that wrapper value.", + "type": "string" + }, "publicKeyPem": { "description": "A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13", "type": "string" diff --git a/discovery/blockchainnodeengine-v1.json b/discovery/blockchainnodeengine-v1.json index f893d091e7..0446a6cbfa 100644 --- a/discovery/blockchainnodeengine-v1.json +++ b/discovery/blockchainnodeengine-v1.json @@ -487,7 +487,7 @@ } } }, - "revision": "20230914", + "revision": "20230927", "rootUrl": "https://blockchainnodeengine.googleapis.com/", "schemas": { "BlockchainNode": { @@ -624,6 +624,10 @@ "description": "Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.", "type": "boolean" }, + "beaconFeeRecipient": { + "description": "An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as \"suggested\", as we run the execution node we can trust the execution node, and therefore this is considered enforced.", + "type": "string" + }, "consensusClient": { "description": "Immutable. The consensus client.", "enum": [ diff --git a/discovery/chat-v1.json b/discovery/chat-v1.json index 7c34e64ff6..f8fc921fba 100644 --- a/discovery/chat-v1.json +++ b/discovery/chat-v1.json @@ -304,7 +304,7 @@ ] }, "get": { - "description": "Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User authentication](https://developers.google.com/chat/api/guides/auth/users).", + "description": "Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users).", "flatPath": "v1/spaces/{spacesId}", "httpMethod": "GET", "id": "chat.spaces.get", @@ -474,6 +474,7 @@ "$ref": "Membership" }, "scopes": [ + "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.app" ] @@ -549,6 +550,7 @@ }, "scopes": [ "https://www.googleapis.com/auth/chat.bot", + "https://www.googleapis.com/auth/chat.import", "https://www.googleapis.com/auth/chat.memberships", "https://www.googleapis.com/auth/chat.memberships.readonly" ] @@ -955,7 +957,7 @@ } } }, - "revision": "20230914", + "revision": "20231008", "rootUrl": "https://chat.googleapis.com/", "schemas": { "ActionParameter": { @@ -1062,7 +1064,7 @@ "type": "object" }, "Annotation": { - "description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/api/guides/message-formats/text#format-texts). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", + "description": "Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!\" ``` The corresponding annotations metadata: ``` \"annotations\":[{ \"type\":\"USER_MENTION\", \"startIndex\":6, \"length\":7, \"userMention\": { \"user\": { \"name\":\"users/{user}\", \"displayName\":\"FooBot\", \"avatarUrl\":\"https://goo.gl/aeDtrS\", \"type\":\"BOT\" }, \"type\":\"MENTION\" } }] ```", "id": "Annotation", "properties": { "length": { @@ -1710,7 +1712,7 @@ "type": "array" }, "persistValues": { - "description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.", + "description": "Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`.", "type": "boolean" } }, @@ -1833,7 +1835,7 @@ }, "fixedFooter": { "$ref": "GoogleAppsCardV1CardFixedFooter", - "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards)." + "description": "The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create)." }, "header": { "$ref": "GoogleAppsCardV1CardHeader", @@ -1887,7 +1889,7 @@ "type": "object" }, "GoogleAppsCardV1CardFixedFooter": { - "description": "A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards).", + "description": "A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create).", "id": "GoogleAppsCardV1CardFixedFooter", "properties": { "primaryButton": { @@ -2067,7 +2069,7 @@ }, "endIcon": { "$ref": "GoogleAppsCardV1Icon", - "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons." + "description": "An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons." }, "icon": { "$ref": "GoogleAppsCardV1Icon", @@ -2087,7 +2089,7 @@ "description": "A switch widget that a user can click to change its state and trigger an action." }, "text": { - "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "topLabel": { @@ -2176,7 +2178,7 @@ "type": "object" }, "GoogleAppsCardV1Icon": { - "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons.", + "description": "An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons.", "id": "GoogleAppsCardV1Icon", "properties": { "altText": { @@ -2200,7 +2202,7 @@ "type": "string" }, "knownIcon": { - "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons).", + "description": "Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons).", "type": "string" } }, @@ -2368,7 +2370,7 @@ "type": "boolean" }, "header": { - "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "uncollapsibleWidgetsCount": { @@ -2589,7 +2591,7 @@ "type": "object" }, "GoogleAppsCardV1TextParagraph": { - "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards##card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "id": "GoogleAppsCardV1TextParagraph", "properties": { "text": { @@ -2657,7 +2659,7 @@ }, "textParagraph": { "$ref": "GoogleAppsCardV1TextParagraph", - "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" + "description": "Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` \"textParagraph\": { \"text\": \" *bold text*\" } ```" } }, "type": "object" @@ -2845,7 +2847,7 @@ "id": "KeyValue", "properties": { "bottomLabel": { - "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "button": { @@ -2853,7 +2855,7 @@ "description": "A button that can be clicked to trigger an action." }, "content": { - "description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "contentMultiline": { @@ -2939,7 +2941,7 @@ "description": "The `onclick` action. Only the top label, bottom label, and content region are clickable." }, "topLabel": { - "description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" } }, @@ -3055,7 +3057,7 @@ "type": "string" }, "role": { - "description": "Output only. User's role within a Chat space, which determines their permitted actions in the space.", + "description": "Optional. User's role within a Chat space, which determines their permitted actions in the space. [Developer Preview](https://developers.google.com/workspace/preview): This field can only be used as input in `UpdateMembership`.", "enum": [ "MEMBERSHIP_ROLE_UNSPECIFIED", "ROLE_MEMBER", @@ -3066,7 +3068,6 @@ "A member of the space. The user has basic permissions, like sending messages to the space. In 1:1 and unnamed group conversations, everyone has this role.", "A space manager. The user has all basic permissions plus administrative permissions that let them manage the space, like adding or removing members. Only supported in SpaceType.SPACE." ], - "readOnly": true, "type": "string" }, "state": { @@ -3172,6 +3173,11 @@ "description": "A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications.", "type": "string" }, + "formattedText": { + "description": "Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url}|{rendered_text}>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message)", + "readOnly": true, + "type": "string" + }, "lastUpdateTime": { "description": "Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty.", "format": "google-datetime", @@ -3207,7 +3213,7 @@ "description": "If your Chat app [authenticates as a user](https://developers.google.com/chat/api/guides/auth/users), the output populates the [space](https://developers.google.com/chat/api/reference/rest/v1/spaces) `name`." }, "text": { - "description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/api/guides/message-formats/text#messages-@mention), or everyone in the space. To learn about creating text messages, see [Create a text message](https://developers.google.com/chat/api/guides/message-formats/text).", + "description": "Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/chat/api/guides/v1/messages/create#create-text-messages).", "type": "string" }, "thread": { @@ -3291,7 +3297,7 @@ "id": "Section", "properties": { "header": { - "description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "type": "string" }, "widgets": { @@ -3559,7 +3565,7 @@ "type": "object" }, "TextParagraph": { - "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", + "description": "A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting).", "id": "TextParagraph", "properties": { "text": { diff --git a/discovery/chromepolicy-v1.json b/discovery/chromepolicy-v1.json index ff49472cef..9c82cf30a0 100644 --- a/discovery/chromepolicy-v1.json +++ b/discovery/chromepolicy-v1.json @@ -557,48 +557,9 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://chromepolicy.googleapis.com/", "schemas": { - "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle": { - "id": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle", - "properties": { - "deprecatedInFavorOf": { - "description": "In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI.", - "items": { - "type": "string" - }, - "type": "array" - }, - "description": { - "description": "Description about current life cycle.", - "type": "string" - }, - "endSupport": { - "$ref": "GoogleTypeDate", - "description": "End supporting date for current policy." - }, - "policyApiLifecycleStage": { - "description": "Indicate current life cycle stage of the policy API.", - "enum": [ - "API_UNSPECIFIED", - "API_PREVIEW", - "API_DEVELOPMENT", - "API_CURRENT", - "API_DEPRECATED" - ], - "enumDescriptions": [ - "unspecified.", - "Policy is not working yet, but giving developers heads up on format. This stage can transfer to API_DEVELOPEMNT or API_CURRENT.", - "Policy can change format in backward incompatible way (breaking change). This stage can transfer to API_CURRENT or API_DEPRECATED. This could be used for policies launched only to TTs or launched to selected customers for emergency usage.", - "Policy in official format. Policy can change format in backward compatible way (non-breaking change). Example: this policy can introduce a new field, which is considered non-breaking change, when field masks are properly utilized. This stage can transfer to API_DEPRECATED.", - "Please stop using this policy. This policy is deprecated and may/will be removed in the future. Most likely a new policy was introduced to replace this one." - ], - "type": "string" - } - }, - "type": "object" - }, "GoogleChromePolicyVersionsV1AdditionalTargetKeyName": { "description": "Additional key names that will be used to identify the target of the policy value.", "id": "GoogleChromePolicyVersionsV1AdditionalTargetKeyName", @@ -963,6 +924,53 @@ }, "type": "object" }, + "GoogleChromePolicyVersionsV1PolicyApiLifecycle": { + "description": "Lifecycle information.", + "id": "GoogleChromePolicyVersionsV1PolicyApiLifecycle", + "properties": { + "deprecatedInFavorOf": { + "description": "In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI. Could only be set if policy_api_lifecycle_stage is API_DEPRECATED.", + "items": { + "type": "string" + }, + "type": "array" + }, + "description": { + "description": "Description about current life cycle.", + "type": "string" + }, + "endSupport": { + "$ref": "GoogleTypeDate", + "description": "End supporting date for current policy. Attempting to modify a policy after its end support date will result in a Bad Request (400 error). Could only be set if policy_api_lifecycle_stage is API_DEPRECATED." + }, + "policyApiLifecycleStage": { + "description": "Indicates current life cycle stage of the policy API.", + "enum": [ + "API_UNSPECIFIED", + "API_PREVIEW", + "API_DEVELOPMENT", + "API_CURRENT", + "API_DEPRECATED" + ], + "enumDescriptions": [ + "Policy Api Lifecycle is Unspecified.", + "Policy is not working yet, but giving developers heads up on format. This stage can transfer to API_DEVELOPEMNT or API_CURRENT.", + "Policy can change format in backward incompatible way (breaking change). This stage can transfer to API_CURRENT or API_DEPRECATED. This could be used for policies launched only to TTs or launched to selected customers for emergency usage.", + "Policy in official format. Policy can change format in backward compatible way (non-breaking change). Example: this policy can introduce a new field, which is considered non-breaking change, when field masks are properly utilized. This stage can transfer to API_DEPRECATED.", + "Please stop using this policy. This policy is deprecated and may/will be removed in the future. Most likely a new policy was introduced to replace this one." + ], + "type": "string" + }, + "scheduledToDeprecatePolicies": { + "description": "Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. This field should not be manually set but will be set and exposed through PolicyAPI automatically.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleChromePolicyVersionsV1PolicyModificationError": { "description": "Error information for a modification request of a specific policy on a specific target.", "id": "GoogleChromePolicyVersionsV1PolicyModificationError", @@ -1077,7 +1085,7 @@ "type": "array" }, "policyApiLifecycle": { - "$ref": "ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle", + "$ref": "GoogleChromePolicyVersionsV1PolicyApiLifecycle", "description": "Output only. Current lifecycle information.", "readOnly": true }, @@ -1678,26 +1686,9 @@ "description": "Describes a complete .proto file.", "id": "Proto2FileDescriptorProto", "properties": { - "editionEnum": { - "description": "The edition of the proto file.", - "enum": [ - "EDITION_UNKNOWN", - "EDITION_2023", - "EDITION_1_TEST_ONLY", - "EDITION_2_TEST_ONLY", - "EDITION_99997_TEST_ONLY", - "EDITION_99998_TEST_ONLY", - "EDITION_99999_TEST_ONLY" - ], - "enumDescriptions": [ - "A placeholder for an unknown edition value.", - "Editions that have been released. The specific values are arbitrary and should not be depended on, but they will always be time-ordered for easy comparison.", - "Placeholder editions for testing feature resolution. These should not be used or relyed on outside of tests.", - "", - "", - "", - "" - ], + "editionDeprecated": { + "deprecated": true, + "description": "BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL", "type": "string" }, "enumType": { diff --git a/discovery/cloudasset-v1.json b/discovery/cloudasset-v1.json index f02a0b8cec..c55ed36191 100644 --- a/discovery/cloudasset-v1.json +++ b/discovery/cloudasset-v1.json @@ -1050,7 +1050,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add \" DESC\" after the field name to indicate descending order. Redundant space characters are ignored. Example: \"location DESC, name\". Only singular primitive fields in the response are sortable: * name * assetType * project * displayName * description * location * createTime * updateTime * state * parentFullResourceName * parentAssetType All the other fields such as repeated fields (e.g., `networkTags`, `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`) are not supported.", + "description": "Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add \" DESC\" after the field name to indicate descending order. Redundant space characters are ignored. Example: \"location DESC, name\". Only the following fields in the response are sortable: * name * assetType * project * displayName * description * location * createTime * updateTime * state * parentFullResourceName * parentAssetType", "location": "query", "type": "string" }, @@ -1066,12 +1066,12 @@ "type": "string" }, "query": { - "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Google Cloud resources whose name contains \"Important\" as a word. * `name=Important` to find the Google Cloud resource whose name is exactly \"Important\". * `displayName:Impor*` to find Google Cloud resources whose display name contains \"Impor\" as a prefix of any word in the field. * `location:us-west*` to find Google Cloud resources whose location contains both \"us\" and \"west\" as prefixes. * `labels:prod` to find Google Cloud resources whose labels contain \"prod\" as a key or value. * `labels.env:prod` to find Google Cloud resources that have a label \"env\" and its value is \"prod\". * `labels.env:*` to find Google Cloud resources that have a label \"env\". * `kmsKey:key` to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains \"key\" as a word. This field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key information. * `kmsKeys:key` to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word \"key\". * `relationships:instance-group-1` to find Google Cloud resources that have relationships with \"instance-group-1\" in the related resource name. * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances that have relationships of type \"INSTANCE_TO_INSTANCEGROUP\". * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute Engine instances that have relationships with \"instance-group-1\" in the Compute Engine instance group resource name, for relationship type \"INSTANCE_TO_INSTANCEGROUP\". * `state:ACTIVE` to find Google Cloud resources whose state contains \"ACTIVE\" as a word. * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't contain \"ACTIVE\" as a word. * `createTime<1609459200` to find Google Cloud resources that were created before \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `updateTime>1609459200` to find Google Cloud resources that were updated after \"2021-01-01 00:00:00 UTC\". 1609459200 is the epoch timestamp of \"2021-01-01 00:00:00 UTC\" in seconds. * `Important` to find Google Cloud resources that contain \"Important\" as a word in any of the searchable fields. * `Impor*` to find Google Cloud resources that contain \"Impor\" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Google Cloud resources that contain \"Important\" as a word in any of the searchable fields and are also located in the \"us-west1\" region or the \"global\" location.", + "description": "Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Google Cloud resources whose name contains `Important` as a word. * `name=Important` to find the Google Cloud resource whose name is exactly `Important`. * `displayName:Impor*` to find Google Cloud resources whose display name contains `Impor` as a prefix of any word in the field. * `location:us-west*` to find Google Cloud resources whose location contains both `us` and `west` as prefixes. * `labels:prod` to find Google Cloud resources whose labels contain `prod` as a key or value. * `labels.env:prod` to find Google Cloud resources that have a label `env` and its value is `prod`. * `labels.env:*` to find Google Cloud resources that have a label `env`. * `tagKeys:env` to find Google Cloud resources that have directly attached tags where the [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName` contains `env`. * `tagValues:prod*` to find Google Cloud resources that have directly attached tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName` contains a word prefixed by `prod`. * `tagValueIds=tagValues/123` to find Google Cloud resources that have directly attached tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly `tagValues/123`. * `effectiveTagKeys:env` to find Google Cloud resources that have directly attached or inherited tags where the [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName` contains `env`. * `effectiveTagValues:prod*` to find Google Cloud resources that have directly attached or inherited tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName` contains a word prefixed by `prod`. * `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that have directly attached or inherited tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly `tagValues/123`. * `kmsKey:key` to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains `key` as a word. This field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key information. * `kmsKeys:key` to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word `key`. * `relationships:instance-group-1` to find Google Cloud resources that have relationships with `instance-group-1` in the related resource name. * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances that have relationships of type `INSTANCE_TO_INSTANCEGROUP`. * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute Engine instances that have relationships with `instance-group-1` in the Compute Engine instance group resource name, for relationship type `INSTANCE_TO_INSTANCEGROUP`. * `sccSecurityMarks.key=value` to find Cloud resources that are attached with security marks whose key is `key` and value is `value'. * `sccSecurityMarks.key:*` to find Cloud resources that are attached with security marks whose key is `key`. * `state:ACTIVE` to find Google Cloud resources whose state contains `ACTIVE` as a word. * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't contain `ACTIVE` as a word. * `createTime<1609459200` to find Google Cloud resources that were created before `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of `2021-01-01 00:00:00 UTC` in seconds. * `updateTime>1609459200` to find Google Cloud resources that were updated after `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of `2021-01-01 00:00:00 UTC` in seconds. * `Important` to find Google Cloud resources that contain `Important` as a word in any of the searchable fields. * `Impor*` to find Google Cloud resources that contain `Impor` as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Google Cloud resources that contain `Important` as a word in any of the searchable fields and are also located in the `us-west1` region or the `global` location.", "location": "query", "type": "string" }, "readMask": { - "description": "Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * `name` * `assetType` * `project` * `folders` * `organization` * `displayName` * `description` * `location` * `labels` * `networkTags` * `kmsKeys` * `createTime` * `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` * `parentAssetType` Some fields of large size, such as `versionedResources` and `attachedResources`, are not returned by default, but you can specify them in the `read_mask` parameter if you want to include them. If `\"*\"` is specified, all [available fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are returned. Examples: `\"name,location\"`, `\"name,versionedResources\"`, `\"*\"`. Any invalid field path will trigger INVALID_ARGUMENT error.", + "description": "Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * `name` * `assetType` * `project` * `folders` * `organization` * `displayName` * `description` * `location` * `labels` * `tags` * `effectiveTags` * `networkTags` * `kmsKeys` * `createTime` * `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` * `parentAssetType` Some fields of large size, such as `versionedResources`, `attachedResources`, `effectiveTags` etc., are not returned by default, but you can specify them in the `read_mask` parameter if you want to include them. If `\"*\"` is specified, all [available fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are returned. Examples: `\"name,location\"`, `\"name,versionedResources\"`, `\"*\"`. Any invalid field path will trigger INVALID_ARGUMENT error.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -1095,7 +1095,7 @@ } } }, - "revision": "20230916", + "revision": "20231006", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AccessSelector": { @@ -1604,6 +1604,24 @@ }, "type": "object" }, + "EffectiveTagDetails": { + "description": "The effective tags and the ancestor resources from which they were inherited.", + "id": "EffectiveTagDetails", + "properties": { + "attachedResource": { + "description": "The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the ancestor from which an effective_tag is inherited, according to [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance).", + "type": "string" + }, + "effectiveTags": { + "description": "The effective tags inherited from the attached_resource. Note that tags with the same key but different values may attach to resources at a different hierarchy levels. The lower hierarchy tag value will overwrite the higher hierarchy tag value of the same tag key. In this case, the tag value at the higher hierarchy level will be removed. For more information, see [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance).", + "items": { + "$ref": "Tag" + }, + "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", @@ -4036,6 +4054,13 @@ "description": "The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the `display_name`: * Use a field query. Example: `displayName:\"My Instance\"` * Use a free text query. Example: `\"My Instance\"`", "type": "string" }, + "effectiveTags": { + "description": "The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance). To search against the `effective_tags`: * Use a field query. Example: - `effectiveTagKeys:\"123456789/env*\"` - `effectiveTagKeys=\"123456789/env\"` - `effectiveTagKeys:\"env\"` - `effectiveTagValues:\"env\"` - `effectiveTagValues:\"env/prod\"` - `effectiveTagValues:\"123456789/env/prod*\"` - `effectiveTagValues=\"123456789/env/prod\"` - `effectiveTagValueIds=\"tagValues/456\"`", + "items": { + "$ref": "EffectiveTagDetails" + }, + "type": "array" + }, "folders": { "description": "The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER}. This field is available when the resource belongs to one or more folders. To search against `folders`: * Use a field query. Example: `folders:(123 OR 456)` * Use a free text query. Example: `123` * Specify the `scope` field as this folder in your search request.", "items": { @@ -4112,26 +4137,36 @@ "type": "string" }, "tagKeys": { - "description": "TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the `tagKeys`: * Use a field query. Example: - `tagKeys:\"123456789/env*\"` - `tagKeys=\"123456789/env\"` - `tagKeys:\"env\"` * Use a free text query. Example: - `env`", + "deprecated": true, + "description": "This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagKey namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}. To search against the `tagKeys`: * Use a field query. Example: - `tagKeys:\"123456789/env*\"` - `tagKeys=\"123456789/env\"` - `tagKeys:\"env\"` * Use a free text query. Example: - `env`", "items": { "type": "string" }, "type": "array" }, "tagValueIds": { - "description": "TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the `tagValueIds`: * Use a field query. Example: - `tagValueIds=\"tagValues/456\"`", + "deprecated": true, + "description": "This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagValue IDs, in the format of tagValues/{TAG_VALUE_ID}. To search against the `tagValueIds`: * Use a field query. Example: - `tagValueIds=\"tagValues/456\"` * Use a free text query. Example: - `456`", "items": { "type": "string" }, "type": "array" }, "tagValues": { - "description": "TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the `tagValues`: * Use a field query. Example: - `tagValues:\"env\"` - `tagValues:\"env/prod\"` - `tagValues:\"123456789/env/prod*\"` - `tagValues=\"123456789/env/prod\"` * Use a free text query. Example: - `prod`", + "deprecated": true, + "description": "This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagValue namespaced names, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}. To search against the `tagValues`: * Use a field query. Example: - `tagValues:\"env\"` - `tagValues:\"env/prod\"` - `tagValues:\"123456789/env/prod*\"` - `tagValues=\"123456789/env/prod\"` * Use a free text query. Example: - `prod`", "items": { "type": "string" }, "type": "array" }, + "tags": { + "description": "The tags directly attached to this resource. To search against the `tags`: * Use a field query. Example: - `tagKeys:\"123456789/env*\"` - `tagKeys=\"123456789/env\"` - `tagKeys:\"env\"` - `tagValues:\"env\"` - `tagValues:\"env/prod\"` - `tagValues:\"123456789/env/prod*\"` - `tagValues=\"123456789/env/prod\"` - `tagValueIds=\"tagValues/456\"` * Use a free text query. Example: - `env/prod`", + "items": { + "$ref": "Tag" + }, + "type": "array" + }, "updateTime": { "description": "The last update timestamp of this resource, at which the resource was last modified or deleted. The granularity is in seconds. Timestamp.nanos will always be 0. This field is available only when the resource's Protobuf contains it. To search against `update_time`: * Use a field query. - value in seconds since unix epoch. Example: `updateTime < 1609459200` - value in date string. Example: `updateTime < 2021-01-01` - value in date-time string (must be quoted). Example: `updateTime < \"2021-01-01T00:00:00\"`", "format": "google-datetime", @@ -4352,6 +4387,25 @@ }, "type": "object" }, + "Tag": { + "description": "The key and value for a [tag](https://cloud.google.com/resource-manager/docs/tags/tags-overview),", + "id": "Tag", + "properties": { + "tagKey": { + "description": "TagKey namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}.", + "type": "string" + }, + "tagValue": { + "description": "TagValue namespaced name, in the format of {ORG_ID}/{TAG_KEY_SHORT_NAME}/{TAG_VALUE_SHORT_NAME}.", + "type": "string" + }, + "tagValueId": { + "description": "TagValue ID, in the format of tagValues/{TAG_VALUE_ID}.", + "type": "string" + } + }, + "type": "object" + }, "TemporalAsset": { "description": "An asset in Google Cloud and its temporal metadata, including the time window when it was observed and its status during that window.", "id": "TemporalAsset", diff --git a/discovery/cloudbuild-v1.json b/discovery/cloudbuild-v1.json index b7c3fec900..1ef9aaa190 100644 --- a/discovery/cloudbuild-v1.json +++ b/discovery/cloudbuild-v1.json @@ -2319,7 +2319,7 @@ } } }, - "revision": "20230907", + "revision": "20230920", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "ApprovalConfig": { @@ -2595,6 +2595,10 @@ "description": "Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project}/global/networks/{network}`, where {project} is a project number or id and {network} is the name of a VPC network in the project.", "type": "string" }, + "peeredNetworkIpRange": { + "description": "Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set.", + "type": "string" + }, "secrets": { "$ref": "BitbucketServerSecrets", "description": "Required. Secret Manager secrets needed by the config." @@ -4969,6 +4973,16 @@ "readOnly": true, "type": "object" }, + "resolvedConnectedRepository": { + "$ref": "ConnectedRepository", + "description": "Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved.", + "readOnly": true + }, + "resolvedGitSource": { + "$ref": "GitSource", + "description": "Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved.", + "readOnly": true + }, "resolvedRepoSource": { "$ref": "RepoSource", "description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved." diff --git a/discovery/cloudbuild-v2.json b/discovery/cloudbuild-v2.json index 0b58847006..aa9461fe76 100644 --- a/discovery/cloudbuild-v2.json +++ b/discovery/cloudbuild-v2.json @@ -844,7 +844,7 @@ } } }, - "revision": "20230907", + "revision": "20230920", "rootUrl": "https://cloudbuild.googleapis.com/", "schemas": { "AuditConfig": { @@ -2641,27 +2641,13 @@ "description": "Operator that represents an Input's relationship to the values", "enum": [ "EXPRESSION_OPERATOR_UNSPECIFIED", - "DOES_NOT_EXIST", - "EQUALS", - "DOUBLE_EQUALS", "IN", - "NOT_EQUALS", - "NOT_IN", - "EXISTS", - "GREATER_THAN", - "LESS_THAN" + "NOT_IN" ], "enumDescriptions": [ "Default enum type; should not be used.", - "Input does not exist.", - "Input equals values.", - "Input double equals values.", "Input is in values.", - "Input does not equal values.", - "Input is not in values.", - "Input exists.", - "Input is greater than values.", - "Input is less than values." + "Input is not in values." ], "type": "string" }, diff --git a/discovery/clouddeploy-v1.json b/discovery/clouddeploy-v1.json index cd78519665..d439e07ab1 100644 --- a/discovery/clouddeploy-v1.json +++ b/discovery/clouddeploy-v1.json @@ -1479,7 +1479,7 @@ } } }, - "revision": "20230913", + "revision": "20231004", "rootUrl": "https://clouddeploy.googleapis.com/", "schemas": { "AbandonReleaseRequest": { @@ -1635,6 +1635,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -1644,6 +1645,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -1653,6 +1655,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -1697,6 +1700,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -1706,6 +1710,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -1715,6 +1720,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2085,6 +2091,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2094,6 +2101,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2103,6 +2111,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -2604,6 +2613,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -2613,6 +2623,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -2622,6 +2633,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3440,6 +3452,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3449,6 +3462,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3458,6 +3472,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -3802,6 +3817,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -3811,6 +3827,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -3820,6 +3837,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4183,6 +4201,7 @@ "TYPE_PROCESS_ABORTED", "TYPE_RESTRICTION_VIOLATED", "TYPE_RESOURCE_DELETED", + "TYPE_ROLLOUT_UPDATE", "TYPE_RENDER_STATUES_CHANGE" ], "enumDeprecated": [ @@ -4192,6 +4211,7 @@ false, false, false, + false, true ], "enumDescriptions": [ @@ -4201,6 +4221,7 @@ "A process aborted.", "Restriction check failed.", "Resource deleted.", + "Rollout updated.", "Deprecated: This field is never used. Use release_render log type instead." ], "type": "string" @@ -4219,6 +4240,7 @@ "CLOUD_BUILD_UNAVAILABLE", "EXECUTION_FAILED", "CLOUD_BUILD_REQUEST_FAILED", + "VERIFICATION_CONFIG_NOT_FOUND", "CUSTOM_ACTION_NOT_FOUND" ], "enumDescriptions": [ @@ -4226,6 +4248,7 @@ "Cloud Build is not available, either because it is not enabled or because Cloud Deploy has insufficient permissions. See [required permission](https://cloud.google.com/deploy/docs/cloud-deploy-service-account#required_permissions).", "The render operation did not complete successfully; check Cloud Build logs.", "Cloud Build failed to fulfill Cloud Deploy's request. See failure_message for additional details.", + "The render operation did not complete successfully because the verification stanza required for verify was not found on the skaffold configuration.", "The render operation did not complete successfully because the custom action required for predeploy or postdeploy was not found in the skaffold configuration. See failure_message for additional details." ], "readOnly": true, diff --git a/discovery/cloudsupport-v2.json b/discovery/cloudsupport-v2.json index a0db64f046..1e03ea9027 100644 --- a/discovery/cloudsupport-v2.json +++ b/discovery/cloudsupport-v2.json @@ -355,7 +355,7 @@ "type": "string" }, "query": { - "description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify either `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` restricted 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)`", + "description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `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` restricted 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)`", "location": "query", "type": "string" } @@ -552,7 +552,7 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/discovery/cloudsupport-v2beta.json b/discovery/cloudsupport-v2beta.json index 3939433c01..a548999f69 100644 --- a/discovery/cloudsupport-v2beta.json +++ b/discovery/cloudsupport-v2beta.json @@ -351,7 +351,7 @@ "type": "string" }, "query": { - "description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify either `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` restricted 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)`", + "description": "An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `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` restricted 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)`", "location": "query", "type": "string" } @@ -548,7 +548,7 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { diff --git a/discovery/cloudtasks-v2beta3.json b/discovery/cloudtasks-v2beta3.json index 28dad5ab25..cc311e51ff 100644 --- a/discovery/cloudtasks-v2beta3.json +++ b/discovery/cloudtasks-v2beta3.json @@ -134,6 +134,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getCmekConfig": { + "description": "Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured.", + "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "GET", + "id": "cloudtasks.projects.locations.getCmekConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The config resource name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/cmekConfig$", + "required": true, + "type": "string" + } + }, + "path": "v2beta3/{+name}", + "response": { + "$ref": "CmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "list": { "description": "Lists information about the supported locations for this service.", "flatPath": "v2beta3/projects/{projectsId}/locations", @@ -174,6 +199,44 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateCmekConfig": { + "description": "Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config.", + "flatPath": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "httpMethod": "PATCH", + "id": "cloudtasks.projects.locations.updateCmekConfig", + "parameterOrder": [ + "projectsId", + "locationsId" + ], + "parameters": { + "locationsId": { + "location": "path", + "required": true, + "type": "string" + }, + "projectsId": { + "location": "path", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "List of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig", + "request": { + "$ref": "CmekConfig" + }, + "response": { + "$ref": "CmekConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -732,7 +795,7 @@ } } }, - "revision": "20230906", + "revision": "20230927", "rootUrl": "https://cloudtasks.googleapis.com/", "schemas": { "AppEngineHttpQueue": { @@ -890,6 +953,22 @@ }, "type": "object" }, + "CmekConfig": { + "description": "CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands.", + "id": "CmekConfig", + "properties": { + "kmsKey": { + "description": "Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption.", + "type": "string" + }, + "name": { + "description": "Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "CreateTaskRequest": { "description": "Request message for CreateTask.", "id": "CreateTaskRequest", diff --git a/discovery/composer-v1.json b/discovery/composer-v1.json index 3654977af0..9809a884f4 100644 --- a/discovery/composer-v1.json +++ b/discovery/composer-v1.json @@ -599,7 +599,7 @@ } } }, - "revision": "20230917", + "revision": "20231004", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { @@ -682,6 +682,10 @@ "machineType": { "description": "Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.", "type": "string" + }, + "zone": { + "description": "Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.", + "type": "string" } }, "type": "object" @@ -1675,7 +1679,12 @@ "StorageConfig": { "description": "The configuration for data storage in the environment.", "id": "StorageConfig", - "properties": {}, + "properties": { + "bucket": { + "description": "Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix.", + "type": "string" + } + }, "type": "object" }, "TriggererResource": { diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index b16a5b25f6..982695b00f 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -655,7 +655,7 @@ } } }, - "revision": "20230917", + "revision": "20231004", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AllowedIpRange": { @@ -760,6 +760,10 @@ "machineType": { "description": "Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*.", "type": "string" + }, + "zone": { + "description": "Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*.", + "type": "string" } }, "type": "object" @@ -1772,7 +1776,12 @@ "StorageConfig": { "description": "The configuration for data storage in the environment.", "id": "StorageConfig", - "properties": {}, + "properties": { + "bucket": { + "description": "Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix.", + "type": "string" + } + }, "type": "object" }, "TriggererResource": { diff --git a/discovery/compute-alpha.json b/discovery/compute-alpha.json index 242d91db42..be67714eda 100644 --- a/discovery/compute-alpha.json +++ b/discovery/compute-alpha.json @@ -173,6 +173,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/acceleratorTypes", @@ -343,6 +348,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/addresses", @@ -748,6 +758,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/autoscalers", @@ -1684,6 +1699,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/backendServices", @@ -2417,6 +2437,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/diskTypes", @@ -2637,6 +2662,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/disks", @@ -4630,6 +4660,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/forwardingRules", @@ -5085,6 +5120,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/futureReservations", @@ -6393,6 +6433,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/operations", @@ -6936,6 +6981,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/healthChecks", @@ -8684,6 +8734,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroupManagers", @@ -10098,6 +10153,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroups", @@ -10651,6 +10711,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceTemplates", @@ -11131,6 +11196,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instances", @@ -13794,6 +13864,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instantSnapshots", @@ -14293,6 +14368,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/interconnectAttachments", @@ -16222,6 +16302,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/machineTypes", @@ -16392,6 +16477,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkAttachments", @@ -16841,6 +16931,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEdgeSecurityServices", @@ -17103,6 +17198,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEndpointGroups", @@ -19047,6 +19147,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeGroups", @@ -19775,6 +19880,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTemplates", @@ -20174,6 +20284,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTypes", @@ -20864,6 +20979,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/packetMirrorings", @@ -22044,6 +22164,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/publicDelegatedPrefixes", @@ -23379,6 +23504,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/commitments", @@ -24879,6 +25009,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/healthCheckServices", @@ -29190,6 +29325,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/notificationEndpoints", @@ -32686,6 +32826,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/reservations", @@ -33196,6 +33341,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/resourcePolicies", @@ -33656,6 +33806,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/routers", @@ -34859,6 +35014,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/securityPolicies", @@ -35409,6 +35569,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/serviceAttachments", @@ -36247,6 +36412,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslCertificates", @@ -36512,6 +36682,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslPolicies", @@ -36870,6 +37045,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/storagePoolTypes", @@ -37035,6 +37215,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/storagePools", @@ -37610,6 +37795,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -38472,6 +38662,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpProxies", @@ -38821,6 +39016,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpsProxies", @@ -39335,6 +39535,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetInstances", @@ -39789,6 +39994,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetPools", @@ -40758,6 +40968,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetTcpProxies", @@ -41107,6 +41322,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetVpnGateways", @@ -41462,6 +41682,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/urlMaps", @@ -41890,6 +42115,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnGateways", @@ -42288,6 +42518,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnTunnels", @@ -42835,6 +43070,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/queuedResources", @@ -43184,7 +43424,7 @@ } } }, - "revision": "20230912", + "revision": "20230923", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -45931,7 +46171,7 @@ "type": "string" }, "timeZone": { - "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.", + "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of \"UTC\" if left empty.", "type": "string" } }, @@ -46529,7 +46769,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -53043,7 +53283,7 @@ "description": "Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time when auto-created reservations will be automatically deleted by GCE. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution." }, "autoDeleteAutoCreatedReservations": { - "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If omitted or set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", + "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", "type": "boolean" }, "creationTimestamp": { @@ -54025,6 +54265,7 @@ "SECURE_BOOT", "SEV_CAPABLE", "SEV_LIVE_MIGRATABLE", + "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", "TDX_CAPABLE", "UEFI_COMPATIBLE", @@ -54044,6 +54285,7 @@ "", "", "", + "", "" ], "type": "string" @@ -54253,7 +54495,7 @@ "type": "object" }, "HealthCheck": { - "description": "Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/alpha/healthChecks) * [Regional](/compute/docs/reference/rest/alpha/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.", + "description": "Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/alpha/regionHealthChecks) * [Global](/compute/docs/reference/rest/alpha/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.", "id": "HealthCheck", "properties": { "checkIntervalSec": { @@ -60573,7 +60815,7 @@ "type": "object" }, "InstanceTemplate": { - "description": "Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.", + "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/alpha/instanceTemplates) * [Regional](/compute/docs/reference/rest/alpha/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", "id": "InstanceTemplate", "properties": { "creationTimestamp": { @@ -62149,7 +62391,7 @@ "type": "boolean" }, "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail.", + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ "IF_MACSEC" @@ -62256,7 +62498,7 @@ }, "macsec": { "$ref": "InterconnectMacsec", - "description": "Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router." + "description": "Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router." }, "macsecEnabled": { "description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.", @@ -62302,7 +62544,7 @@ "type": "string" }, "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH.", + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ "IF_MACSEC" @@ -63824,7 +64066,7 @@ "type": "object" }, "InterconnectMacsec": { - "description": "Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router.", + "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", "id": "InterconnectMacsec", "properties": { "failOpen": { @@ -63832,7 +64074,7 @@ "type": "boolean" }, "preSharedKeys": { - "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", "items": { "$ref": "InterconnectMacsecPreSharedKey" }, @@ -66211,6 +66453,10 @@ "$ref": "PreservedState", "description": "[Output Only] Preserved state generated based on stateful policy for this instance." }, + "propertiesFromFlexibilityPolicy": { + "$ref": "ManagedInstancePropertiesFromFlexibilityPolicy", + "description": "[Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy." + }, "tag": { "deprecated": true, "description": "[Output Only] Tag describing the version.", @@ -66368,6 +66614,16 @@ }, "type": "object" }, + "ManagedInstancePropertiesFromFlexibilityPolicy": { + "id": "ManagedInstancePropertiesFromFlexibilityPolicy", + "properties": { + "machineType": { + "description": "The machine type to be used for this instance.", + "type": "string" + } + }, + "type": "object" + }, "ManagedInstanceVersion": { "id": "ManagedInstanceVersion", "properties": { @@ -69081,6 +69337,18 @@ ], "type": "string" }, + "bgpInterRegionCost": { + "description": "Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED.", + "enum": [ + "ADD_COST_TO_MED", + "DEFAULT" + ], + "enumDescriptions": [ + "", + "" + ], + "type": "string" + }, "routingMode": { "description": "The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions.", "enum": [ @@ -79849,7 +80117,7 @@ }, "priority": { "description": "The evaluation priority for this term, which must be between 0 (inclusive) and 2^31 (exclusive), and unique within the list.", - "format": "uint32", + "format": "int32", "type": "integer" } }, @@ -80707,7 +80975,7 @@ "ENDPOINT_TYPE_VM" ], "enumDescriptions": [ - "This is used for Regional Internal/External HTTP(S) and TCP Proxy load balancer endpoints.", + "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", "This is used for Secure Web Gateway endpoints.", "This is the default." ], @@ -83860,12 +84128,17 @@ "description": "The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment.", "type": "string" }, + "propagatedConnectionLimit": { + "description": "The number of VPCs to which this endpoint is allowed to be propagated per accept list resource (project or network). For ACCEPT_AUTOMATIC service attachment, this limit is default to per project.", + "format": "uint32", + "type": "integer" + }, "pscServiceAttachmentId": { "$ref": "Uint128", "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." }, "reconcileConnections": { - "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true.", + "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", "type": "boolean" }, "region": { @@ -86681,6 +86954,20 @@ "description": "Represents a zonal storage pool resource.", "id": "StoragePool", "properties": { + "capacityProvisioningType": { + "description": "Provisioning type of the byte capacity of the pool.", + "enum": [ + "ADVANCED", + "STANDARD", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", + "" + ], + "type": "string" + }, "creationTimestamp": { "description": "[Output Only] Creation timestamp in RFC3339 text format.", "type": "string" @@ -86721,6 +87008,20 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "type": "string" }, + "performanceProvisioningType": { + "description": "Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS.", + "enum": [ + "ADVANCED", + "STANDARD", + "UNSPECIFIED" + ], + "enumDescriptions": [ + "Advanced provisioning \"thinly\" allocates the related resource.", + "Standard provisioning allocates the related resource for the pool disks' exclusive use.", + "" + ], + "type": "string" + }, "provisionedIops": { "description": "Provsioned IOPS of the storage pool.", "format": "int64", @@ -89271,7 +89572,7 @@ "type": "object" }, "TargetHttpProxy": { - "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", + "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", "id": "TargetHttpProxy", "properties": { "creationTimestamp": { @@ -92942,7 +93243,7 @@ }, "startTimeWindow": { "$ref": "UpcomingMaintenanceTimeWindow", - "description": "[Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead." + "description": "[Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. TimeWindow is a container for two strings that represent timestamps in \"yyyy-MM-dd'T'HH:mm:ssZ\" text format." }, "time": { "description": "[Output Only] The time when the maintenance will take place. This value is in RFC3339 text format. DEPRECATED: Use window_start_time instead.", @@ -92974,7 +93275,7 @@ "type": "object" }, "UpcomingMaintenanceTimeWindow": { - "description": "Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format.", + "description": "Represents a window of time using two timestamps: `earliest` and `latest`.", "id": "UpcomingMaintenanceTimeWindow", "properties": { "earliest": { diff --git a/discovery/compute-beta.json b/discovery/compute-beta.json index 3fa40ddc4a..7ecd7f4fe1 100644 --- a/discovery/compute-beta.json +++ b/discovery/compute-beta.json @@ -173,6 +173,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/acceleratorTypes", @@ -343,6 +348,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/addresses", @@ -748,6 +758,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/autoscalers", @@ -1684,6 +1699,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/backendServices", @@ -2330,6 +2350,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/diskTypes", @@ -2550,6 +2575,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/disks", @@ -4543,6 +4573,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/forwardingRules", @@ -4998,6 +5033,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/futureReservations", @@ -6274,6 +6314,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/operations", @@ -6817,6 +6862,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/healthChecks", @@ -8190,6 +8240,58 @@ }, "instanceGroupManagerResizeRequests": { "methods": { + "cancel": { + "description": "Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "httpMethod": "POST", + "id": "compute.instanceGroupManagerResizeRequests.cancel", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager", + "resizeRequest" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "resizeRequest": { + "description": "The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID.", + "location": "path", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located. The name should conform to RFC1035.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}", @@ -8507,6 +8609,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroupManagers", @@ -9342,6 +9449,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "resumeInstances": { + "description": "Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", + "httpMethod": "POST", + "id": "compute.instanceGroupManagers.resumeInstances", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", + "request": { + "$ref": "InstanceGroupManagersResumeInstancesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setAutoHealingPolicies": { "deprecated": true, "description": "Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead.", @@ -9487,6 +9642,150 @@ "https://www.googleapis.com/auth/compute" ] }, + "startInstances": { + "description": "Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances", + "httpMethod": "POST", + "id": "compute.instanceGroupManagers.startInstances", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances", + "request": { + "$ref": "InstanceGroupManagersStartInstancesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "stopInstances": { + "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances", + "httpMethod": "POST", + "id": "compute.instanceGroupManagers.stopInstances", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances", + "request": { + "$ref": "InstanceGroupManagersStopInstancesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "suspendInstances": { + "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", + "httpMethod": "POST", + "id": "compute.instanceGroupManagers.suspendInstances", + "parameterOrder": [ + "project", + "zone", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone where the managed instance group is located.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", + "request": { + "$ref": "InstanceGroupManagersSuspendInstancesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.", "flatPath": "projects/{project}/zones/{zone}/instanceGroupManagers/{resource}/testIamPermissions", @@ -9729,6 +10028,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroups", @@ -10282,6 +10586,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceTemplates", @@ -10732,6 +11041,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instances", @@ -13210,6 +13524,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instantSnapshots", @@ -13659,6 +13978,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/interconnectAttachments", @@ -15262,6 +15586,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/machineTypes", @@ -15432,6 +15761,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkAttachments", @@ -15881,6 +16215,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEdgeSecurityServices", @@ -16143,6 +16482,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEndpointGroups", @@ -17881,6 +18225,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeGroups", @@ -18316,6 +18665,56 @@ "https://www.googleapis.com/auth/compute" ] }, + "performMaintenance": { + "description": "Perform maintenance on a subset of nodes in the node group.", + "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance", + "httpMethod": "POST", + "id": "compute.nodeGroups.performMaintenance", + "parameterOrder": [ + "project", + "zone", + "nodeGroup" + ], + "parameters": { + "nodeGroup": { + "description": "Name of the node group scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "zone": { + "description": "The name of the zone for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance", + "request": { + "$ref": "NodeGroupsPerformMaintenanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", "flatPath": "projects/{project}/zones/{zone}/nodeGroups/{resource}/setIamPolicy", @@ -18559,6 +18958,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTemplates", @@ -18958,6 +19362,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTypes", @@ -19648,6 +20057,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/packetMirrorings", @@ -20718,6 +21132,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/publicDelegatedPrefixes", @@ -21963,6 +22382,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/commitments", @@ -24738,6 +25162,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "resumeInstances": { + "description": "Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagers.resumeInstances", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances", + "request": { + "$ref": "RegionInstanceGroupManagersResumeInstancesRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "setAutoHealingPolicies": { "deprecated": true, "description": "Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead.", @@ -24775,9 +25247,153 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies", + "request": { + "$ref": "RegionInstanceGroupManagersSetAutoHealingRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setInstanceTemplate": { + "description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagers.setInstanceTemplate", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "The name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "request": { + "$ref": "RegionInstanceGroupManagersSetTemplateRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setTargetPools": { + "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagers.setTargetPools", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "request": { + "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "startInstances": { + "description": "Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances", + "httpMethod": "POST", + "id": "compute.regionInstanceGroupManagers.startInstances", + "parameterOrder": [ + "project", + "region", + "instanceGroupManager" + ], + "parameters": { + "instanceGroupManager": { + "description": "Name of the managed instance group.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances", "request": { - "$ref": "RegionInstanceGroupManagersSetAutoHealingRequest" + "$ref": "RegionInstanceGroupManagersStartInstancesRequest" }, "response": { "$ref": "Operation" @@ -24787,11 +25403,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "setInstanceTemplate": { - "description": "Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "stopInstances": { + "description": "Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "httpMethod": "POST", - "id": "compute.regionInstanceGroupManagers.setInstanceTemplate", + "id": "compute.regionInstanceGroupManagers.stopInstances", "parameterOrder": [ "project", "region", @@ -24823,9 +25439,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances", "request": { - "$ref": "RegionInstanceGroupManagersSetTemplateRequest" + "$ref": "RegionInstanceGroupManagersStopInstancesRequest" }, "response": { "$ref": "Operation" @@ -24835,11 +25451,11 @@ "https://www.googleapis.com/auth/compute" ] }, - "setTargetPools": { - "description": "Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected.", - "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "suspendInstances": { + "description": "Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request.", + "flatPath": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "httpMethod": "POST", - "id": "compute.regionInstanceGroupManagers.setTargetPools", + "id": "compute.regionInstanceGroupManagers.suspendInstances", "parameterOrder": [ "project", "region", @@ -24871,9 +25487,9 @@ "type": "string" } }, - "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools", + "path": "projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances", "request": { - "$ref": "RegionInstanceGroupManagersSetTargetPoolsRequest" + "$ref": "RegionInstanceGroupManagersSuspendInstancesRequest" }, "response": { "$ref": "Operation" @@ -30242,6 +30858,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/reservations", @@ -30752,6 +31373,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/resourcePolicies", @@ -31207,6 +31833,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/routers", @@ -32071,6 +32702,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/securityPolicies", @@ -32616,6 +33252,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/serviceAttachments", @@ -33454,6 +34095,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslCertificates", @@ -33719,6 +34365,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslPolicies", @@ -34078,6 +34729,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -34940,6 +35596,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpProxies", @@ -35289,6 +35950,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpsProxies", @@ -35803,6 +36469,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetInstances", @@ -36257,6 +36928,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetPools", @@ -37226,6 +37902,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetTcpProxies", @@ -37575,6 +38256,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetVpnGateways", @@ -37930,6 +38616,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/urlMaps", @@ -38358,6 +39049,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnGateways", @@ -38756,6 +39452,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnTunnels", @@ -39348,7 +40049,7 @@ } } }, - "revision": "20230912", + "revision": "20230923", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -40762,10 +41463,14 @@ "maintenanceInterval": { "description": "Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.", "enum": [ - "PERIODIC" + "AS_NEEDED", + "PERIODIC", + "RECURRENT" ], "enumDescriptions": [ - "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available." + "VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the PERIODIC and RECURRENT options.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available. RECURRENT is used for GEN3 and Slice of Hardware VMs." ], "type": "string" }, @@ -41958,7 +42663,7 @@ "type": "string" }, "timeZone": { - "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.", + "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of \"UTC\" if left empty.", "type": "string" } }, @@ -42503,6 +43208,22 @@ "format": "uint64", "type": "string" }, + "ipAddressSelectionPolicy": { + "description": "Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). ", + "enum": [ + "IPV4_ONLY", + "IPV6_ONLY", + "IP_ADDRESS_SELECTION_POLICY_UNSPECIFIED", + "PREFER_IPV6" + ], + "enumDescriptions": [ + "Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting.", + "Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends.", + "Unspecified IP address selection policy.", + "Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address)." + ], + "type": "string" + }, "kind": { "default": "compute#backendService", "description": "[Output Only] Type of resource. Always compute#backendService for backend services.", @@ -42536,7 +43257,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -48638,7 +49359,7 @@ "description": "Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time when auto-created reservations will be automatically deleted by GCE. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution." }, "autoDeleteAutoCreatedReservations": { - "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If omitted or set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", + "description": "Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.", "type": "boolean" }, "creationTimestamp": { @@ -49589,6 +50310,7 @@ "SECURE_BOOT", "SEV_CAPABLE", "SEV_LIVE_MIGRATABLE", + "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", @@ -49604,6 +50326,7 @@ "", "", "", + "", "" ], "type": "string" @@ -49771,7 +50494,7 @@ "type": "object" }, "HealthCheck": { - "description": "Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/beta/healthChecks) * [Regional](/compute/docs/reference/rest/beta/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.", + "description": "Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/beta/regionHealthChecks) * [Global](/compute/docs/reference/rest/beta/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.", "id": "HealthCheck", "properties": { "checkIntervalSec": { @@ -53007,6 +53730,10 @@ "description": "The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber}@cloudservices.gserviceaccount.com is used.", "type": "string" }, + "standbyPolicy": { + "$ref": "InstanceGroupManagerStandbyPolicy", + "description": "Standby policy for stopped and suspended instances." + }, "statefulPolicy": { "$ref": "StatefulPolicy", "description": "Stateful configuration for this Instanced Group Manager" @@ -53033,6 +53760,16 @@ "format": "int32", "type": "integer" }, + "targetStoppedSize": { + "description": "The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. ", + "format": "int32", + "type": "integer" + }, + "targetSuspendedSize": { + "description": "The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. ", + "format": "int32", + "type": "integer" + }, "updatePolicy": { "$ref": "InstanceGroupManagerUpdatePolicy", "description": "The update policy for this managed instance group." @@ -53803,6 +54540,28 @@ }, "type": "object" }, + "InstanceGroupManagerStandbyPolicy": { + "id": "InstanceGroupManagerStandbyPolicy", + "properties": { + "initialDelaySec": { + "format": "int32", + "type": "integer" + }, + "mode": { + "description": "Defines behaviour of using instances from standby pool to resize MIG.", + "enum": [ + "MANUAL", + "SCALE_OUT_POOL" + ], + "enumDescriptions": [ + "MIG does not automatically stop/start or suspend/resume VMs.", + "MIG automatically resumes and starts VMs when it scales out, and replenishes the standby pool afterwards." + ], + "type": "string" + } + }, + "type": "object" + }, "InstanceGroupManagerStatus": { "id": "InstanceGroupManagerStatus", "properties": { @@ -54309,6 +55068,19 @@ }, "type": "object" }, + "InstanceGroupManagersResumeInstancesRequest": { + "id": "InstanceGroupManagersResumeInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "InstanceGroupManagersScopedList": { "id": "InstanceGroupManagersScopedList", "properties": { @@ -54483,6 +55255,53 @@ }, "type": "object" }, + "InstanceGroupManagersStartInstancesRequest": { + "id": "InstanceGroupManagersStartInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersStopInstancesRequest": { + "id": "InstanceGroupManagersStopInstancesRequest", + "properties": { + "forceStop": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", + "type": "boolean" + }, + "instances": { + "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InstanceGroupManagersSuspendInstancesRequest": { + "id": "InstanceGroupManagersSuspendInstancesRequest", + "properties": { + "forceSuspend": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", + "type": "boolean" + }, + "instances": { + "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "InstanceGroupManagersUpdatePerInstanceConfigsReq": { "description": "InstanceGroupManagers.updatePerInstanceConfigs", "id": "InstanceGroupManagersUpdatePerInstanceConfigsReq", @@ -55489,7 +56308,7 @@ "type": "object" }, "InstanceTemplate": { - "description": "Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.", + "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/beta/instanceTemplates) * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", "id": "InstanceTemplate", "properties": { "creationTimestamp": { @@ -57007,7 +57826,7 @@ "type": "boolean" }, "availableFeatures": { - "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail.", + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", "items": { "enum": [ "IF_MACSEC" @@ -57114,7 +57933,7 @@ }, "macsec": { "$ref": "InterconnectMacsec", - "description": "Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router." + "description": "Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router." }, "macsecEnabled": { "description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.", @@ -57160,7 +57979,7 @@ "type": "string" }, "requestedFeatures": { - "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH.", + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", "items": { "enum": [ "IF_MACSEC" @@ -58670,7 +59489,7 @@ "type": "object" }, "InterconnectMacsec": { - "description": "Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router.", + "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", "id": "InterconnectMacsec", "properties": { "failOpen": { @@ -58678,7 +59497,7 @@ "type": "boolean" }, "preSharedKeys": { - "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", "items": { "$ref": "InterconnectMacsecPreSharedKey" }, @@ -60536,6 +61355,11 @@ "description": "[Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created.", "type": "string" }, + "instanceFlexibilityOverride": { + "$ref": "ManagedInstanceInstanceFlexibilityOverride", + "deprecated": true, + "description": "[Output Only] The overrides to instance properties resulting from InstanceFlexibilityPolicy." + }, "instanceHealth": { "description": "[Output Only] Health state of the instance per health-check.", "items": { @@ -60604,6 +61428,16 @@ }, "type": "object" }, + "ManagedInstanceInstanceFlexibilityOverride": { + "id": "ManagedInstanceInstanceFlexibilityOverride", + "properties": { + "machineType": { + "description": "The machine type to be used for this instance.", + "type": "string" + } + }, + "type": "object" + }, "ManagedInstanceInstanceHealth": { "id": "ManagedInstanceInstanceHealth", "properties": { @@ -63399,6 +64233,20 @@ "description": "An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate.", "type": "string" }, + "maintenanceInterval": { + "description": "Specifies the frequency of planned maintenance events. The accepted values are: `AS_NEEDED` and `RECURRENT`.", + "enum": [ + "AS_NEEDED", + "PERIODIC", + "RECURRENT" + ], + "enumDescriptions": [ + "VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the PERIODIC and RECURRENT options.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available. RECURRENT is used for GEN3 and Slice of Hardware VMs." + ], + "type": "string" + }, "maintenancePolicy": { "description": "Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies.", "enum": [ @@ -63908,6 +64756,10 @@ "totalResources": { "$ref": "InstanceConsumptionInfo", "description": "Total amount of available resources on the node." + }, + "upcomingMaintenance": { + "$ref": "UpcomingMaintenance", + "description": "[Output Only] The information about an upcoming maintenance event." } }, "type": "object" @@ -64087,6 +64939,23 @@ }, "type": "object" }, + "NodeGroupsPerformMaintenanceRequest": { + "id": "NodeGroupsPerformMaintenanceRequest", + "properties": { + "nodes": { + "description": "[Required] List of nodes affected by the call.", + "items": { + "type": "string" + }, + "type": "array" + }, + "startTime": { + "description": "The start time of the schedule. The timestamp is an RFC3339 string.", + "type": "string" + } + }, + "type": "object" + }, "NodeGroupsScopedList": { "id": "NodeGroupsScopedList", "properties": { @@ -69847,6 +70716,19 @@ }, "type": "object" }, + "RegionInstanceGroupManagersResumeInstancesRequest": { + "id": "RegionInstanceGroupManagersResumeInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RegionInstanceGroupManagersSetAutoHealingRequest": { "id": "RegionInstanceGroupManagersSetAutoHealingRequest", "properties": { @@ -69887,6 +70769,53 @@ }, "type": "object" }, + "RegionInstanceGroupManagersStartInstancesRequest": { + "id": "RegionInstanceGroupManagersStartInstancesRequest", + "properties": { + "instances": { + "description": "The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersStopInstancesRequest": { + "id": "RegionInstanceGroupManagersStopInstancesRequest", + "properties": { + "forceStop": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them.", + "type": "boolean" + }, + "instances": { + "description": "The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionInstanceGroupManagersSuspendInstancesRequest": { + "id": "RegionInstanceGroupManagersSuspendInstancesRequest", + "properties": { + "forceSuspend": { + "description": "If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them.", + "type": "boolean" + }, + "instances": { + "description": "The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME].", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "RegionInstanceGroupsListInstances": { "id": "RegionInstanceGroupsListInstances", "properties": { @@ -73121,7 +74050,7 @@ "ENDPOINT_TYPE_VM" ], "enumDescriptions": [ - "This is used for Regional Internal/External HTTP(S) and TCP Proxy load balancer endpoints.", + "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", "This is used for Secure Web Gateway endpoints.", "This is the default." ], @@ -74088,10 +75017,14 @@ "maintenanceInterval": { "description": "Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.", "enum": [ - "PERIODIC" + "AS_NEEDED", + "PERIODIC", + "RECURRENT" ], "enumDescriptions": [ - "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available." + "VMs are eligible to receive infrastructure and hypervisor updates as they become available. This may result in more maintenance operations (live migrations or terminations) for the VM than the PERIODIC and RECURRENT options.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available.", + "VMs receive infrastructure and hypervisor updates on a periodic basis, minimizing the number of maintenance operations (live migrations or terminations) on an individual VM. This may mean a VM will take longer to receive an update than if it was configured for AS_NEEDED. Security updates will still be applied as soon as they are available. RECURRENT is used for GEN3 and Slice of Hardware VMs." ], "type": "string" }, @@ -75775,7 +76708,7 @@ "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." }, "reconcileConnections": { - "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true.", + "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", "type": "boolean" }, "region": { @@ -79665,7 +80598,7 @@ "type": "object" }, "TargetHttpProxy": { - "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", + "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", "id": "TargetHttpProxy", "properties": { "creationTimestamp": { @@ -83178,6 +84111,56 @@ }, "type": "object" }, + "UpcomingMaintenance": { + "description": "Upcoming Maintenance notification information.", + "id": "UpcomingMaintenance", + "properties": { + "canReschedule": { + "description": "Indicates if the maintenance can be customer triggered.", + "type": "boolean" + }, + "latestWindowStartTime": { + "description": "The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.", + "type": "string" + }, + "maintenanceStatus": { + "enum": [ + "ONGOING", + "PENDING", + "UNKNOWN" + ], + "enumDescriptions": [ + "There is ongoing maintenance on this VM.", + "There is pending maintenance.", + "Unknown maintenance status. Do not use this value." + ], + "type": "string" + }, + "type": { + "description": "Defines the type of maintenance.", + "enum": [ + "SCHEDULED", + "UNKNOWN_TYPE", + "UNSCHEDULED" + ], + "enumDescriptions": [ + "Scheduled maintenance (e.g. maintenance after uptime guarantee is complete).", + "No type specified. Do not use this value.", + "Unscheduled maintenance (e.g. emergency maintenance during uptime guarantee)." + ], + "type": "string" + }, + "windowEndTime": { + "description": "The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.", + "type": "string" + }, + "windowStartTime": { + "description": "The current start time of the maintenance window. This timestamp value is in RFC3339 text format.", + "type": "string" + } + }, + "type": "object" + }, "UrlMap": { "description": "Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/beta/urlMaps) * [Regional](/compute/docs/reference/rest/beta/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts.", "id": "UrlMap", diff --git a/discovery/compute-v1.json b/discovery/compute-v1.json index a083b3b227..5859e9b5c6 100644 --- a/discovery/compute-v1.json +++ b/discovery/compute-v1.json @@ -173,6 +173,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/acceleratorTypes", @@ -343,6 +348,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/addresses", @@ -702,6 +712,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/autoscalers", @@ -1476,6 +1491,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/backendServices", @@ -1774,6 +1794,61 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "listUsable": { + "description": "Retrieves an aggregated list of all usable backend services in the specified project.", + "flatPath": "projects/{project}/global/backendServices/listUsable", + "httpMethod": "GET", + "id": "compute.backendServices.listUsable", + "parameterOrder": [ + "project" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/global/backendServices/listUsable", + "response": { + "$ref": "BackendServiceListUsable" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "patch": { "description": "Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", "flatPath": "projects/{project}/global/backendServices/{backendService}", @@ -2029,6 +2104,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/diskTypes", @@ -2249,6 +2329,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/disks", @@ -4204,6 +4289,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/forwardingRules", @@ -5456,6 +5546,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/operations", @@ -5999,6 +6094,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/healthChecks", @@ -7354,6 +7454,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroupManagers", @@ -8385,6 +8490,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceGroups", @@ -8806,6 +8916,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instanceTemplates", @@ -9256,6 +9371,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/instances", @@ -11588,6 +11708,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/interconnectAttachments", @@ -12201,6 +12326,41 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getMacsecConfig": { + "description": "Returns the interconnectMacsecConfig for the specified Interconnect.", + "flatPath": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", + "httpMethod": "GET", + "id": "compute.interconnects.getMacsecConfig", + "parameterOrder": [ + "project", + "interconnect" + ], + "parameters": { + "interconnect": { + "description": "Name of the interconnect resource to query.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/global/interconnects/{interconnect}/getMacsecConfig", + "response": { + "$ref": "InterconnectsGetMacsecConfigResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "description": "Creates an Interconnect in the specified project using the data included in the request.", "flatPath": "projects/{project}/global/interconnects", @@ -13072,6 +13232,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/machineTypes", @@ -13242,6 +13407,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkAttachments", @@ -13641,6 +13811,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEdgeSecurityServices", @@ -13903,6 +14078,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/networkEndpointGroups", @@ -15603,6 +15783,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeGroups", @@ -16281,6 +16466,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTemplates", @@ -16680,6 +16870,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/nodeTypes", @@ -16850,6 +17045,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/packetMirrorings", @@ -17886,6 +18086,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/publicDelegatedPrefixes", @@ -18731,67 +18936,39 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, - "patch": { - "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", - "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", - "httpMethod": "PATCH", - "id": "compute.regionBackendServices.patch", + "listUsable": { + "description": "Retrieves an aggregated list of all usable backend services in the specified project in the given region.", + "flatPath": "projects/{project}/regions/{region}/backendServices/listUsable", + "httpMethod": "GET", + "id": "compute.regionBackendServices.listUsable", "parameterOrder": [ "project", - "region", - "backendService" + "region" ], "parameters": { - "backendService": { - "description": "Name of the BackendService resource to patch.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", "type": "string" }, - "project": { - "description": "Project ID for this request.", - "location": "path", - "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", - "required": true, - "type": "string" + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" }, - "region": { - "description": "Name of the region scoping this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", - "required": true, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", "type": "string" }, - "requestId": { - "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", "location": "query", "type": "string" - } - }, - "path": "projects/{project}/regions/{region}/backendServices/{backendService}", - "request": { - "$ref": "BackendService" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", - "httpMethod": "POST", - "id": "compute.regionBackendServices.setIamPolicy", - "parameterOrder": [ - "project", - "region", - "resource" - ], - "parameters": { + }, "project": { "description": "Project ID for this request.", "location": "path", @@ -18800,37 +18977,32 @@ "type": "string" }, "region": { - "description": "The name of the region for this request.", + "description": "Name of the region scoping this request. It must be a string that meets the requirements in RFC1035.", "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", "required": true, "type": "string" }, - "resource": { - "description": "Name or id of the resource for this request.", - "location": "path", - "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", - "required": true, - "type": "string" + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" } }, - "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", - "request": { - "$ref": "RegionSetPolicyRequest" - }, + "path": "projects/{project}/regions/{region}/backendServices/listUsable", "response": { - "$ref": "Policy" + "$ref": "BackendServiceListUsable" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" ] }, - "setSecurityPolicy": { - "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview", - "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy", - "httpMethod": "POST", - "id": "compute.regionBackendServices.setSecurityPolicy", + "patch": { + "description": "Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules.", + "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}", + "httpMethod": "PATCH", + "id": "compute.regionBackendServices.patch", "parameterOrder": [ "project", "region", @@ -18838,7 +19010,102 @@ ], "parameters": { "backendService": { - "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.", + "description": "Name of the BackendService resource to patch.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/backendServices/{backendService}", + "request": { + "$ref": "BackendService" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "flatPath": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", + "httpMethod": "POST", + "id": "compute.regionBackendServices.setIamPolicy", + "parameterOrder": [ + "project", + "region", + "resource" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "resource": { + "description": "Name or id of the resource for this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/backendServices/{resource}/setIamPolicy", + "request": { + "$ref": "RegionSetPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "setSecurityPolicy": { + "description": "Sets the Google Cloud Armor security policy for the specified backend service. For more information, see Google Cloud Armor Overview", + "flatPath": "projects/{project}/regions/{region}/backendServices/{backendService}/setSecurityPolicy", + "httpMethod": "POST", + "id": "compute.regionBackendServices.setSecurityPolicy", + "parameterOrder": [ + "project", + "region", + "backendService" + ], + "parameters": { + "backendService": { + "description": "Name of the BackendService resource to which the security policy should be set. The name should conform to RFC1035.", "location": "path", "required": true, "type": "string" @@ -18977,6 +19244,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/commitments", @@ -22136,6 +22408,54 @@ }, "regionNetworkEndpointGroups": { "methods": { + "attachNetworkEndpoints": { + "description": "Attach a list of network endpoints to the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.attachNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where you want to create the network endpoint group. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints", + "request": { + "$ref": "RegionNetworkEndpointGroupsAttachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service.", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", @@ -22181,6 +22501,54 @@ "https://www.googleapis.com/auth/compute" ] }, + "detachNetworkEndpoints": { + "description": "Detach the network endpoint from the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.detachNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "networkEndpointGroup": { + "description": "The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "requestId": { + "description": "An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder", + "location": "query", + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints", + "request": { + "$ref": "RegionNetworkEndpointGroupsDetachEndpointsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "get": { "description": "Returns the specified network endpoint group.", "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}", @@ -22324,6 +22692,75 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly" ] + }, + "listNetworkEndpoints": { + "description": "Lists the network endpoints in the specified network endpoint group.", + "flatPath": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "httpMethod": "POST", + "id": "compute.regionNetworkEndpointGroups.listNetworkEndpoints", + "parameterOrder": [ + "project", + "region", + "networkEndpointGroup" + ], + "parameters": { + "filter": { + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", + "location": "query", + "type": "string" + }, + "maxResults": { + "default": "500", + "description": "The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`)", + "format": "uint32", + "location": "query", + "minimum": "0", + "type": "integer" + }, + "networkEndpointGroup": { + "description": "The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy=\"creationTimestamp desc\"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported.", + "location": "query", + "type": "string" + }, + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results.", + "location": "query", + "type": "string" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "The name of the region where the network endpoint group is located. It should comply with RFC1035.", + "location": "path", + "required": true, + "type": "string" + }, + "returnPartialSuccess": { + "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints", + "response": { + "$ref": "NetworkEndpointGroupsListNetworkEndpoints" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] } } }, @@ -23578,6 +24015,56 @@ }, "regionSecurityPolicies": { "methods": { + "addRule": { + "description": "Inserts a rule into a security policy.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.addRule", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule", + "request": { + "$ref": "SecurityPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, "delete": { "description": "Deletes the specified policy.", "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", @@ -23668,6 +24155,55 @@ "https://www.googleapis.com/auth/compute.readonly" ] }, + "getRule": { + "description": "Gets a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", + "httpMethod": "GET", + "id": "compute.regionSecurityPolicies.getRule", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to get from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to which the queried rule belongs.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule", + "response": { + "$ref": "SecurityPolicyRule" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ] + }, "insert": { "description": "Creates a new policy in the specified project using the data included in the request.", "flatPath": "projects/{project}/regions/{region}/securityPolicies", @@ -23814,6 +24350,12 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}", @@ -23827,6 +24369,116 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ] + }, + "patchRule": { + "description": "Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.patchRule", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to patch.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "If true, the request will not be committed.", + "location": "query", + "type": "boolean" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule", + "request": { + "$ref": "SecurityPolicyRule" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + }, + "removeRule": { + "description": "Deletes a rule at the specified priority.", + "flatPath": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "httpMethod": "POST", + "id": "compute.regionSecurityPolicies.removeRule", + "parameterOrder": [ + "project", + "region", + "securityPolicy" + ], + "parameters": { + "priority": { + "description": "The priority of the rule to remove from the security policy.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "project": { + "description": "Project ID for this request.", + "location": "path", + "pattern": "(?:(?:[-a-z0-9]{1,63}\\.)*(?:[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?):)?(?:[0-9]{1,19}|(?:[a-z0-9](?:[-a-z0-9]{0,61}[a-z0-9])?))", + "required": true, + "type": "string" + }, + "region": { + "description": "Name of the region scoping this request.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?", + "required": true, + "type": "string" + }, + "securityPolicy": { + "description": "Name of the security policy to update.", + "location": "path", + "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", + "required": true, + "type": "string" + } + }, + "path": "projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] } } }, @@ -25623,6 +26275,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/reservations", @@ -26133,6 +26790,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/resourcePolicies", @@ -26588,6 +27250,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/routers", @@ -27368,6 +28035,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/securityPolicies", @@ -27672,6 +28344,12 @@ "pattern": "[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?|[1-9][0-9]{0,19}", "required": true, "type": "string" + }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, "path": "projects/{project}/global/securityPolicies/{securityPolicy}", @@ -27716,6 +28394,12 @@ "required": true, "type": "string" }, + "updateMask": { + "description": "Indicates fields to be cleared as part of this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, "validateOnly": { "description": "If true, the request will not be committed.", "location": "query", @@ -27863,6 +28547,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/serviceAttachments", @@ -28630,6 +29319,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslCertificates", @@ -28857,6 +29551,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/sslPolicies", @@ -29178,6 +29877,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/subnetworks", @@ -29997,6 +30701,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpProxies", @@ -30308,6 +31017,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetHttpsProxies", @@ -30784,6 +31498,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetInstances", @@ -31192,6 +31911,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetPools", @@ -32077,6 +32801,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetTcpProxies", @@ -32388,6 +33117,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/targetVpnGateways", @@ -32697,6 +33431,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/urlMaps", @@ -33087,6 +33826,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnGateways", @@ -33485,6 +34229,11 @@ "description": "Opt-in for partial success behavior which provides partial results in case of failure. The default value is false.", "location": "query", "type": "boolean" + }, + "serviceProjectNumber": { + "format": "int64", + "location": "query", + "type": "string" } }, "path": "projects/{project}/aggregated/vpnTunnels", @@ -34031,7 +34780,7 @@ } } }, - "revision": "20230912", + "revision": "20230923", "rootUrl": "https://compute.googleapis.com/", "schemas": { "AWSV4Signature": { @@ -36501,7 +37250,7 @@ "type": "string" }, "timeZone": { - "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty.", + "description": "The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of \"UTC\" if left empty.", "type": "string" } }, @@ -37065,7 +37814,7 @@ "type": "array" }, "localityLbPolicy": { - "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", + "description": "The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true.", "enum": [ "INVALID_LB_POLICY", "LEAST_REQUEST", @@ -37204,6 +37953,12 @@ "description": "The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration.", "format": "int32", "type": "integer" + }, + "usedBy": { + "items": { + "$ref": "BackendServiceUsedBy" + }, + "type": "array" } }, "type": "object" @@ -37741,6 +38496,158 @@ }, "type": "object" }, + "BackendServiceListUsable": { + "description": "Contains a list of usable BackendService resources.", + "id": "BackendServiceListUsable", + "properties": { + "id": { + "description": "[Output Only] Unique identifier for the resource; defined by the server.", + "type": "string" + }, + "items": { + "description": "A list of BackendService resources.", + "items": { + "$ref": "BackendService" + }, + "type": "array" + }, + "kind": { + "default": "compute#usableBackendServiceList", + "description": "[Output Only] Type of resource. Always compute#usableBackendServiceList for lists of usable backend services.", + "type": "string" + }, + "nextPageToken": { + "description": "[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.", + "type": "string" + }, + "selfLink": { + "description": "[Output Only] Server-defined URL for this resource.", + "type": "string" + }, + "warning": { + "description": "[Output Only] Informational warning message.", + "properties": { + "code": { + "description": "[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response.", + "enum": [ + "CLEANUP_FAILED", + "DEPRECATED_RESOURCE_USED", + "DEPRECATED_TYPE_USED", + "DISK_SIZE_LARGER_THAN_IMAGE_SIZE", + "EXPERIMENTAL_TYPE_USED", + "EXTERNAL_API_WARNING", + "FIELD_VALUE_OVERRIDEN", + "INJECTED_KERNELS_DEPRECATED", + "INVALID_HEALTH_CHECK_FOR_DYNAMIC_WIEGHTED_LB", + "LARGE_DEPLOYMENT_WARNING", + "LIST_OVERHEAD_QUOTA_EXCEED", + "MISSING_TYPE_DEPENDENCY", + "NEXT_HOP_ADDRESS_NOT_ASSIGNED", + "NEXT_HOP_CANNOT_IP_FORWARD", + "NEXT_HOP_INSTANCE_HAS_NO_IPV6_INTERFACE", + "NEXT_HOP_INSTANCE_NOT_FOUND", + "NEXT_HOP_INSTANCE_NOT_ON_NETWORK", + "NEXT_HOP_NOT_RUNNING", + "NOT_CRITICAL_ERROR", + "NO_RESULTS_ON_PAGE", + "PARTIAL_SUCCESS", + "REQUIRED_TOS_AGREEMENT", + "RESOURCE_IN_USE_BY_OTHER_RESOURCE_WARNING", + "RESOURCE_NOT_DELETED", + "SCHEMA_VALIDATION_IGNORED", + "SINGLE_INSTANCE_PROPERTY_TEMPLATE", + "UNDECLARED_PROPERTIES", + "UNREACHABLE" + ], + "enumDeprecated": [ + false, + false, + false, + false, + false, + false, + true, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Warning about failed cleanup of transient changes made by a failed operation.", + "A link to a deprecated resource was created.", + "When deploying and at least one of the resources has a type marked as deprecated", + "The user created a boot disk that is larger than image size.", + "When deploying and at least one of the resources has a type marked as experimental", + "Warning that is present in an external api call", + "Warning that value of a field has been overridden. Deprecated unused field.", + "The operation involved use of an injected kernel, which is deprecated.", + "A WEIGHTED_MAGLEV backend service is associated with a health check that is not of type HTTP/HTTPS/HTTP2.", + "When deploying a deployment with a exceedingly large number of resources", + "Resource can't be retrieved due to list overhead quota exceed which captures the amount of resources filtered out by user-defined list filter.", + "A resource depends on a missing type", + "The route's nextHopIp address is not assigned to an instance on the network.", + "The route's next hop instance cannot ip forward.", + "The route's nextHopInstance URL refers to an instance that does not have an ipv6 interface on the same network as the route.", + "The route's nextHopInstance URL refers to an instance that does not exist.", + "The route's nextHopInstance URL refers to an instance that is not on the same network as the route.", + "The route's next hop instance does not have a status of RUNNING.", + "Error which is not critical. We decided to continue the process despite the mentioned error.", + "No results are present on a particular list page.", + "Success is reported, but some results may be missing due to errors", + "The user attempted to use a resource that requires a TOS they have not accepted.", + "Warning that a resource is in use.", + "One or more of the resources set to auto-delete could not be deleted because they were in use.", + "When a resource schema validation is ignored.", + "Instance template used in instance group manager is valid as such, but its application does not make a lot of sense, because it allows only single instance in instance group.", + "When undeclared properties in the schema are present", + "A given scope cannot be reached." + ], + "type": "string" + }, + "data": { + "description": "[Output Only] Metadata about this warning in key: value format. For example: \"data\": [ { \"key\": \"scope\", \"value\": \"zones/us-east1-d\" } ", + "items": { + "properties": { + "key": { + "description": "[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding).", + "type": "string" + }, + "value": { + "description": "[Output Only] A warning data value corresponding to the key.", + "type": "string" + } + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "[Output Only] A human-readable description of the warning code.", + "type": "string" + } + }, + "type": "object" + } + }, + "type": "object" + }, "BackendServiceLocalityLoadBalancingPolicyConfig": { "description": "Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user.", "id": "BackendServiceLocalityLoadBalancingPolicyConfig", @@ -37846,6 +38753,15 @@ }, "type": "object" }, + "BackendServiceUsedBy": { + "id": "BackendServiceUsedBy", + "properties": { + "reference": { + "type": "string" + } + }, + "type": "object" + }, "BackendServicesScopedList": { "id": "BackendServicesScopedList", "properties": { @@ -43052,6 +43968,7 @@ "SECURE_BOOT", "SEV_CAPABLE", "SEV_LIVE_MIGRATABLE", + "SEV_LIVE_MIGRATABLE_V2", "SEV_SNP_CAPABLE", "UEFI_COMPATIBLE", "VIRTIO_SCSI_MULTIQUEUE", @@ -43067,6 +43984,7 @@ "", "", "", + "", "" ], "type": "string" @@ -43234,7 +44152,7 @@ "type": "object" }, "HealthCheck": { - "description": "Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview.", + "description": "Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) * [Global](/compute/docs/reference/rest/v1/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview.", "id": "HealthCheck", "properties": { "checkIntervalSec": { @@ -48339,7 +49257,7 @@ "type": "object" }, "InstanceTemplate": { - "description": "Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates.", + "description": "Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/v1/instanceTemplates) * [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates.", "id": "InstanceTemplate", "properties": { "creationTimestamp": { @@ -49248,6 +50166,19 @@ "description": "Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true.", "type": "boolean" }, + "availableFeatures": { + "description": "[Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails.", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, "circuitInfos": { "description": "[Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG.", "items": { @@ -49341,6 +50272,14 @@ "description": "URL of the InterconnectLocation object that represents where this connection is to be provisioned.", "type": "string" }, + "macsec": { + "$ref": "InterconnectMacsec", + "description": "Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router." + }, + "macsecEnabled": { + "description": "Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified.", + "type": "boolean" + }, "name": { "annotations": { "required": [ @@ -49380,6 +50319,19 @@ "description": "Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to.", "type": "string" }, + "requestedFeatures": { + "description": "Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH.", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, "requestedLinkCount": { "description": "Target number of physical links in the link bundle, as requested by the customer.", "format": "int32", @@ -50363,6 +51315,10 @@ "lacpStatus": { "$ref": "InterconnectDiagnosticsLinkLACPStatus" }, + "macsec": { + "$ref": "InterconnectDiagnosticsMacsecStatus", + "description": "Describes the status of MACsec encryption on this link." + }, "operationalStatus": { "description": "The operational status of the link.", "enum": [ @@ -50386,6 +51342,21 @@ }, "type": "object" }, + "InterconnectDiagnosticsMacsecStatus": { + "description": "Describes the status of MACsec encryption on the link.", + "id": "InterconnectDiagnosticsMacsecStatus", + "properties": { + "ckn": { + "description": "Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational.", + "type": "string" + }, + "operational": { + "description": "Indicates whether or not MACsec is operational on this link.", + "type": "boolean" + } + }, + "type": "object" + }, "InterconnectList": { "description": "Response to the list request, and contains a list of interconnects.", "id": "InterconnectList", @@ -50550,6 +51521,34 @@ "description": "[Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: \"zone1\" or \"zone2\".", "type": "string" }, + "availableFeatures": { + "description": "[Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC ", + "items": { + "enum": [ + "IF_MACSEC" + ], + "enumDescriptions": [ + "Media Access Control security (MACsec)" + ], + "type": "string" + }, + "type": "array" + }, + "availableLinkTypes": { + "description": "[Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR ", + "items": { + "enum": [ + "LINK_TYPE_ETHERNET_100G_LR", + "LINK_TYPE_ETHERNET_10G_LR" + ], + "enumDescriptions": [ + "100G Ethernet, LR Optics.", + "10G Ethernet, LR Optics. [(rate_bps) = 10000000000];" + ], + "type": "string" + }, + "type": "array" + }, "city": { "description": "[Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: \"Chicago, IL\", \"Amsterdam, Netherlands\".", "type": "string" @@ -50830,6 +51829,76 @@ }, "type": "object" }, + "InterconnectMacsec": { + "description": "Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router.", + "id": "InterconnectMacsec", + "properties": { + "failOpen": { + "description": "If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router.", + "type": "boolean" + }, + "preSharedKeys": { + "description": "Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "items": { + "$ref": "InterconnectMacsecPreSharedKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectMacsecConfig": { + "description": "MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection.", + "id": "InterconnectMacsecConfig", + "properties": { + "preSharedKeys": { + "description": "A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link.", + "items": { + "$ref": "InterconnectMacsecConfigPreSharedKey" + }, + "type": "array" + } + }, + "type": "object" + }, + "InterconnectMacsecConfigPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecConfigPreSharedKey", + "properties": { + "cak": { + "description": "An auto-generated Connectivity Association Key (CAK) for this key.", + "type": "string" + }, + "ckn": { + "description": "An auto-generated Connectivity Association Key Name (CKN) for this key.", + "type": "string" + }, + "name": { + "description": "User provided name for this pre-shared key.", + "type": "string" + }, + "startTime": { + "description": "User provided timestamp on or after which this key is valid.", + "type": "string" + } + }, + "type": "object" + }, + "InterconnectMacsecPreSharedKey": { + "description": "Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode.", + "id": "InterconnectMacsecPreSharedKey", + "properties": { + "name": { + "description": "Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.", + "type": "string" + }, + "startTime": { + "description": "A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart.", + "type": "string" + } + }, + "type": "object" + }, "InterconnectOutageNotification": { "description": "Description of a planned outage on this Interconnect.", "id": "InterconnectOutageNotification", @@ -51252,6 +52321,20 @@ }, "type": "object" }, + "InterconnectsGetMacsecConfigResponse": { + "description": "Response for the InterconnectsGetMacsecConfigRequest.", + "id": "InterconnectsGetMacsecConfigResponse", + "properties": { + "etag": { + "description": "end_interface: MixerGetResponseWithEtagBuilder", + "type": "string" + }, + "result": { + "$ref": "InterconnectMacsecConfig" + } + }, + "type": "object" + }, "License": { "description": "Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. ", "id": "License", @@ -62097,6 +63180,32 @@ }, "type": "object" }, + "RegionNetworkEndpointGroupsAttachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsAttachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be attached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, + "RegionNetworkEndpointGroupsDetachEndpointsRequest": { + "id": "RegionNetworkEndpointGroupsDetachEndpointsRequest", + "properties": { + "networkEndpoints": { + "description": "The list of network endpoints to be detached.", + "items": { + "$ref": "NetworkEndpoint" + }, + "type": "array" + } + }, + "type": "object" + }, "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse": { "id": "RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse", "properties": { @@ -64891,10 +66000,12 @@ "description": "List of NAT-ted endpoint types supported by the Nat Gateway. If the list is empty, then it will be equivalent to include ENDPOINT_TYPE_VM", "items": { "enum": [ + "ENDPOINT_TYPE_MANAGED_PROXY_LB", "ENDPOINT_TYPE_SWG", "ENDPOINT_TYPE_VM" ], "enumDescriptions": [ + "This is used for regional Application Load Balancers (internal and external) and regional proxy Network Load Balancers (internal and external) endpoints.", "This is used for Secure Web Gateway endpoints.", "This is the default." ], @@ -67270,7 +68381,7 @@ "description": "[Output Only] An 128-bit global unique ID of the PSC service attachment." }, "reconcileConnections": { - "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true.", + "description": "This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false.", "type": "boolean" }, "region": { @@ -70934,7 +72045,7 @@ "type": "object" }, "TargetHttpProxy": { - "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", + "description": "Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts.", "id": "TargetHttpProxy", "properties": { "creationTimestamp": { diff --git a/discovery/connectors-v1.json b/discovery/connectors-v1.json index a751b07d2e..c1ac702132 100644 --- a/discovery/connectors-v1.json +++ b/discovery/connectors-v1.json @@ -1773,7 +1773,7 @@ } } }, - "revision": "20230913", + "revision": "20230920", "rootUrl": "https://connectors.googleapis.com/", "schemas": { "AuditConfig": { @@ -2455,6 +2455,11 @@ "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "ConnectorInfraConfig", "properties": { + "connectionRatelimitWindowSeconds": { + "description": "The window used for ratelimiting runtime requests to connections.", + "format": "int64", + "type": "string" + }, "hpaConfig": { "$ref": "HPAConfig", "description": "HPA autoscaling config." @@ -2611,6 +2616,12 @@ "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "ConnectorVersionInfraConfig", "properties": { + "connectionRatelimitWindowSeconds": { + "description": "Output only. The window used for ratelimiting runtime requests to connections.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "hpaConfig": { "$ref": "HPAConfig", "description": "Output only. HPA autoscaling config.", diff --git a/discovery/contactcenterinsights-v1.json b/discovery/contactcenterinsights-v1.json index f5834dac9a..92e017c1b8 100644 --- a/discovery/contactcenterinsights-v1.json +++ b/discovery/contactcenterinsights-v1.json @@ -1384,7 +1384,7 @@ } } }, - "revision": "20230919", + "revision": "20231009", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudContactcenterinsightsV1Analysis": { @@ -2605,12 +2605,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse": { - "description": "Response from export issue model", - "id": "GoogleCloudContactcenterinsightsV1ExportIssueModelResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudContactcenterinsightsV1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "id": "GoogleCloudContactcenterinsightsV1FaqAnswerData", @@ -2667,12 +2661,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse": { - "description": "Response from import issue model", - "id": "GoogleCloudContactcenterinsightsV1ImportIssueModelResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1IngestConversationsMetadata", @@ -3466,6 +3454,10 @@ "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "Default DLP redaction resources to be applied while ingesting conversations." }, + "speechConfig": { + "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", + "description": "Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided." + }, "updateTime": { "description": "Output only. The time at which the settings were last updated.", "format": "google-datetime", @@ -3556,6 +3548,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1SpeechConfig": { + "description": "Speech-to-Text configuration.", + "id": "GoogleCloudContactcenterinsightsV1SpeechConfig", + "properties": { + "speechRecognizer": { + "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1UndeployIssueModelMetadata", @@ -3649,6 +3652,10 @@ "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." + }, + "speechConfig": { + "$ref": "GoogleCloudContactcenterinsightsV1SpeechConfig", + "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." } }, "type": "object" @@ -4786,12 +4793,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse": { - "description": "Response from export issue model", - "id": "GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData": { "description": "Agent Assist frequently-asked-question answer data.", "id": "GoogleCloudContactcenterinsightsV1alpha1FaqAnswerData", @@ -4848,12 +4849,6 @@ "properties": {}, "type": "object" }, - "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse": { - "description": "Response from import issue model", - "id": "GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse", - "properties": {}, - "type": "object" - }, "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata": { "description": "The metadata for an IngestConversations operation.", "id": "GoogleCloudContactcenterinsightsV1alpha1IngestConversationsMetadata", @@ -5391,6 +5386,17 @@ }, "type": "object" }, + "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig": { + "description": "Speech-to-Text configuration.", + "id": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", + "properties": { + "speechRecognizer": { + "description": "The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id}/locations/{location}/recognizer/{recognizer}`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata": { "description": "Metadata for undeploying an issue model.", "id": "GoogleCloudContactcenterinsightsV1alpha1UndeployIssueModelMetadata", @@ -5484,6 +5490,10 @@ "redactionConfig": { "$ref": "GoogleCloudContactcenterinsightsV1alpha1RedactionConfig", "description": "Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings." + }, + "speechConfig": { + "$ref": "GoogleCloudContactcenterinsightsV1alpha1SpeechConfig", + "description": "Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings." } }, "type": "object" diff --git a/discovery/container-v1.json b/discovery/container-v1.json index 75b751760d..17ed9c79bc 100644 --- a/discovery/container-v1.json +++ b/discovery/container-v1.json @@ -2540,7 +2540,7 @@ } } }, - "revision": "20230913", + "revision": "20230919", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3312,6 +3312,10 @@ "$ref": "NotificationConfig", "description": "Notification configuration of the cluster." }, + "parentProductConfig": { + "$ref": "ParentProductConfig", + "description": "The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster." + }, "privateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "Configuration for private cluster." @@ -3621,6 +3625,10 @@ "$ref": "NotificationConfig", "description": "The desired notification configuration." }, + "desiredParentProductConfig": { + "$ref": "ParentProductConfig", + "description": "The desired parent product config for the cluster." + }, "desiredPrivateClusterConfig": { "$ref": "PrivateClusterConfig", "description": "The desired private cluster configuration." @@ -3939,11 +3947,11 @@ "type": "object" }, "EphemeralStorageLocalSsdConfig": { - "description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSD.", + "description": "EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.", "id": "EphemeralStorageLocalSsdConfig", "properties": { "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4062,13 +4070,11 @@ "enum": [ "CHANNEL_UNSPECIFIED", "CHANNEL_DISABLED", - "CHANNEL_EXPERIMENTAL", "CHANNEL_STANDARD" ], "enumDescriptions": [ "Default value.", "Gateway API support is disabled", - "Gateway API support is enabled, experimental CRDs are installed", "Gateway API support is enabled, standard CRDs are installed" ], "type": "string" @@ -4575,11 +4581,11 @@ "type": "object" }, "LocalNvmeSsdBlockConfig": { - "description": "LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSD.", + "description": "LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs", "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { - "description": "The number of raw-block local NVMe SSD disks to be attached to the node. Each local SSD is 375 GB in size. If zero, it means no raw-block local NVMe SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", + "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5804,6 +5810,24 @@ }, "type": "object" }, + "ParentProductConfig": { + "description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.", + "id": "ParentProductConfig", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels contain the configuration of the parent product.", + "type": "object" + }, + "productName": { + "description": "Name of the parent product associated with the cluster.", + "type": "string" + } + }, + "type": "object" + }, "PlacementPolicy": { "description": "PlacementPolicy defines the placement policy used by the node pool.", "id": "PlacementPolicy", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index 7778dd0939..a5912adb43 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2565,7 +2565,7 @@ } } }, - "revision": "20230914", + "revision": "20230919", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3020,6 +3020,7 @@ "UPDATE_STARTED", "CREATING_GREEN_POOL", "CORDONING_BLUE_POOL", + "WAITING_TO_DRAIN_BLUE_POOL", "DRAINING_BLUE_POOL", "NODE_POOL_SOAKING", "DELETING_BLUE_POOL", @@ -3030,6 +3031,7 @@ "blue-green upgrade has been initiated.", "Start creating green pool nodes.", "Start cordoning blue pool nodes.", + "Start waiting after cordoning the blue pool and before draining it.", "Start draining blue pool nodes.", "Start soaking time after draining entire blue pool.", "Start deleting blue nodes.", @@ -3393,6 +3395,10 @@ "$ref": "NotificationConfig", "description": "Notification configuration of the cluster." }, + "parentProductConfig": { + "$ref": "ParentProductConfig", + "description": "The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster." + }, "podSecurityPolicyConfig": { "$ref": "PodSecurityPolicyConfig", "description": "Configuration for the PodSecurityPolicy feature." @@ -3684,6 +3690,20 @@ "description": "The desired image type for the node pool. NOTE: Set the \"desired_node_pool\" field as well.", "type": "string" }, + "desiredInTransitEncryptionConfig": { + "description": "Specify the details of in-transit encryption.", + "enum": [ + "IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED", + "IN_TRANSIT_ENCRYPTION_DISABLED", + "IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT" + ], + "enumDescriptions": [ + "Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED.", + "In-transit encryption is disabled.", + "Data in-transit is encrypted using inter-node transparent encryption." + ], + "type": "string" + }, "desiredIntraNodeVisibilityConfig": { "$ref": "IntraNodeVisibilityConfig", "description": "The desired config of Intra-node visibility." @@ -3763,6 +3783,10 @@ "$ref": "NotificationConfig", "description": "The desired notification configuration." }, + "desiredParentProductConfig": { + "$ref": "ParentProductConfig", + "description": "The desired parent product config for the cluster." + }, "desiredPodSecurityPolicyConfig": { "$ref": "PodSecurityPolicyConfig", "description": "The desired configuration options for the PodSecurityPolicy feature." @@ -4128,7 +4152,7 @@ "id": "EphemeralStorageConfig", "properties": { "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4140,7 +4164,7 @@ "id": "EphemeralStorageLocalSsdConfig", "properties": { "localSsdCount": { - "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", + "description": "Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -4259,13 +4283,11 @@ "enum": [ "CHANNEL_UNSPECIFIED", "CHANNEL_DISABLED", - "CHANNEL_EXPERIMENTAL", "CHANNEL_STANDARD" ], "enumDescriptions": [ "Default value.", "Gateway API support is disabled", - "Gateway API support is enabled, experimental CRDs are installed", "Gateway API support is enabled, standard CRDs are installed" ], "type": "string" @@ -4856,7 +4878,7 @@ "id": "LocalNvmeSsdBlockConfig", "properties": { "localSsdCount": { - "description": "The number of raw-block local NVMe SSD disks to be attached to the node. Each local SSD is 375 GB in size. If zero, it means no raw-block local NVMe SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.", + "description": "Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.", "format": "int32", "type": "integer" } @@ -5252,6 +5274,20 @@ "$ref": "GatewayAPIConfig", "description": "GatewayAPIConfig contains the desired config of Gateway API on this cluster." }, + "inTransitEncryptionConfig": { + "description": "Specify the details of in-transit encryption.", + "enum": [ + "IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED", + "IN_TRANSIT_ENCRYPTION_DISABLED", + "IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT" + ], + "enumDescriptions": [ + "Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED.", + "In-transit encryption is disabled.", + "Data in-transit is encrypted using inter-node transparent encryption." + ], + "type": "string" + }, "network": { "description": "Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network", "type": "string" @@ -6159,6 +6195,24 @@ }, "type": "object" }, + "ParentProductConfig": { + "description": "ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.", + "id": "ParentProductConfig", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels contain the configuration of the parent product.", + "type": "object" + }, + "productName": { + "description": "Name of the parent product associated with the cluster.", + "type": "string" + } + }, + "type": "object" + }, "PlacementPolicy": { "description": "PlacementPolicy defines the placement policy used by the node pool.", "id": "PlacementPolicy", diff --git a/discovery/containeranalysis-v1.json b/discovery/containeranalysis-v1.json index 448f96a1af..121629355c 100644 --- a/discovery/containeranalysis-v1.json +++ b/discovery/containeranalysis-v1.json @@ -755,7 +755,7 @@ } } }, - "revision": "20230915", + "revision": "20231006", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2913,6 +2913,20 @@ "object": { "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" + }, + "sourceFetcher": { + "description": "Optional. Option to specify the tool to fetch the source file for the build.", + "enum": [ + "SOURCE_FETCHER_UNSPECIFIED", + "GSUTIL", + "GCS_FETCHER" + ], + "enumDescriptions": [ + "Unspecified defaults to GSUTIL.", + "Use the \"gsutil\" tool to download the source file.", + "Use the Cloud Storage Fetcher tool to download the source file." + ], + "type": "string" } }, "type": "object" @@ -5492,10 +5506,6 @@ }, "type": "array" }, - "extraDetails": { - "description": "Occurrence-specific extra details about the vulnerability.", - "type": "string" - }, "severity": { "description": "The note provider assigned severity of this vulnerability.", "enum": [ @@ -5582,6 +5592,10 @@ ], "type": "string" }, + "extraDetails": { + "description": "Occurrence-specific extra details about the vulnerability.", + "type": "string" + }, "fixAvailable": { "description": "Output only. Whether at least one of the affected packages has a fix available.", "type": "boolean" diff --git a/discovery/containeranalysis-v1alpha1.json b/discovery/containeranalysis-v1alpha1.json index 8d1ab49b2d..3f5535f6ab 100644 --- a/discovery/containeranalysis-v1alpha1.json +++ b/discovery/containeranalysis-v1alpha1.json @@ -1233,7 +1233,7 @@ } } }, - "revision": "20230915", + "revision": "20231006", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AnalysisCompleted": { @@ -3202,6 +3202,20 @@ "object": { "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" + }, + "sourceFetcher": { + "description": "Optional. Option to specify the tool to fetch the source file for the build.", + "enum": [ + "SOURCE_FETCHER_UNSPECIFIED", + "GSUTIL", + "GCS_FETCHER" + ], + "enumDescriptions": [ + "Unspecified defaults to GSUTIL.", + "Use the \"gsutil\" tool to download the source file.", + "Use the Cloud Storage Fetcher tool to download the source file." + ], + "type": "string" } }, "type": "object" @@ -6670,6 +6684,10 @@ ], "type": "string" }, + "extraDetails": { + "description": "Occurrence-specific extra details about the vulnerability.", + "type": "string" + }, "packageIssue": { "description": "The set of affected locations and their fixes (if available) within the associated resource.", "items": { diff --git a/discovery/containeranalysis-v1beta1.json b/discovery/containeranalysis-v1beta1.json index 1e6761e3b2..828672f788 100644 --- a/discovery/containeranalysis-v1beta1.json +++ b/discovery/containeranalysis-v1beta1.json @@ -815,7 +815,7 @@ } } }, - "revision": "20230915", + "revision": "20231006", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AliasContext": { @@ -2886,6 +2886,20 @@ "object": { "description": "Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build.", "type": "string" + }, + "sourceFetcher": { + "description": "Optional. Option to specify the tool to fetch the source file for the build.", + "enum": [ + "SOURCE_FETCHER_UNSPECIFIED", + "GSUTIL", + "GCS_FETCHER" + ], + "enumDescriptions": [ + "Unspecified defaults to GSUTIL.", + "Use the \"gsutil\" tool to download the source file.", + "Use the Cloud Storage Fetcher tool to download the source file." + ], + "type": "string" } }, "type": "object" @@ -3973,6 +3987,10 @@ ], "type": "string" }, + "extraDetails": { + "description": "Occurrence-specific extra details about the vulnerability.", + "type": "string" + }, "longDescription": { "description": "Output only. A detailed description of this vulnerability.", "type": "string" @@ -5920,10 +5938,6 @@ }, "type": "array" }, - "extraDetails": { - "description": "Occurrence-specific extra details about the vulnerability.", - "type": "string" - }, "severity": { "description": "Note provider assigned impact of the vulnerability.", "enum": [ diff --git a/discovery/content-v2.1.json b/discovery/content-v2.1.json index 71f5a54508..460061efa0 100644 --- a/discovery/content-v2.1.json +++ b/discovery/content-v2.1.json @@ -2174,7 +2174,7 @@ ] }, "requestreview": { - "description": "Requests a review of free listings in a specific region. This method is only available to selected merchants.", + "description": "Requests a review of free listings in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.", "flatPath": "{merchantId}/freelistingsprogram/requestreview", "httpMethod": "POST", "id": "content.freelistingsprogram.requestreview", @@ -2560,7 +2560,7 @@ ] }, "setomnichannelexperience": { - "description": "Sets the omnichannel experience for the specified country.", + "description": "Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles [about LFP](https://support.google.com/merchants/answer/7676652) and [how to get started](https://support.google.com/merchants/answer/7676578) with it.", "flatPath": "{merchantId}/liasettings/{accountId}/setomnichannelexperience", "httpMethod": "POST", "id": "content.liasettings.setomnichannelexperience", @@ -6461,7 +6461,7 @@ ] }, "requestreview": { - "description": "Requests a review of Shopping ads in a specific region. This method is only available to selected merchants.", + "description": "Requests a review of Shopping ads in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review.", "flatPath": "{merchantId}/shoppingadsprogram/requestreview", "httpMethod": "POST", "id": "content.shoppingadsprogram.requestreview", @@ -6488,7 +6488,7 @@ } } }, - "revision": "20230918", + "revision": "20231009", "rootUrl": "https://shoppingcontent.googleapis.com/", "schemas": { "Account": { diff --git a/discovery/contentwarehouse-v1.json b/discovery/contentwarehouse-v1.json index db1f7ad696..7a47c2bba4 100644 --- a/discovery/contentwarehouse-v1.json +++ b/discovery/contentwarehouse-v1.json @@ -1156,7 +1156,7 @@ } } }, - "revision": "20230918", + "revision": "20231006", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "AbuseiamAbuseType": { @@ -3728,7 +3728,11 @@ "CLOUDCONNECT_AFFINITY", "PERSONAL_AGENT_AFFINITY", "MOBILE_HARNESS_AFFINITY", - "LOOKER_STUDIO_PRO_AFFINITY" + "LOOKER_STUDIO_PRO_AFFINITY", + "SUPPORT_CLASSIFICATION_UI_AFFINITY", + "NOTEBOOKLM_AFFINITY", + "PLAYSPACE_LABS_AFFINITY", + "ZOMBIE_CLOUD_AFFINITY" ], "enumDeprecated": [ false, @@ -3997,6 +4001,10 @@ false, false, false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -4266,6 +4274,10 @@ "", "", "", + "", + "", + "", + "", "" ], "type": "string" @@ -7084,12 +7096,14 @@ "type": "array" }, "contactCreateContextInfo": { + "description": "ContactCreateContextInfo has a timestamp timestamp and additional metadata (e.g. the source of the creation) for when the contact was created. See also `ContactEditContextInfo`.", "items": { "$ref": "AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo" }, "type": "array" }, "contactEditContextInfo": { + "description": "ContactEditContextInfo is a timestamp and additional metadata (e.g. the source of the edit) for the last 'human initiated edit'. See also `ContactCreateContextInfo`.", "items": { "$ref": "AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo" }, @@ -7774,7 +7788,7 @@ "type": "array" }, "encodedContainerId": { - "description": "The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query.", + "description": "The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id", "type": "string" }, "fieldAcl": { @@ -8687,7 +8701,7 @@ "type": "string" }, "id": { - "description": "The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id.", + "description": "The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id", "type": "string" }, "photoType": { @@ -10483,7 +10497,7 @@ "BEDTIME_MODE", "THEATER_MODE", "TOUCH_LOCK", - "ASSISTANT_PRESS_AND_HOLD", + "PRESS_AND_HOLD", "WATCH_FACE", "NOTIFICATION_ANNOUNCEMENT" ], @@ -14689,6 +14703,7 @@ "type": "boolean" }, "isOnDeviceArbitrationSupported": { + "deprecated": true, "description": "Capabilities related to on-device arbitration(go/arbitration-on-device).", "type": "boolean" }, @@ -14697,6 +14712,7 @@ "type": "boolean" }, "isOnDeviceUnderstandingSupported": { + "deprecated": true, "description": "This may be used by NGA. E.g. if understanding happens on device, we can have more aggressive logic when fulfilling some features on the server side, like teleport.", "type": "boolean" } @@ -15614,6 +15630,7 @@ }, "marketplaceDisclosure": { "$ref": "AssistantApiSettingsMarketplaceDisclosure", + "deprecated": true, "description": "See go/marketplace-disclosure for more info." }, "masqueradeMode": { @@ -19491,7 +19508,7 @@ "type": "object" }, "AssistantGroundingRankerDeviceTargetingFeaturesStates": { - "description": "The states of the device. They are dynamic and may change based on the current context. Next ID: 10", + "description": "The states of the device. They are dynamic and may change based on the current context. Next ID: 13", "id": "AssistantGroundingRankerDeviceTargetingFeaturesStates", "properties": { "distance": { @@ -19522,8 +19539,20 @@ "description": "Indicates that the device is running a media session that is currently playing.", "type": "boolean" }, - "hasSameStructure": { - "description": "Indicates whether or not the device is in the same structure as any local or hearing devices.", + "inSameRoomAsHearingDevice": { + "description": "Indicates whether or not the device is in the same room as any hearing devices. Does not consider the device itself or the local device as a hearing device. If no valid hearing devices, this field is not set.", + "type": "boolean" + }, + "inSameRoomAsLocalDevice": { + "description": "Indicates whether or not the device is in the same room as the local device. If the device is the local device, this field is not set.", + "type": "boolean" + }, + "inSameStructureAsHearingDevice": { + "description": "Indicates whether or not the device is in the same structure as any hearing devices. Does not consider the device itself or the local device as a hearing device. If no valid hearing devices, this field is not set.", + "type": "boolean" + }, + "inSameStructureAsLocalDevice": { + "description": "Indicates whether or not the device is in the same structure as the local device. If the device is the local device, this field is not set.", "type": "boolean" }, "isDocked": { @@ -22005,7 +22034,7 @@ "type": "object" }, "AssistantPrefulfillmentRankerPrefulfillmentSignals": { - "description": "Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 65", + "description": "Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 66", "id": "AssistantPrefulfillmentRankerPrefulfillmentSignals", "properties": { "bindingSetAuis": { @@ -22120,7 +22149,8 @@ "PLAY_MEDIA_VIDEO", "ALARMS_AND_TIMERS", "HEALTH_AND_FITNESS", - "PLAY_MEDIA_RADIO" + "PLAY_MEDIA_RADIO", + "PLAY_TVM" ], "enumDescriptions": [ "", @@ -22130,6 +22160,7 @@ "", "", "", + "", "" ], "type": "string" @@ -22174,6 +22205,10 @@ "description": "Whether this intent was generated by Sage.", "type": "boolean" }, + "isScoreBasedIntent": { + "description": "Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent.", + "type": "boolean" + }, "isTvmIntent": { "description": "Whether the intent is a media object tvm intent.", "type": "boolean" @@ -22319,31 +22354,11 @@ "enum": [ "RANKER_NAME_UNSPECIFIED", "RANKER_NAME_GROUNDING_RANKER", - "RANKER_NAME_DEFER_TO_VERTICAL_SCORES", - "RANKER_NAME_GROUNDING_RANKER_V2", - "RANKER_NAME_GROUNDING_RANKER_MEDIA_EXP", - "RANKER_NAME_GROUNDING_RANKER_COMMS_EXP", - "RANKER_NAME_CONSOLIDATED_PFR_HGR", - "RANKER_NAME_CONSOLIDATED_PFR_HGR_V2_COMMS_CALIBRATED", - "RANKER_NAME_EXPERIMENTAL_PFR_SAGE_NEW_DOMAINS", - "RANKER_NAME_CONSOLIDATED_PFR_HGR_V2_COMMS_CALIBRATED_V2", - "RANKER_NAME_GROUNDING_RANKER_COMMS_EXP_CALIBRATED_V2", - "RANKER_NAME_CONSOLIDATED_PFR_HGR_PODCAST", "RANKER_NAME_GROUNDING_RANKER_V4" ], "enumDescriptions": [ "Default value, when there is no ranker specified.", "Name for HGR v1 model.", - "Used for deferring to confidence scores produced by upstream GPs instead of using HGR's scorer.", - "Name for HGR v2 model.", - "Name for experimental HGR model for Media, build on top of HGR v2.", - "Name for experimental HGR model for Comms.", - "Name for consolidated PFR and HGR ranker.", - "Name for consolidated PFR, HGRv2 and comms ranker.", - "Name for experimental PFR ranker for Sage and new domains.", - "Name for consolidated PFR, HGRv2 and comms ranker v2.", - "Name for experimental calibrated HGR model for Comms V2.", - "Name for HGR ranker for podcast based on RANKER_NAME_CONSOLIDATED_PFR_HGR_V2.", "Name for HGR V4 model, the model version that's targeted for Slow media launches." ], "type": "string" @@ -24088,21 +24103,6 @@ ], "type": "string" }, - "csaiRegexpHighConfidenceClassification": { - "deprecated": true, - "description": "DO NOT USE: This field is temporary and should be used only for the CSAI Onebox. This field is the result of the regular expression classifier alone as opposed to a combination with Seti classifier as in csai_classification field.", - "enum": [ - "NOT_PROTECTED", - "PROTECTED", - "STRONGLY_PROTECTED" - ], - "enumDescriptions": [ - "Contract: (STRONGLY_PROTECTED & PROTECTED) == PROTECTED", - "", - "" - ], - "type": "string" - }, "debug": { "description": "Human-readable debug information about the classification. This field is only set if output_debug is set in the classification input.", "type": "string" @@ -32666,15 +32666,15 @@ "type": "number" }, "translate": { - "$ref": "GeostoreCityJsonProtoTransformXyzVector", + "$ref": "GeostoreCityJsonProtoTransformTranslate", "description": "Offset of each vertex in the new coordinate system relative to the old coordinate system." } }, "type": "object" }, - "GeostoreCityJsonProtoTransformXyzVector": { - "description": "Vector of length three whose values respectively correspond to the x, y, and z axes.", - "id": "GeostoreCityJsonProtoTransformXyzVector", + "GeostoreCityJsonProtoTransformTranslate": { + "description": "How the object will be moved along the x, y, and z axes, respectively.", + "id": "GeostoreCityJsonProtoTransformTranslate", "properties": { "x": { "format": "double", @@ -37229,7 +37229,7 @@ }, "disputedArea": { "$ref": "GeostoreDisputedAreaProto", - "description": "RESERVED" + "description": "Represents information about disputed areas. Only TYPE_DISPUTED_AREA features should have the field set." }, "doodle": { "$ref": "GeostoreDoodleProto", @@ -37275,8 +37275,7 @@ "type": "number" }, "geopolitical": { - "$ref": "GeostoreGeopoliticalProto", - "description": "RESERVED" + "$ref": "GeostoreGeopoliticalProto" }, "geopoliticalGeometry": { "$ref": "GeostoreGeopoliticalGeometryProto", @@ -37544,8 +37543,7 @@ "description": "RESERVED" }, "transitStation": { - "$ref": "GeostoreTransitStationProto", - "description": "RESERVED" + "$ref": "GeostoreTransitStationProto" }, "type": { "description": "The type of this feature -- see comments above.", @@ -38761,7 +38759,7 @@ "properties": { "curvature": { "$ref": "GeostoreCurvatureProto", - "description": "RESERVED" + "description": "Curvature of the flowline. Note that, curvature can be present even if the flowline doesn't have a track. In which case, curvature will be derived from the segment polyline." }, "track": { "$ref": "GeostoreTrackProto" @@ -39227,14 +39225,14 @@ "id": "GeostoreInternalSegmentProto", "properties": { "disallowedConnections": { - "description": "RESERVED", + "description": "A list of lane connections that are explicitly not allowed to be added. NOTE: This should never reference existing lane connections on this segment.", "items": { "$ref": "GeostoreInternalSegmentProtoLaneConnectionReference" }, "type": "array" }, "disallowedPrimaryConnection": { - "description": "RESERVED", + "description": "A list of lane connections which cannot have the primary_connection bit set.", "items": { "$ref": "GeostoreInternalSegmentProtoLaneConnectionReference" }, @@ -44876,7 +44874,7 @@ "description": "Many political regions have a conceptual center (capitals of a country or a top-level division are examples). If set, the target feature must be a TYPE_LOCALITY feature." }, "claim": { - "description": "RESERVED", + "description": "Feature IDs of the features claimed by this feature's government that are not necessarily included in the feature's geometry.", "items": { "$ref": "GeostoreFeatureIdProto" }, @@ -48355,7 +48353,7 @@ "type": "array" }, "type": { - "description": "clang-format on The type of restriction. This is not a condition, but rather tells you what kind of restriction it is. This field should always be set.", + "description": "LINT.ThenChange(//depot/google3/google/geo/entities/v1/fields/segment.proto) clang-format on The type of restriction. This is not a condition, but rather tells you what kind of restriction it is. This field should always be set.", "enum": [ "RESTRICTION_TRAVEL_RESTRICTED", "RESTRICTION_ILLEGAL", @@ -48371,6 +48369,7 @@ "RESTRICTION_TOLL_BOOTH", "RESTRICTION_USAGE_FEE_REQUIRED", "RESTRICTION_ENTRANCE_FEE_REQUIRED", + "RESTRICTION_VIGNETTE_REQUIRED", "RESTRICTION_ADVISORY", "RESTRICTION_HIGH_CRIME", "RESTRICTION_POLITICALLY_SENSITIVE", @@ -48393,6 +48392,7 @@ "This restriction type may be used only for restrictions of STYLE_TURN, or STYLE_CONTIGUOUS with a subpath of length 2. The intersection at which the turn is restricted is the place of the toll booth.", "Traveling on the associated subpath requires a fee to be paid.", "Similar to RESTRICTION_USAGE_FEE_REQUIRED but instead of a fee for the usage, the fee is required for entering a special area (e.g. an amusement park). Also in contrast to RESTRICTION_USAGE_FEE_REQUIRED this restriction is supposed to be applied only to the segments that enter into the isolated restricted area from the outer world. Therefore there are two important points to consider when modeling data this way: 1) Every path that (exactly once) enters the restricted area should have exactly one such restriction (it does not matter whether it is a segment or subpath restriction). 2) All entrances have to be modeled consistently. It is recommended that the restriction is consistently applied to paths entering the area and not applied to paths leaving the area. NOTE: The above points are important because an additive penalty is applied for each individual restriction that appear on a path.", + "Similar to RESTRICTION_USAGE_FEE_REQUIRED but models a specific type of road tax called a 'vignette', used in certain European countries. Traveling on the associated subpath requires the driver or vehicle to have paid the road tax, documented by receipt of a physical or electronic vignette.", "Restrictions in the RESTRICTION_ADVISORY category refer to paths where travel is permitted, but may not be prudent or is cumbersome. Since this is often a matter of opinion, clients may choose not to make use of this information or not display it directly to the user.", "", "", @@ -52299,7 +52299,7 @@ "type": "object" }, "GoogleAssistantAccessoryV1DeviceState": { - "description": "Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 11", + "description": "Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13", "id": "GoogleAssistantAccessoryV1DeviceState", "properties": { "alarmState": { @@ -52328,6 +52328,15 @@ "$ref": "GoogleAssistantEmbeddedV1FitnessActivities", "description": "Information about on-device fitness activities. For devices that support fitness activities, all on-device fitness activities must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them." }, + "installedApps": { + "$ref": "GoogleAssistantAccessoryV1DeviceStateInstalledAppsState", + "description": "Information about apps currently installed on device." + }, + "installedAppsZlib": { + "description": "This contains a zlib-compressed binary-encoded `InstalledAppsState` proto message.", + "format": "byte", + "type": "string" + }, "timerState": { "$ref": "GoogleAssistantEmbeddedV1Timers", "description": "*Optional* Information about on-device timers. For devices that support timers, all on-device timers must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them." @@ -52658,7 +52667,7 @@ "BEDTIME_MODE", "THEATER_MODE", "TOUCH_LOCK", - "ASSISTANT_PRESS_AND_HOLD", + "PRESS_AND_HOLD", "WATCH_FACE", "NOTIFICATION_ANNOUNCEMENT" ], @@ -53323,6 +53332,20 @@ }, "type": "object" }, + "GoogleAssistantAccessoryV1DeviceStateInstalledAppsState": { + "description": "State of the apps currently installed on the device.", + "id": "GoogleAssistantAccessoryV1DeviceStateInstalledAppsState", + "properties": { + "apps": { + "description": "List of apps currently installed on the device.", + "items": { + "$ref": "AssistantApiCoreTypesProvider" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleAssistantAccessoryV1ResponseConfig": { "description": "Configuration for the response. Next Id: 11", "id": "GoogleAssistantAccessoryV1ResponseConfig", @@ -55970,6 +55993,14 @@ "$ref": "GoogleCloudContentwarehouseV1Document", "description": "Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information." }, + "matchedTokenPageIndices": { + "description": "Return the 1-based page indices where those pages have one or more matched tokens.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, "qaResult": { "$ref": "GoogleCloudContentwarehouseV1QAResult", "description": "Experimental. Additional result info if the question-answering feature is enabled." @@ -73288,6 +73319,18 @@ }, "type": "object" }, + "KnowledgeAnswersIntentQueryConceptSignals": { + "description": "Signal data for associated Concepts (go/concept-roofshot).", + "id": "KnowledgeAnswersIntentQueryConceptSignals", + "properties": { + "dataEpochId": { + "description": "Concepts data epoch used to annotate the queries.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "KnowledgeAnswersIntentQueryCoreference": { "description": "A message representing a coreferenced value defined elsewhere in the meaning struct.", "id": "KnowledgeAnswersIntentQueryCoreference", @@ -73392,7 +73435,7 @@ "type": "object" }, "KnowledgeAnswersIntentQueryFunctionCallSignals": { - "description": "Next ID: 38", + "description": "Next ID: 39", "id": "KnowledgeAnswersIntentQueryFunctionCallSignals", "properties": { "argumentComposingMid": { @@ -73410,6 +73453,10 @@ "description": "An entity that represents the concept of an entity-attribute intent by being composed of an intent equivalent MID and the argument MID.", "type": "string" }, + "conceptSignals": { + "$ref": "KnowledgeAnswersIntentQueryConceptSignals", + "description": "Information about the corresponding Concept attached to the FunctionCall. go/concept-roofshot." + }, "confidenceLevel": { "enum": [ "UNKNOWN", @@ -90777,6 +90824,9 @@ "PERSONAL_AGENT", "MOBILE_HARNESS", "LOOKER_STUDIO_PRO", + "SUPPORT_CLASSIFICATION_UI", + "NOTEBOOKLM", + "ZOMBIE_CLOUD", "DEPRECATED_QUICKSTART_FLUME", "DUO_CLIENT", "ALBERT", @@ -91429,6 +91479,9 @@ false, false, false, + false, + false, + false, true, false, false, @@ -92081,6 +92134,9 @@ "Personal Agent Team contact: page-1-eng@google.com", "Mobile Harness Team contact: omnilab-lmp@google.com", "Looker Studio Pro Team contact: da-cloudbi-india-ls-adminexp@google.com", + "Support Classification Ui Team contact: support-classification-eng@google.com", + "Notebooklm Team contact: labs-tailwind-eng-team@google.com", + "Zombie Cloud Team contact: zombie-cloud-eng@google.com", "", "Duo Client Team contact: duo-eng@google.com", "Project albert (go/albert-frontend) Team contact: albert-eng@google.com", @@ -101537,6 +101593,7 @@ "type": "object" }, "QualityOrbitAsteroidBeltImageIntentScores": { + "description": "These scores are for image scores *in the context of a landing page*, which is now a discouraged path of building image classifications. See go/orbit-for-images-v2 for an alternative.", "id": "QualityOrbitAsteroidBeltImageIntentScores", "properties": { "intents": { @@ -102185,7 +102242,7 @@ "type": "object" }, "QualityPreviewRanklabTitle": { - "description": "A collection of data corresponding to a single title candidate. This will be used as: - a collection of signals to score and select titles in production - an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 67", + "description": "A collection of data corresponding to a single title candidate. This will be used as: - a collection of signals to score and select titles in production - an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 68", "id": "QualityPreviewRanklabTitle", "properties": { "baseGoldmineFinalScore": { @@ -102813,6 +102870,9 @@ "format": "float", "type": "number" }, + "sourceGeneratedTitle": { + "type": "boolean" + }, "sourceGeometry": { "type": "boolean" }, @@ -108856,36 +108916,6 @@ "description": "--------------------------------------------------------------------------- Enums defining the available modifier options.", "id": "RepositoryWebrefFprintModifierProto", "properties": { - "capitalization": { - "enum": [ - "CAPITALIZATION_ANY", - "CAPITALIZATION_FIRST_ONLY", - "CAPITALIZATION_SOME", - "CAPITALIZATION_ALL" - ], - "enumDescriptions": [ - "Unspecified capitalization.", - "Only the first character of the first token is capitalized.", - "At least one character other than the first character of the first token is capitalized.", - "All characters are capitalized." - ], - "type": "string" - }, - "enclosing": { - "enum": [ - "ENCLOSING_ANY", - "ENCLOSING_QUOTES", - "ENCLOSING_PARENTHESIS", - "ENCLOSING_OTHER" - ], - "enumDescriptions": [ - "Unspecified enclosing characters.", - "The name is enclosed in quotes (single or double)", - "The name is enclosed in some kind of parenthesis.", - "The name is enclosed in other characters such as \"|\" or \"*\"." - ], - "type": "string" - }, "language": { "description": "i18.languages.Language enum defined in i18n/languages/proto/languages.proto UNKNOWN_LANGUAGE", "format": "int32", @@ -108901,204 +108931,6 @@ "The namespace for WebIt-specific classification data." ], "type": "string" - }, - "punctuation": { - "enum": [ - "PUNCTUATION_ANY", - "PUNCTUATION_INNER" - ], - "enumDescriptions": [ - "Unspecified punctuation.", - "The name contains punctuation characters." - ], - "type": "string" - }, - "sentence": { - "enum": [ - "SENTENCE_ANY", - "SENTENCE_BEGINNING" - ], - "enumDescriptions": [ - "Unspecified position of the name with respect to the sentence.", - "The name occurs at the beginning of a sentence (i.e., after certain punctuation characters like \".\" or \"!\")." - ], - "type": "string" - }, - "sourceType": { - "enum": [ - "SOURCE_ANY", - "SOURCE_NEWS", - "SOURCE_YOUTUBE" - ], - "enumDescriptions": [ - "Unspecified source type.", - "The source is a news page.", - "The source is a youtube page." - ], - "type": "string" - }, - "stemming": { - "enum": [ - "STEMMING_ANY", - "STEMMING_YES" - ], - "enumDescriptions": [ - "Unspecified stemming.", - "The name results from stemming." - ], - "type": "string" - }, - "style": { - "enum": [ - "STYLE_ANY", - "STYLE_DISTINCT" - ], - "enumDescriptions": [ - "Unspecified formatting.", - "The name has a different format than the surrounding tokens." - ], - "type": "string" - }, - "tokenType": { - "enum": [ - "INVALID", - "CONTENT", - "URL", - "ANCHOR", - "QUERY", - "INSTANT_QUERY", - "A_HREF_TAG", - "LINK_HREF_TAG", - "IMG_ALT_TAG", - "IMG_SRC_TAG", - "META_CONTENT_TAG", - "TITLE", - "ANY", - "IMAGE_QUERY", - "PASSAGE_QUERY", - "CONTEXT_ENTITY", - "RESULT_ENTITY", - "CONTEXT_QUERY", - "SIMILAR_QUERIES", - "SPORE_GRAPH", - "OFFDOMAIN_ANCHOR", - "ONSITE_ANCHOR", - "NAME_CANDIDATE", - "TOPIC_LINK", - "QUERY_NAME_CANDIDATE", - "ANCHOR_NAME_CANDIDATE", - "REFERENCE_PAGE_URL", - "REFERENCE_PAGE_LINK", - "STRONG_IDENTIFIER", - "REFERENCE_PAGE_URL_INLINK", - "REFERENCE_PAGE_LINK_INLINK", - "GEO_LINK", - "VIDEO_TRANSCRIPT", - "VIDEO_OCR", - "IMAGE_OCR", - "LENS", - "VIDEO_DESCRIPTION", - "ONLY_LOOKUP_METADATA", - "DEPRECATED_ENTITY_METADATA", - "DEPRECATED_PRINCIPAL_NAME", - "DEPRECATED_NAME_BLACKLIST", - "DEPRECATED_ENTITY_CONTEXT_TOKENS", - "DEPRECATED_INJECTED_NAME_CANDIDATE", - "DEPRECATED_EMBEDDED_CONTENT" - ], - "enumDeprecated": [ - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - false, - true, - true, - true, - true, - true, - true - ], - "enumDescriptions": [ - "To be used to mark an invalid token type. This proto enum does not follow the good practices, which suggest that such a value should be with tag 0: go/protodosdonts#do-include-an-unspecified-value-in-an-enum. Because this is a legacy situation and it is not safe to just change the tags, the enum contains an invalid type at this tag and can be used to specify the default value wherever this is needed.", - "The main html content of a document.", - "The urls of a document/", - "The anchors pointing to a document.", - "The navboost queries of a document", - "The instant navboost queries of a document", - "The href-value of the tags in the document's content", - "The href-value of the tags in the document's content", - "The alt-value of the tags in the document's content", - "The src-value of the tags in the document's content", - "The content-value of the tags \"description\" and \"keyword\"", - "The document ", - "Special value used to represent any other tokentype.", - "The Image Search navboost queries.", - "Radish Passage Queries, specifically, rankembed and generated queries. For offline use only. In offline Q2I runs we can instruct Webref to parse and annotate passge queries using the annoatate_passage_queries option in AnnotateDocjoinTuningOptions. Note that in Goldmine runs these are added to the docjoin *after* Webref has run. However,", - "Entities added from annotation context.", - "Represents an entity found in the results for Qref.", - "A query used as additional context for Qref annotations.", - "Similar Queries. They are only used to retrieve entities that might be able to explain original query. As in Q2@2018 we don't want them to be scored or provide context for scoring because of their overall big CPU impact on qrewrite (+50%).", - "A freetext dump + metadata from Spore GraphAnnotations.", - "Offdomain anchors pointing to a document.", - "Onsite anchors pointing to a document.", - "Name candidate extracted from the topic or generated from trusted source.", - "A link extracted directly from the topic:", - "Queries to reference pages which are potential names of the entity:", - "Anchor texts to reference pages which are potential names of the entity: Tokenized potential reference page URLs of the entity. Token matching is none because lookups are external annotations only.", - "", - "URLs that are linked to the reference page of the entity. Token matching is none because lookups are external annotations only.", - "Tokenized potential strong id of the entity, like phone number, ISBN. Token matching is none because lookups are external annotations only.", - "A special position used for lookup of inlinks to reference page urls.", - "A special position used for lookup of inlink scores for reference page outlinks.", - "", - "", - "", - "", - "", - "", - "Entries which are created in order to instruct the fprint-loader to load metadata for the contained ngrams.", - "Unused.", - "", - "", - "", - "", - "" - ], - "type": "string" } }, "type": "object" @@ -110576,6 +110408,30 @@ }, "type": "object" }, + "RepositoryWebrefMetaTagIndices": { + "description": "Identifies the source of the Meta Content Tag segment in the Cdoc https://www.w3schools.com/tags/tag_meta.asp", + "id": "RepositoryWebrefMetaTagIndices", + "properties": { + "index": { + "format": "int32", + "type": "integer" + }, + "metaName": { + "enum": [ + "OTHER", + "DESCRIPTION", + "KEYWORDS" + ], + "enumDescriptions": [ + "", + "", + "" + ], + "type": "string" + } + }, + "type": "object" + }, "RepositoryWebrefNameDebugInfo": { "description": "Collects signals from one query used for prior learning.", "id": "RepositoryWebrefNameDebugInfo", @@ -112062,6 +111918,10 @@ "$ref": "RepositoryWebrefJuggernautIndices", "description": "Pointer to the proto in the cdoc and index within the proto for Spore." }, + "metaTagIndex": { + "$ref": "RepositoryWebrefMetaTagIndices", + "description": "Informs about the 'name' attribute of the referenced tag." + }, "queryIndex": { "$ref": "RepositoryWebrefQueryIndices", "description": "Pointer to the exact set of queries in the cdoc." @@ -121215,6 +121075,22 @@ "description": "Affinity score for the cloud contact.", "format": "double", "type": "number" + }, + "suggestionConfidence": { + "description": "Indicator of the confidence in suggestion relevance.", + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -121389,7 +121265,7 @@ "type": "object" }, "SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData": { - "description": "NEXT_ID: 5", + "description": "NEXT_ID: 6", "id": "SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData", "properties": { "birthdayStatus": { @@ -121434,6 +121310,21 @@ "" ], "type": "string" + }, + "suggestionConfidence": { + "enum": [ + "CONFIDENCE_UNSPECIFIED", + "CONFIDENCE_LOW", + "CONFIDENCE_MEDIUM", + "CONFIDENCE_HIGH" + ], + "enumDescriptions": [ + "", + "", + "", + "" + ], + "type": "string" } }, "type": "object" @@ -124899,7 +124790,7 @@ "MS Advanced Systems Format container.", "For Bzip2 compressed files.", "For binary content", - "that is OK to be compressed. Equivalent to application/octet-stream but listed in net/http/gzip_rules.txt as safe to gzip.", + "that is OK to be compressed. Equivalent to application/octet-stream but listed in net/http/compression_content_types.textproto as safe to gzip.", "Calendar files.", "", "BMP image files.", @@ -126098,6 +125989,7 @@ "FRESH_RESULTS_SEEKING_CURRENT_YEAR_EVENT_LEVEL", "FILTER_TQ_FAILURE_APP", "EDITORIAL_CONTENT_CLUSTER_FHR_SERP_EVENT_LEVEL", + "HAVE_LOCALIZATION_QUALITY_DIFF_AT_FILTER", "PGSS_DETAILS_PAGE_TQUALITY_UNKNOWN_EVENT_LEVEL", "PGSS_DETAILS_PAGE_TQUALITY_FAILED_EVENT_LEVEL", "PGSS_DETAILS_PAGE_TQUALITY_PASSED_EVENT_LEVEL", @@ -126222,6 +126114,7 @@ "FOP_ORDERING_STORED_VALUE_EVENT_LEVEL", "GEARHEAD_DUPLEX_COMPATIBLE_DIALER_ENABLED", "CUSTOMER_UPDATE_CHALLENGE_EVENT_LEVEL", + "EXPERIMENTAL_TG_QUERY_EVENT_LEVEL", "EVENT_LEVEL_TEST_CODE_LIMIT", "ENTERTAINMENT_CLUSTER_TRIGGERING_AT_SESSION_LEVEL", "BEST_SELLER_CART_TAG_AT_SESSION_LEVEL", @@ -126397,6 +126290,9 @@ "IN_APP_OFFER_BATTLESTAR_APP_CASH_FRENZY_AT_SESSION_LEVEL", "IN_APP_OFFER_BATTLESTAR_APP_WAR_PLANET_AT_SESSION_LEVEL", "IN_APP_OFFER_BATTLESTAR_APP_ESKYFUN_LEGENDS_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_MAHJONG_VILLAGE_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_ONE_PUNCH_MAN_KR_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_ONE_PUNCH_MAN_TW_AT_SESSION_LEVEL", "IN_APP_OFFER_ELIGIBLE_AT_SESSION_LEVEL", "IN_APP_OFFER_ELIGIBLE_APP_1_AT_SESSION_LEVEL", "IN_APP_OFFER_ELIGIBLE_APP_2_AT_SESSION_LEVEL", @@ -126414,6 +126310,9 @@ "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_CASH_FRENZY_AT_SESSION_LEVEL", "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_WAR_PLANET_AT_SESSION_LEVEL", "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ESKYFUN_LEGENDS_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_MAHJONG_VILLAGE_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ONE_PUNCH_MAN_KR_AT_SESSION_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ONE_PUNCH_MAN_TW_AT_SESSION_LEVEL", "IN_APP_OFFER_SAVED_AT_SESSION_LEVEL", "IN_APP_OFFER_SAVED_APP_1_AT_SESSION_LEVEL", "IN_APP_OFFER_SAVED_APP_2_AT_SESSION_LEVEL", @@ -126451,6 +126350,7 @@ "GEARHEAD_FRX_SENSITIVE_PERMISSION_SCREEN_SEEN", "POST_PURCHASE_ITEM_UPSELL_SESSION_LEVEL", "POST_PURCHASE_ITEM_UPSELL_WAVE_2_SESSION_LEVEL", + "POST_PURCHASE_ITEM_UPSELL_WAVE_2_SESSION_LEVEL_2", "PLAY_PASS_SIGNUP_INTERSTITIAL_SHOWN_SESSION_LEVEL", "FETCH_PROMOTION_BANNER_FROM_P3_SESSION_LEVEL", "AVP_SWOOP_10P_OFF_SESSION_LEVEL", @@ -126577,6 +126477,9 @@ "FRESH_RESULTS_SEEKING_CURRENT_YEAR_SESSION_LEVEL", "FILTER_TQ_FAILURE_APP_SESSION_LEVEL", "EDITORIAL_CONTENT_CLUSTER_FHR_SERP_SESSION_LEVEL", + "HAVE_LOCALIZATION_QUALITY_DIFF_AT_FILTER_SESSION_LEVEL", + "EXPERIMENTAL_TG_QUERY_SESSION_LEVEL", + "NAV_CARD_HIGH_QUALITY_MDP_SESSION_LEVEL", "HAS_DECLINE_REASON_IN_PAYMENT_DECLINE_EMAIL_SESSION_LEVEL", "QUEST_CONTENT_CARD_IN_DEALS_HOME_SESSION_LEVEL", "PRE_INSTALL_LOW_QUALITY_DEEP_LINK_DETAILS_PAGE_SESSION_LEVEL", @@ -126944,6 +126847,9 @@ "PLAY_ONBOARDING_FLOW_SESSION_LEVEL", "BECAUSE_YOU_PLAYED_FIRST_3_ROWS_SESSION_LEVEL", "BECAUSE_YOU_INSTALLED_FIRST_3_ROWS_SESSION_LEVEL", + "LOYALTY_WEEKLY_REWARDS_ICC_FORMAT_NOW_HOME_SESSION_LEVEL", + "MULTILINE_SUBSCRIPTION_ADDON_TITLE_SESSION_LEVEL", + "PAYTM_WALLET_FAILURE_SESSION_LEVEL", "SESSION_LEVEL_TEST_CODE_LIMIT", "CART_ABANDONMENT_USER_LEVEL", "IN_APP_PRODUCTS_IN_DETAILS_PAGE_USER_LEVEL", @@ -127018,6 +126924,9 @@ "IN_APP_OFFER_BATTLESTAR_APP_CASH_FRENZY_AT_USER_LEVEL", "IN_APP_OFFER_BATTLESTAR_APP_WAR_PLANET_AT_USER_LEVEL", "IN_APP_OFFER_BATTLESTAR_APP_ESKYFUN_LEGENDS_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_MAHJONG_VILLAGE_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_ONE_PUNCH_MAN_KR_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_APP_ONE_PUNCH_MAN_TW_AT_USER_LEVEL", "IN_APP_OFFER_ELIGIBLE_AT_USER_LEVEL", "IN_APP_OFFER_ELIGIBLE_APP_1_AT_USER_LEVEL", "IN_APP_OFFER_ELIGIBLE_APP_2_AT_USER_LEVEL", @@ -127035,6 +126944,9 @@ "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_CASH_FRENZY_AT_USER_LEVEL", "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_WAR_PLANET_AT_USER_LEVEL", "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ESKYFUN_LEGENDS_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_MAHJONG_VILLAGE_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ONE_PUNCH_MAN_KR_AT_USER_LEVEL", + "IN_APP_OFFER_BATTLESTAR_ELIGIBLE_APP_ONE_PUNCH_MAN_TW_AT_USER_LEVEL", "IN_APP_OFFER_SAVED_AT_USER_LEVEL", "IN_APP_OFFER_SAVED_APP_1_AT_USER_LEVEL", "IN_APP_OFFER_SAVED_APP_2_AT_USER_LEVEL", @@ -127054,6 +126966,7 @@ "GEARHEAD_VISUAL_PREVIEW_UNCHAINED_ELIGIBLE", "POST_PURCHASE_ITEM_UPSELL_USER_LEVEL", "POST_PURCHASE_ITEM_UPSELL_WAVE_2_USER_LEVEL", + "POST_PURCHASE_ITEM_UPSELL_WAVE_2_USER_LEVEL_2", "PLAY_PASS_SIGNUP_INTERSTITIAL_SHOWN_USER_LEVEL", "DISABLE_TOPUP_EXPERIMENT_CONTROL_GROUP_USER_LEVEL", "DISABLE_TOPUP_EXPERIMENT_TREATMENT_GROUP_USER_LEVEL", @@ -127103,8 +127016,10 @@ "GE_IS_SCHEDULED_COFFEE_CARD", "GE_IS_SCHEDULED_QUEST", "GE_IS_SCHEDULED_LOYALTY_MULTIPLIER", + "GE_IS_SCHEDULED_POST_PURCHASE_OFFER", "GE_IS_USER_OPT_IN_P13N", "GE_LOYALTY_PURCHASE_QUEST_INDIVIDUALIZATION_EXPERIMENT", + "GE_POST_PURCHASE_OFFER_INDIVIDUALIZATION_EXPERIMENT", "IAP_SKU_DEALS_LIVE_OP_DEALS_HOME_USER_LEVEL", "IAP_SKU_DEALS_LIVE_OP_GAMES_HOME_USER_LEVEL", "FEATURING_AHC_OR_FHR_TRIGGERED_USER_LEVEL", @@ -127148,6 +127063,8 @@ "LINK_BIOMETRICS_NEW_SETUP_USER_LEVEL_V2", "LINK_BIOMETRICS_NEW_SETUP_USER_LEVEL_V3", "LINK_BIOMETRICS_NEW_SETUP_USER_LEVEL_V3_1", + "LINK_BIOMETRICS_NEW_SETUP_USER_LEVEL_V3_2", + "LINK_BIOMETRICS_NEW_SETUP_USER_LEVEL_V3_3", "POST_SUCCESS_ADD_BACKUP_FLOW_USER_LEVEL", "SKIP_CHECK_MARK_SCREEN_WITH_BACKUP_FLOW_USER_LEVEL", "IS_ELIGIBLE_FOR_ONE_CLICK_BACKUP_FOP_USER_LEVEL", @@ -127216,6 +127133,7 @@ "HAS_REINSTALL_APP_PASSING_FILTERING_USER_LEVEL", "HAS_RECOMMENDED_APP_WITH_OOP_REINSTALL_ELIGIBILITY_USER_LEVEL", "HAS_PAST_OOP_SPEND_ON_GAME_USER_LEVEL", + "HAS_PAST_OOP_SPEND_ON_APPLICATION_USER_LEVEL", "NOTIFICATION_PREDICTED_REV_GAIN_FILTERING_USER_LEVEL", "NOTIFICATION_PUBLICITY_GAIN_DISABLED_USER_LEVEL", "UNACK_IN_APP_SUBSCRIPTION_WARNING_DETAIL_PAGE_USER_LEVEL", @@ -127271,13 +127189,25 @@ "ELIGIBLE_FOR_COMICS_CLUSTER_AH_USER_LEVEL", "HIGH_COMIC_APP_USAGE_USER_LEVEL", "MODERATE_COMIC_APP_USAGE_USER_LEVEL", + "COMIC_SAMPLING_PICCOMA_INSTALLED_USER_LEVEL", + "COMIC_SAMPLING_MANGA_ONE_INSTALLED_USER_LEVEL", + "COMIC_SAMPLING_MAGAPOKE_INSTALLED_USER_LEVEL", + "COMIC_SAMPLING_JUMP_INSTALLED_USER_LEVEL", + "COMIC_SAMPLING_LINE_MANGA_INSTALLED_USER_LEVEL", + "COMIC_SAMPLING_ANY_INSTALLED_USER_LEVEL", "REDEEM_SAVE_BUYER_SPEND_MODEL_USER_LEVEL", "PURCHASE_ADD_FOP_OPTIONS_SCREEN_USER_LEVEL", "CART_ABANDONMENT_ITEM_RECOMMENDATION_USER_LEVEL", + "CART_ABANDONMENT_ITEM_RECOMMENDATION_LOWER_PRICED_USER_LEVEL", "HAS_INSUFFICIENT_STORED_VALUE_BALANCE_BEFORE_RENEWAL_USER_LEVEL", "IS_ELIGIBLE_FOR_ONE_CLICK_BAKCUP_FOP_IN_FIX_FLOW_USER_LEVEL", "WEBSKY_DISPLAY_SUBSCRIPTION_ENTITLEMENT_BENEFITS_USER_LEVEL", "HAS_INSUFFICIENT_STORED_VALUE_BALANCE_BEFORE_RENEWAL_V2_USER_LEVEL", + "LOYALTY_WEEKLY_REWARDS_ICC_FORMAT_NOW_HOME_USER_LEVEL", + "PREREGISTRATION_SHOULD_SEE_NOTIFICATION_DIALOG_USER_LEVEL", + "MULTILINE_SUBSCRIPTION_ADDON_TITLE_USER_LEVEL", + "UNIFIED_ITEM_RECOMMENDATION_USER_LEVEL", + "UNIFIED_ITEM_RECOMMENDATION_LOWER_PRICED_USER_LEVEL", "USER_LEVEL_TEST_CODE_LIMIT" ], "enumDeprecated": [ @@ -127799,6 +127729,15 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, true, false, false, @@ -127935,6 +127874,9 @@ false, false, false, + false, + false, + false, true, false, false, @@ -128460,6 +128402,18 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, true, false, false, @@ -128485,6 +128439,8 @@ false, false, false, + false, + false, true, false, false, @@ -128614,6 +128570,19 @@ false, false, false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, + false, false ], "enumDescriptions": [ @@ -128770,6 +128739,7 @@ "Event level test code for tracking fresh results seeking within the current year search queries.", "Event level test code for when we filtered >=1 apps due to tq failure.", "Event level test code for Editorial Content/Articles in SERP (FHR)", + "Event level test code for apps with different quality score in different language at filter.", "The following are used by the server side.", "", "", @@ -128894,6 +128864,7 @@ "", "Test code for sessions where a phone dialer that doesn't turn screen on during phone calls is enabled.", "Event-level test code for the presence of customer update challenge.", + "Event-level test code for experimental tg query.", "", "", "", @@ -129093,6 +129064,12 @@ "", "", "", + "", + "", + "", + "", + "", + "", "see go/reordering-subnav-tabs", "see go/reordering-subnav-tabs", "", @@ -129123,6 +129100,7 @@ "", "", "", + "", "Test code logged on client side for users who see the Play Pass signup interstitial.", "", "User eligible for 10% off for next renewal", @@ -129249,6 +129227,9 @@ "Session level test code for tracking fresh results seeking within the current year search queries.", "Event level test code for when we filtered >=1 apps due to tq failure.", "Session level test code for Editorial Content/Articles in SERP (FHR)", + "Session level test code for apps with different quality score in different language at filter.", + "Session level test code for Experimental TG Query.", + "Session level test code for nav card with high quality canonical mdp app.", "Session level test code that indicates the decline reason is populated to payment decline email.", "Session level test code for Quest Content Card launch on Deals Home, for tracking users who made eligible purchases and are eligible for the QCC.", "For low quality deep link details page. go/low-quality-deep-link-details-page Whether the details page comes from a deep link and its app is low quality.", @@ -129616,6 +129597,9 @@ "Session-level test code for Play Onboarding Experience flow.", "Session-level test code for Because You Played experiments.", "Session-level test code for Because You Played experiments.", + "Session-level test code for loyalty weekly rewards in Now! home.", + "Session-level test code for multiline addon title.", + "Session-level test code for Paytm wallet failures.", "", "Cart abandonment flow for purchase flow.", "User saw/would have seen the in app products section in App", @@ -129714,6 +129698,12 @@ "", "", "", + "", + "", + "", + "", + "", + "", "User saw/would have seen the subscription one time pass offer", "", "", @@ -129726,6 +129716,7 @@ "Test code for when a user was eligible for visual preview while in motion. E.g. received a notification and had visual preview setting enabled.", "", "", + "", "Test code logged on client side for users who see the Play Pass signup interstitial.", "Test codes for seeing the effects of disabling topup in select countries.", "", @@ -129775,8 +129766,10 @@ "", "", "", + "", "Test codes for GE DSA opt-in users.", "Test code for the loyalty purchase quest I15n experiment", + "Test code for the P3-GE Post Purchase Offer integration / i15n experiment", "User level test code for tracking users who should see the IAP Sku Deals liveops card.", "User level test code for tracking users who should see the IAP Sku Games Home liveops card.", "User level test code for tracking users who should see the featuring AHC or FHR.", @@ -129820,6 +129813,8 @@ "User level test code for link biometrics with impression cap and foped user setup.", "User level test code for link biometrics with impression cap and foped user setup.", "User level test code for link biometrics with impression cap and foped user setup after traffic rebalancing.", + "User level test code for link biometrics with impression cap and foped user setup after traffic rebalancing.", + "User level test code for link biometrics with impression cap and foped user setup after traffic rebalancing.", "User level test code for post success add backup flow.", "User level test code for skipping ckechmark screen with backup flow.", "User level test code for users who are eligible for one-click backup fop.", @@ -129888,6 +129883,7 @@ "User level test code for reinstall enablement. If user has any eligible reinstall passing the per user filtering logic, testcode will be logged. Note that the filtering logics are controlled by gcl flags. Ex. Play Games Home: http://shortn/_2aGCRQqToq. This test code only knows if any app passes the filtering but not which filtering params are applied.", "User level test code for tagging users who have any app which is recommended by PRS and has reinstall eligibility when is_app_with_historical_oop_purchase restriction is turned on.", "User-level test code for tagging users with previous OOP spend on games.", + "User-level test code for tagging users with previous OOP spend on applications.", "User level test code for notification campaign gain filtering experiments. If GE decision changed after applying predicted revenue gain filtering on notification campaigns, log test code.", "User level test code for notification campaign gain filtering experiments. If GE decision changed after disabling publicity gain in notification campaign benefit calculation, log test code.", "Unack Warning Message user-level test code. Design: go/unack-warning-message-on-dp-dd", @@ -129943,13 +129939,25 @@ "User-level test code for users eligible for the Comics cluster on AH.", "User-level test code for users with high Comics app usage (e.g. >=15 in last 28d ays).", "User-level test code for users with high Comics app usage (e.g. >=10 in last 28d ays).", + "User-level test code for users who had Piccoma installed for the Comics Sampling Cluster Experiment.", + "User-level test code for users who had Manga One installed for the Comics Sampling Cluster Experiment.", + "User-level test code for users who had Magapoke installed for the Comics Sampling Cluster Experiment.", + "User-level test code for users who had Jump+ installed for the Comics Sampling Cluster Experiment.", + "User-level test code for users who had Line Manga installed for the Comics Sampling Cluster Experiment.", + "User-level test code for users who had any of the 5 manga apps listed above installed for the Comics Sampling Cluster Experiment.", "User level test code for Redeem Save buyer offer study, tracking users who actually get different experience between control and treatment.", "User-level test code marking users who have seen the add new fop option screen during purchase flow. This will be used for ranking of add fop options experiments.", - "User level test code for SKU Recommendation in Cart Abandonment.", + "User level test code for SKU Recommendation in Cart Abandonment, currently used for popular after abandon candidates.", + "User level test code for SKU Recommendation in Cart Abandonment, specifically for lower-priced candidates.", "User level test code for stored value top-up email reminder.", "User level test code for users who are eligible for one-click backup fop in fix flow", "User level test code for displaying sub-entitlement benefits on websky.", "User level test code for stored value top-up email reminder (V2).", + "User level test code for loyalty weekly rewards in Now! home.", + "User level test code for users who should have seen preregistration notification dialog.", + "User level test code for multiline addon title.", + "User level test code for unified SKU Recommendations. Used when user is eligible for any SKU Recommendation, currently either cart-abandonment or post-success upsell.", + "", "" ], "type": "string" @@ -131676,6 +131684,10 @@ "ADSBURST_V2_128D", "ADSBURST_V2_64D", "ADSBURST_V2_32D", + "ADSBURST_V2_1", + "ADSBURST_V2_1_128D", + "ADSBURST_V2_1_64D", + "ADSBURST_V2_1_32D", "SHOPPING_IMAGE_TRANSFORMATION_UNCROP", "SHOPPING_IMAGE_TRANSFORMATION_V2", "SCREENAI_V1", @@ -131787,6 +131799,10 @@ false, false, false, + false, + false, + false, + false, true, false, false, @@ -131894,6 +131910,10 @@ "", "", "", + "", + "", + "", + "", "Shopping image transformation versions.", "", "ScreenAI versions. IconNet.", @@ -147888,7 +147908,7 @@ "MUSIC_PRIMARY_RECORDING", "MUSIC_RECORDING_ARTIST", "MUSIC_FEATURED_ARTIST", - "MUSIC_SHUNA_REMIX_ARTIST", + "MUSIC_GENERATED_REMIX_ARTIST", "MUSIC_COMPOSITION", "MUSIC_ORIGINAL_ARTIST_OF_COVER", "MUSIC_ORIGINAL_RECORDING_CLUSTER_OF_COVER", diff --git a/discovery/dataflow-v1b3.json b/discovery/dataflow-v1b3.json index 3fb2dd6e1f..18f2f42f80 100644 --- a/discovery/dataflow-v1b3.json +++ b/discovery/dataflow-v1b3.json @@ -24,6 +24,13 @@ "description": "Manages Google Cloud Dataflow projects on Google Cloud Platform.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/dataflow", + "endpoints": [ + { + "endpointUrl": "https://dataflow.me-central2.rep.googleapis.com/", + "location": "me-central2", + "description": "Regional Endpoint" + } + ], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -2214,7 +2221,7 @@ } } }, - "revision": "20230917", + "revision": "20230929", "rootUrl": "https://dataflow.googleapis.com/", "schemas": { "ApproximateProgress": { diff --git a/discovery/datalabeling-v1beta1.json b/discovery/datalabeling-v1beta1.json index b17b94453d..0f1cc53620 100644 --- a/discovery/datalabeling-v1beta1.json +++ b/discovery/datalabeling-v1beta1.json @@ -1596,7 +1596,7 @@ } } }, - "revision": "20230429", + "revision": "20231001", "rootUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { @@ -3513,6 +3513,7 @@ }, "csvInstruction": { "$ref": "GoogleCloudDatalabelingV1beta1CsvInstruction", + "deprecated": true, "description": "Deprecated: this instruction format is not supported any more. Instruction from a CSV file, such as for classification task. The CSV file should have exact two columns, in the following format: * The first column is labeled data, such as an image reference, text. * The second column is comma separated labels associated with data." }, "dataType": { @@ -4457,6 +4458,7 @@ }, "sentimentConfig": { "$ref": "GoogleCloudDatalabelingV1beta1SentimentConfig", + "deprecated": true, "description": "Optional. Configs for sentiment selection. We deprecate sentiment analysis in data labeling side as it is incompatible with uCAIP." } }, @@ -5611,7 +5613,7 @@ "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`.", + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", "type": "object" } }, diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index f7f53e0363..79478940ce 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -4360,7 +4360,7 @@ } } }, - "revision": "20230911", + "revision": "20231007", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -5523,10 +5523,26 @@ }, "type": "object" }, + "GoogleCloudDataplexV1DataQualityDimension": { + "description": "A dimension captures data quality intent about a defined subset of the rules specified.", + "id": "GoogleCloudDataplexV1DataQualityDimension", + "properties": { + "name": { + "description": "The dimension name a rule belongs to. Supported dimensions are \"COMPLETENESS\", \"ACCURACY\", \"CONSISTENCY\", \"VALIDITY\", \"UNIQUENESS\", \"INTEGRITY\"", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1DataQualityDimensionResult": { "description": "DataQualityDimensionResult provides a more detailed, per-dimension view of the results.", "id": "GoogleCloudDataplexV1DataQualityDimensionResult", "properties": { + "dimension": { + "$ref": "GoogleCloudDataplexV1DataQualityDimension", + "description": "Output only. The dimension config specified in the DataQualitySpec, as is.", + "readOnly": true + }, "passed": { "description": "Whether the dimension passed or failed.", "type": "boolean" @@ -7015,6 +7031,80 @@ }, "type": "object" }, + "GoogleCloudDataplexV1GovernanceEvent": { + "description": "Payload associated with Governance related log events.", + "id": "GoogleCloudDataplexV1GovernanceEvent", + "properties": { + "entity": { + "$ref": "GoogleCloudDataplexV1GovernanceEventEntity", + "description": "Entity resource information if the log event is associated with a specific entity." + }, + "eventType": { + "description": "The type of the event.", + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "RESOURCE_IAM_POLICY_UPDATE", + "BIGQUERY_TABLE_CREATE", + "BIGQUERY_TABLE_UPDATE", + "BIGQUERY_TABLE_DELETE", + "BIGQUERY_CONNECTION_CREATE", + "BIGQUERY_CONNECTION_UPDATE", + "BIGQUERY_CONNECTION_DELETE", + "BIGQUERY_TAXONOMY_CREATE", + "BIGQUERY_POLICY_TAG_CREATE", + "BIGQUERY_POLICY_TAG_DELETE", + "BIGQUERY_POLICY_TAG_SET_IAM_POLICY", + "ACCESS_POLICY_UPDATE" + ], + "enumDescriptions": [ + "An unspecified event type.", + "Resource IAM policy update event.", + "BigQuery table create event.", + "BigQuery table update event.", + "BigQuery table delete event.", + "BigQuery connection create event.", + "BigQuery connection update event.", + "BigQuery connection delete event.", + "BigQuery taxonomy created.", + "BigQuery policy tag created.", + "BigQuery policy tag deleted.", + "BigQuery set iam policy for policy tag.", + "Access policy update event." + ], + "type": "string" + }, + "message": { + "description": "The log message.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDataplexV1GovernanceEventEntity": { + "description": "Information about Entity resource that the log event is associated with.", + "id": "GoogleCloudDataplexV1GovernanceEventEntity", + "properties": { + "entity": { + "description": "The Entity resource the log event is associated with. Format: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}", + "type": "string" + }, + "entityType": { + "description": "Type of entity.", + "enum": [ + "ENTITY_TYPE_UNSPECIFIED", + "TABLE", + "FILESET" + ], + "enumDescriptions": [ + "An unspecified Entity type.", + "Table entity type.", + "Fileset entity type." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDataplexV1Job": { "description": "A job represents an instance of a task.", "id": "GoogleCloudDataplexV1Job", diff --git a/discovery/dataproc-v1.json b/discovery/dataproc-v1.json index 05f4f34b4b..79ee497de5 100644 --- a/discovery/dataproc-v1.json +++ b/discovery/dataproc-v1.json @@ -17,9 +17,9 @@ "documentationLink": "https://cloud.google.com/dataproc/", "endpoints": [ { + "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/", "location": "me-central2", - "description": "Regional Endpoint", - "endpointUrl": "https://dataproc.me-central2.rep.googleapis.com/" + "description": "Regional Endpoint" } ], "fullyEncodeReservedExpansion": true, @@ -2028,6 +2028,11 @@ "required": true, "type": "string" }, + "parentOperationId": { + "description": "Optional. operation id of the parent operation sending the create request", + "location": "query", + "type": "string" + }, "requestId": { "description": "Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "location": "query", @@ -3001,7 +3006,7 @@ } } }, - "revision": "20230919", + "revision": "20231002", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -4496,6 +4501,10 @@ "Instances are Spot VMs (https://cloud.google.com/compute/docs/instances/spot).This option is allowed only for secondary worker (https://cloud.google.com/dataproc/docs/concepts/compute/secondary-vms) groups. Spot VMs are the latest version of preemptible VMs (https://cloud.google.com/compute/docs/instances/preemptible), and provide additional features." ], "type": "string" + }, + "startupConfig": { + "$ref": "StartupConfig", + "description": "Optional. Configuration to handle the startup of instances during cluster create and update process." } }, "type": "object" @@ -5953,6 +5962,10 @@ "format": "google-duration", "type": "string" }, + "parentOperationId": { + "description": "Optional. operation id of the parent operation sending the resize request", + "type": "string" + }, "requestId": { "description": "Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters.", "type": "string" @@ -6640,6 +6653,10 @@ "format": "google-duration", "type": "string" }, + "removeOnlyIdleWorkers": { + "description": "Optional. Remove only idle workers when scaling down cluster", + "type": "boolean" + }, "scaleDownFactor": { "description": "Required. Fraction of required executors to remove from Spark Serverless clusters. A scale-down factor of 1.0 will result in scaling down so that there are no more executors for the Spark Job.(more aggressive scaling). A scale-down factor closer to 0 will result in a smaller magnitude of scaling donw (less aggressive scaling).Bounds: 0.0, 1.0.", "format": "double", @@ -6678,6 +6695,18 @@ }, "type": "object" }, + "StartupConfig": { + "description": "Configuration to handle the startup of instances during cluster create and update process.", + "id": "StartupConfig", + "properties": { + "requiredRegistrationFraction": { + "description": "Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "StateHistory": { "description": "Historical state information.", "id": "StateHistory", diff --git a/discovery/deploymentmanager-v2.json b/discovery/deploymentmanager-v2.json index b59d4ee58a..3283ad0394 100644 --- a/discovery/deploymentmanager-v2.json +++ b/discovery/deploymentmanager-v2.json @@ -333,7 +333,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, @@ -693,7 +693,7 @@ "type": "string" }, "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, @@ -783,7 +783,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, @@ -889,7 +889,7 @@ "type": "string" }, "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, @@ -944,7 +944,7 @@ ], "parameters": { "filter": { - "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`.", + "description": "A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `>`, `<`, `<=`, `>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = \"Intel Skylake\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = \"Intel Skylake\") OR (cpuPlatform = \"Intel Broadwell\") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq \"double quoted literal\"` `(fieldname1 eq literal) (fieldname2 ne \"literal\")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name \"instance\", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions.", "location": "query", "type": "string" }, @@ -988,7 +988,7 @@ } } }, - "revision": "20230905", + "revision": "20230928", "rootUrl": "https://deploymentmanager.googleapis.com/", "schemas": { "AuditConfig": { diff --git a/discovery/dialogflow-v2.json b/discovery/dialogflow-v2.json index 6dde43300e..92f5413053 100644 --- a/discovery/dialogflow-v2.json +++ b/discovery/dialogflow-v2.json @@ -8327,7 +8327,7 @@ } } }, - "revision": "20230906", + "revision": "20231002", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8834,6 +8834,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -9108,6 +9129,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -9136,6 +9202,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3InputAudioConfig", @@ -10938,6 +11017,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -11212,6 +11312,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -11240,6 +11385,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", diff --git a/discovery/dialogflow-v2beta1.json b/discovery/dialogflow-v2beta1.json index fb84249505..aa7a6a8d32 100644 --- a/discovery/dialogflow-v2beta1.json +++ b/discovery/dialogflow-v2beta1.json @@ -7695,7 +7695,7 @@ } } }, - "revision": "20230906", + "revision": "20231002", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -8202,6 +8202,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -8476,6 +8497,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -8504,6 +8570,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3InputAudioConfig", @@ -10306,6 +10385,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -10580,6 +10680,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -10608,6 +10753,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", diff --git a/discovery/dialogflow-v3.json b/discovery/dialogflow-v3.json index f8a4c46b2f..78b6ce2157 100644 --- a/discovery/dialogflow-v3.json +++ b/discovery/dialogflow-v3.json @@ -2576,6 +2576,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "export": { + "description": "Exports the selected intents. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.intents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent agent to export intents. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/intents:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ExportIntentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "get": { "description": "Retrieves the specified intent.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}", @@ -2607,6 +2636,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "import": { + "description": "Imports the specified intents into the agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse", + "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.intents.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to import the intents into. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/{+parent}/intents:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3ImportIntentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all intents in the specified agent.", "flatPath": "v3/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents", @@ -4068,7 +4126,7 @@ } } }, - "revision": "20230906", + "revision": "20231002", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -5376,6 +5434,65 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportIntentsRequest": { + "description": "The request message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsRequest", + "properties": { + "dataFormat": { + "description": "Optional. The data format of the exported intents. If not specified, `BLOB` is assumed.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "BLOB", + "JSON", + "CSV" + ], + "enumDescriptions": [ + "Unspecified format. Treated as `BLOB`.", + "Intents will be exported as raw bytes.", + "Intents will be exported in JSON format.", + "Intents will be exported in CSV format." + ], + "type": "string" + }, + "intents": { + "description": "Required. The name of the intents to export. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentsContentInline": { + "description": "Optional. The option to return the serialized intents inline.", + "type": "boolean" + }, + "intentsUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the intents to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -5949,6 +6066,97 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsRequest": { + "description": "The request message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsRequest", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3InlineSource", + "description": "Uncompressed byte content of intents." + }, + "intentsUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import intents from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + }, + "mergeOption": { + "description": "Merge option for importing intents. If not specified, `REJECT` is assumed.", + "enum": [ + "MERGE_OPTION_UNSPECIFIED", + "REJECT", + "REPLACE", + "MERGE", + "RENAME", + "REPORT_CONFLICT", + "KEEP" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified. Should not be used.", + "DEPRECATED: Please use REPORT_CONFLICT instead. Fail the request if there are intents whose display names conflict with the display names of intents in the agent.", + "Replace the original intent in the agent with the new intent when display name conflicts exist.", + "Merge the original intent with the new intent when display name conflicts exist.", + "Create new intents with new display names to differentiate them from the existing intents when display name conflicts exist.", + "Report conflict information if display names conflict is detected. Otherwise, import intents.", + "Keep the original intent and discard the conflicting new intent when display name conflicts exist." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -5993,6 +6201,31 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3InlineSource": { + "description": "Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.", + "id": "GoogleCloudDialogflowCxV3InlineSource", + "properties": { + "content": { + "description": "The uncompressed byte content for the objects.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3InputAudioConfig", @@ -9318,6 +9551,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -9592,6 +9846,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -9620,6 +9919,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index 7cda626441..6d7b999030 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -2576,6 +2576,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "export": { + "description": "Exports the selected intents. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:export", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.intents.export", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The name of the parent agent to export intents. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+parent}/intents:export", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1ExportIntentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "get": { "description": "Retrieves the specified intent.", "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents/{intentsId}", @@ -2607,6 +2636,35 @@ "https://www.googleapis.com/auth/dialogflow" ] }, + "import": { + "description": "Imports the specified intents into the agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse", + "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents:import", + "httpMethod": "POST", + "id": "dialogflow.projects.locations.agents.intents.import", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The agent to import the intents into. Format: `projects//locations//agents/`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/agents/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3beta1/{+parent}/intents:import", + "request": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/dialogflow" + ] + }, "list": { "description": "Returns the list of all intents in the specified agent.", "flatPath": "v3beta1/projects/{projectsId}/locations/{locationsId}/agents/{agentsId}/intents", @@ -4068,7 +4126,7 @@ } } }, - "revision": "20230906", + "revision": "20231002", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -4575,6 +4633,27 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3ExportTestCasesMetadata", @@ -4849,6 +4928,51 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3ImportTestCasesMetadata", @@ -4877,6 +5001,19 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3InputAudioConfig", @@ -7480,6 +7617,65 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata": { + "description": "Metadata returned for the Intents.ExportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsRequest": { + "description": "The request message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsRequest", + "properties": { + "dataFormat": { + "description": "Optional. The data format of the exported intents. If not specified, `BLOB` is assumed.", + "enum": [ + "DATA_FORMAT_UNSPECIFIED", + "BLOB", + "JSON", + "CSV" + ], + "enumDescriptions": [ + "Unspecified format. Treated as `BLOB`.", + "Intents will be exported as raw bytes.", + "Intents will be exported in JSON format.", + "Intents will be exported in CSV format." + ], + "type": "string" + }, + "intents": { + "description": "Required. The name of the intents to export. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentsContentInline": { + "description": "Optional. The option to return the serialized intents inline.", + "type": "boolean" + }, + "intentsUri": { + "description": "Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the intents to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse": { + "description": "The response message for Intents.ExportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ExportIntentsResponse", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "description": "Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest." + }, + "intentsUri": { + "description": "The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields.", "id": "GoogleCloudDialogflowCxV3beta1ExportTestCasesMetadata", @@ -8053,6 +8249,97 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata": { + "description": "Metadata returned for the Intents.ImportIntents long running operation.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata", + "properties": {}, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsRequest": { + "description": "The request message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsRequest", + "properties": { + "intentsContent": { + "$ref": "GoogleCloudDialogflowCxV3beta1InlineSource", + "description": "Uncompressed byte content of intents." + }, + "intentsUri": { + "description": "The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import intents from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage).", + "type": "string" + }, + "mergeOption": { + "description": "Merge option for importing intents. If not specified, `REJECT` is assumed.", + "enum": [ + "MERGE_OPTION_UNSPECIFIED", + "REJECT", + "REPLACE", + "MERGE", + "RENAME", + "REPORT_CONFLICT", + "KEEP" + ], + "enumDeprecated": [ + false, + true, + false, + false, + false, + false, + false + ], + "enumDescriptions": [ + "Unspecified. Should not be used.", + "DEPRECATED: Please use REPORT_CONFLICT instead. Fail the request if there are intents whose display names conflict with the display names of intents in the agent.", + "Replace the original intent in the agent with the new intent when display name conflicts exist.", + "Merge the original intent with the new intent when display name conflicts exist.", + "Create new intents with new display names to differentiate them from the existing intents when display name conflicts exist.", + "Report conflict information if display names conflict is detected. Otherwise, import intents.", + "Keep the original intent and discard the conflicting new intent when display name conflicts exist." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse": { + "description": "The response message for Intents.ImportIntents.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponse", + "properties": { + "conflictingResources": { + "$ref": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "description": "Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest." + }, + "intents": { + "description": "The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources": { + "description": "Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names.", + "id": "GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources", + "properties": { + "entityDisplayNames": { + "description": "Display names of conflicting entities.", + "items": { + "type": "string" + }, + "type": "array" + }, + "intentDisplayNames": { + "description": "Display names of conflicting intents.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata": { "description": "Metadata returned for the TestCases.ImportTestCases long running operation.", "id": "GoogleCloudDialogflowCxV3beta1ImportTestCasesMetadata", @@ -8097,6 +8384,31 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1InlineDestination": { + "description": "Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow.", + "id": "GoogleCloudDialogflowCxV3beta1InlineDestination", + "properties": { + "content": { + "description": "Output only. The uncompressed byte content for the objects. Only populated in responses.", + "format": "byte", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1InlineSource": { + "description": "Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow.", + "id": "GoogleCloudDialogflowCxV3beta1InlineSource", + "properties": { + "content": { + "description": "The uncompressed byte content for the objects.", + "format": "byte", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1InputAudioConfig": { "description": "Instructs the speech recognizer on how to process the audio content.", "id": "GoogleCloudDialogflowCxV3beta1InputAudioConfig", diff --git a/discovery/discoveryengine-v1alpha.json b/discovery/discoveryengine-v1alpha.json index 0e4b67b604..af53f2c257 100644 --- a/discovery/discoveryengine-v1alpha.json +++ b/discovery/discoveryengine-v1alpha.json @@ -256,7 +256,7 @@ "type": "string" }, "queryModel": { - "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.", + "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "location": "query", "type": "string" }, @@ -1185,6 +1185,36 @@ } }, "siteSearchEngine": { + "methods": { + "recrawlUris": { + "description": "Request on-demand recrawl for a list of URIs.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.dataStores.siteSearchEngine.recrawlUris", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:recrawlUris", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "operations": { "methods": { @@ -1534,6 +1564,66 @@ ] } } + }, + "servingConfigs": { + "methods": { + "recommend": { + "description": "Makes a recommendation, which requires a contextual user event.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.recommend", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+servingConfig}:recommend", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecommendResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "search": { + "description": "Performs a search.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.search", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+servingConfig}:search", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -1638,7 +1728,7 @@ "type": "string" }, "queryModel": { - "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.", + "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "location": "query", "type": "string" }, @@ -2494,6 +2584,38 @@ } } }, + "siteSearchEngine": { + "methods": { + "recrawlUris": { + "description": "Request on-demand recrawl for a list of URIs.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/siteSearchEngine:recrawlUris", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.dataStores.siteSearchEngine.recrawlUris", + "parameterOrder": [ + "siteSearchEngine" + ], + "parameters": { + "siteSearchEngine": { + "description": "Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/siteSearchEngine$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+siteSearchEngine}:recrawlUris", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "userEvents": { "methods": { "collect": { @@ -2770,7 +2892,7 @@ } } }, - "revision": "20230914", + "revision": "20231003", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3223,7 +3345,7 @@ "type": "string" }, "queryModel": { - "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.", + "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "type": "string" }, "userPseudoId": { @@ -3653,7 +3775,8 @@ "STRING", "NUMBER", "INTEGER", - "BOOLEAN" + "BOOLEAN", + "GEOLOCATION" ], "enumDescriptions": [ "Field type is unspecified.", @@ -3661,7 +3784,8 @@ "Field value type is String.", "Field value type is Number.", "Field value type is Integer.", - "Field value type is Boolean." + "Field value type is Boolean.", + "Field value type is Geolocation." ], "readOnly": true, "type": "string" @@ -4327,6 +4451,128 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "invalidUris": { + "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" + }, + "successCount": { + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest": { + "description": "Request message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest", + "properties": { + "uris": { + "description": "Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "properties": { + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" + }, + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "properties": { + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + }, + "type": "array" + }, + "uri": { + "description": "URI that failed to be crawled.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "properties": { + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "enumDescriptions": [ + "Default value.", + "Denotes a crawling attempt for the desktop version of a page.", + "Denotes a crawling attempt for the mobile version of a page." + ], + "type": "string" + }, + "errorMessage": { + "description": "Reason why the URI was not crawled.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaReply": { "description": "Defines a reply message to user.", "id": "GoogleCloudDiscoveryengineV1alphaReply", @@ -4846,6 +5092,12 @@ }, "type": "array" }, + "geoSearchDebugInfo": { + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo" + }, + "type": "array" + }, "guidedSearchResult": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", "description": "Guided search result." @@ -4923,6 +5175,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo": { + "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", + "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo", + "properties": { + "errorMessage": { + "description": "The error produced.", + "type": "string" + }, + "originalAddressQuery": { + "description": "The address from which forward geocoding ingestion produced issues.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult": { "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", "id": "GoogleCloudDiscoveryengineV1alphaSearchResponseGuidedSearchResult", @@ -5495,10 +5762,29 @@ "readOnly": true, "type": "boolean" }, + "minimumDataTermAccepted": { + "description": "Output only. Whether the customer accepted data use terms.", + "readOnly": true, + "type": "boolean" + }, "name": { "description": "Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.", "type": "string" }, + "resultDisplayType": { + "description": "The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users.", + "enum": [ + "RESULT_DISPLAY_TYPE_UNSPECIFIED", + "SNIPPET", + "EXTRACTIVE_ANSWER" + ], + "enumDescriptions": [ + "Unspecified display type (default to showing snippet).", + "Display results from the snippet field.", + "Display results from extractive answers field." + ], + "type": "string" + }, "solutionType": { "description": "Required. Immutable. Specifies the solution type that this WidgetConfig can be used for.", "enum": [ diff --git a/discovery/discoveryengine-v1beta.json b/discovery/discoveryengine-v1beta.json index f57023373a..e24dc56bfc 100644 --- a/discovery/discoveryengine-v1beta.json +++ b/discovery/discoveryengine-v1beta.json @@ -140,7 +140,7 @@ "type": "string" }, "queryModel": { - "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.", + "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "location": "query", "type": "string" }, @@ -1390,6 +1390,66 @@ ] } } + }, + "servingConfigs": { + "methods": { + "recommend": { + "description": "Makes a recommendation, which requires a contextual user event.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:recommend", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.recommend", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. Full resource name of the format: `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*` Before you can request recommendations from your model, you must create at least one serving config for it.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+servingConfig}:recommend", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaRecommendRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaRecommendResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "search": { + "description": "Performs a search.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/engines/{enginesId}/servingConfigs/{servingConfigsId}:search", + "httpMethod": "POST", + "id": "discoveryengine.projects.locations.collections.engines.servingConfigs.search", + "parameterOrder": [ + "servingConfig" + ], + "parameters": { + "servingConfig": { + "description": "Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/collections/[^/]+/engines/[^/]+/servingConfigs/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+servingConfig}:search", + "request": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequest" + }, + "response": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } } } }, @@ -1494,7 +1554,7 @@ "type": "string" }, "queryModel": { - "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores.", + "description": "Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores.", "location": "query", "type": "string" }, @@ -2598,7 +2658,7 @@ } } }, - "revision": "20230914", + "revision": "20231003", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3070,7 +3130,8 @@ "STRING", "NUMBER", "INTEGER", - "BOOLEAN" + "BOOLEAN", + "GEOLOCATION" ], "enumDescriptions": [ "Field type is unspecified.", @@ -3078,7 +3139,8 @@ "Field value type is String.", "Field value type is Number.", "Field value type is Integer.", - "Field value type is Boolean." + "Field value type is Boolean.", + "Field value type is Geolocation." ], "readOnly": true, "type": "string" @@ -3343,6 +3405,114 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata": { + "description": "Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata", + "properties": { + "createTime": { + "description": "Operation create time.", + "format": "google-datetime", + "type": "string" + }, + "invalidUris": { + "description": "Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.", + "items": { + "type": "string" + }, + "type": "array" + }, + "pendingCount": { + "description": "Total number of URIs that have yet to be crawled.", + "format": "int32", + "type": "integer" + }, + "quotaExceededCount": { + "description": "Total number of URIs that were rejected due to insufficient indexing resources.", + "format": "int32", + "type": "integer" + }, + "successCount": { + "description": "Total number of URIs that have been crawled so far.", + "format": "int32", + "type": "integer" + }, + "updateTime": { + "description": "Operation last update time. If the operation is done, this is also the finish time.", + "format": "google-datetime", + "type": "string" + }, + "validUrisCount": { + "description": "Total number of unique URIs in the request that are not in invalid_uris.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse": { + "description": "Response message for SiteSearchEngineService.RecrawlUris method.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse", + "properties": { + "failedUris": { + "description": "URIs that were not crawled before the LRO terminated.", + "items": { + "type": "string" + }, + "type": "array" + }, + "failureSamples": { + "description": "Details for a sample of up to 10 `failed_uris`.", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo": { + "description": "Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo", + "properties": { + "failureReasons": { + "description": "List of failure reasons by corpus type (e.g. desktop, mobile).", + "items": { + "$ref": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason" + }, + "type": "array" + }, + "uri": { + "description": "URI that failed to be crawled.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason": { + "description": "Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons.", + "id": "GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason", + "properties": { + "corpusType": { + "description": "DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.", + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DESKTOP", + "MOBILE" + ], + "enumDescriptions": [ + "Default value.", + "Denotes a crawling attempt for the desktop version of a page.", + "Denotes a crawling attempt for the mobile version of a page." + ], + "type": "string" + }, + "errorMessage": { + "description": "Reason why the URI was not crawled.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1alphaSchema": { "description": "Defines the structure and layout of a type of document data.", "id": "GoogleCloudDiscoveryengineV1alphaSchema", @@ -4940,6 +5110,12 @@ }, "type": "array" }, + "geoSearchDebugInfo": { + "items": { + "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo" + }, + "type": "array" + }, "guidedSearchResult": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult", "description": "Guided search result." @@ -5017,6 +5193,21 @@ }, "type": "object" }, + "GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo": { + "description": "Debug information specifically related to forward geocoding issues arising from Geolocation Search.", + "id": "GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo", + "properties": { + "errorMessage": { + "description": "The error produced.", + "type": "string" + }, + "originalAddressQuery": { + "description": "The address from which forward geocoding ingestion produced issues.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult": { "description": "Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results.", "id": "GoogleCloudDiscoveryengineV1betaSearchResponseGuidedSearchResult", diff --git a/discovery/displayvideo-v1.json b/discovery/displayvideo-v1.json index 20420750e0..81921d9a65 100644 --- a/discovery/displayvideo-v1.json +++ b/discovery/displayvideo-v1.json @@ -3345,7 +3345,7 @@ "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.", + "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", "flatPath": "v1/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", "httpMethod": "POST", "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", @@ -8146,7 +8146,7 @@ } } }, - "revision": "20230921", + "revision": "20231009", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -8488,7 +8488,7 @@ "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.", + "description": "Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.", "enum": [ "AGE_RANGE_UNSPECIFIED", "AGE_RANGE_18_24", @@ -8724,7 +8724,7 @@ "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.", + "description": "An assignment between a location list and a relevant targeting option.", "id": "AssignedLocation", "properties": { "assignedLocationId": { @@ -8739,7 +8739,7 @@ "type": "string" }, "targetingOptionId": { - "description": "Required. The ID of the targeting option assigned to the location list. Assigned locations can only be modified in TARGETING_LOCATION_TYPE_REGIONAL location lists. When creating or deleting assigned locations, this value must be of type TARGETING_TYPE_GEO_REGION.", + "description": "Required. The ID of the targeting option assigned to the location list.", "type": "string" } }, @@ -9153,7 +9153,7 @@ "id": "AudioContentTypeAssignedTargetingOptionDetails", "properties": { "audioContentType": { - "description": "The audio content type. Output only in v1. Required in v2.", + "description": "Required. The audio content type.", "enum": [ "AUDIO_CONTENT_TYPE_UNSPECIFIED", "AUDIO_CONTENT_TYPE_UNKNOWN", @@ -9481,14 +9481,14 @@ "id": "BulkEditAssignedLocationsRequest", "properties": { "createdAssignedLocations": { - "description": "The assigned locations to create in bulk, specified as a list of AssignedLocations.", + "description": "The assigned locations to create in bulk, specified as a list of AssignedLocation resources.", "items": { "$ref": "AssignedLocation" }, "type": "array" }, "deletedAssignedLocations": { - "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.", + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.", "items": { "format": "int64", "type": "string" @@ -9499,7 +9499,6 @@ "type": "object" }, "BulkEditAssignedLocationsResponse": { - "description": "Response message for AssignedLocationService.BulkEditAssignedLocations.", "id": "BulkEditAssignedLocationsResponse", "properties": { "assignedLocations": { @@ -10502,7 +10501,7 @@ "type": "string" }, "contentInstreamPosition": { - "description": "The content instream position for video or audio ads. Output only in v1. Required in v2.", + "description": "Required. The content instream position for video or audio ads.", "enum": [ "CONTENT_INSTREAM_POSITION_UNSPECIFIED", "CONTENT_INSTREAM_POSITION_PRE_ROLL", @@ -10574,7 +10573,7 @@ "type": "string" }, "contentOutstreamPosition": { - "description": "The content outstream position. Output only in v1. Required in v2.", + "description": "Required. The content outstream position.", "enum": [ "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", "CONTENT_OUTSTREAM_POSITION_UNKNOWN", @@ -11491,7 +11490,7 @@ "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.", + "description": "Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.", "items": { "$ref": "ScriptError" }, @@ -11836,7 +11835,7 @@ "id": "DeviceTypeAssignedTargetingOptionDetails", "properties": { "deviceType": { - "description": "The display name of the device type. Output only in v1. Required in v2.", + "description": "Required. The display name of the device type.", "enum": [ "DEVICE_TYPE_UNSPECIFIED", "DEVICE_TYPE_COMPUTER", @@ -11846,10 +11845,10 @@ ], "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." + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet." ], "type": "string" }, @@ -11875,10 +11874,10 @@ ], "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." + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet." ], "readOnly": true, "type": "string" @@ -12445,7 +12444,7 @@ "id": "EnvironmentAssignedTargetingOptionDetails", "properties": { "environment": { - "description": "The serving environment. Output only in v1. Required in v2.", + "description": "Required. The serving environment.", "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_WEB_OPTIMIZED", @@ -13443,7 +13442,7 @@ "id": "GenderAssignedTargetingOptionDetails", "properties": { "gender": { - "description": "The gender of the audience. Output only in v1. Required in v2.", + "description": "Required. The gender of the audience.", "enum": [ "GENDER_UNSPECIFIED", "GENDER_MALE", @@ -13527,8 +13526,8 @@ "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`.", - "Digital display out of home. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital video out of home. Line items of this type and their targeting cannot be created or updated using the API." + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." ], "type": "string" }, @@ -14090,7 +14089,7 @@ "id": "HouseholdIncomeAssignedTargetingOptionDetails", "properties": { "householdIncome": { - "description": "The household income of the audience. Output only in v1. Required in v2.", + "description": "Required. The household income of the audience.", "enum": [ "HOUSEHOLD_INCOME_UNSPECIFIED", "HOUSEHOLD_INCOME_UNKNOWN", @@ -14364,9 +14363,9 @@ ], "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.", + "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", - "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by performance_goal." + "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." ], "type": "string" }, @@ -15421,8 +15420,8 @@ "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`.", - "Digital display out of home. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital video out of home. Line items of this type and their targeting cannot be created or updated using the API." + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." ], "type": "string" }, @@ -16399,7 +16398,7 @@ "id": "NativeContentPositionAssignedTargetingOptionDetails", "properties": { "contentPosition": { - "description": "The content position. Output only in v1. Required in v2.", + "description": "Required. The content position.", "enum": [ "NATIVE_CONTENT_POSITION_UNSPECIFIED", "NATIVE_CONTENT_POSITION_UNKNOWN", @@ -16573,7 +16572,7 @@ "id": "OmidAssignedTargetingOptionDetails", "properties": { "omid": { - "description": "The type of Open Measurement enabled inventory. Output only in v1. Required in v2.", + "description": "Required. The type of Open Measurement enabled inventory.", "enum": [ "OMID_UNSPECIFIED", "OMID_FOR_MOBILE_DISPLAY_ADS" @@ -16762,7 +16761,7 @@ "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`.", + "description": "Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.", "enum": [ "PACING_PERIOD_UNSPECIFIED", "PACING_PERIOD_DAILY", @@ -16861,7 +16860,7 @@ "id": "ParentalStatusAssignedTargetingOptionDetails", "properties": { "parentalStatus": { - "description": "The parental status of the audience. Output only in v1. Required in v2.", + "description": "Required. The parental status of the audience.", "enum": [ "PARENTAL_STATUS_UNSPECIFIED", "PARENTAL_STATUS_PARENT", @@ -17159,7 +17158,7 @@ "type": "object" }, "PerformanceGoal": { - "description": "Settings that control the performance goal of a campaign or insertion order.", + "description": "Settings that control the performance goal of a campaign.", "id": "PerformanceGoal", "properties": { "performanceGoalAmountMicros": { @@ -18653,7 +18652,7 @@ "type": "string" }, "videoPlayerSize": { - "description": "The video player size. Output only in v1. Required in v2.", + "description": "Required. The video player size.", "enum": [ "VIDEO_PLAYER_SIZE_UNSPECIFIED", "VIDEO_PLAYER_SIZE_SMALL", @@ -18708,7 +18707,7 @@ "type": "string" }, "viewability": { - "description": "The predicted viewability percentage. Output only in v1. Required in v2.", + "description": "Required. The predicted viewability percentage.", "enum": [ "VIEWABILITY_UNSPECIFIED", "VIEWABILITY_10_PERCENT_OR_MORE", diff --git a/discovery/displayvideo-v2.json b/discovery/displayvideo-v2.json index df13f9db1c..2cb9170f70 100644 --- a/discovery/displayvideo-v2.json +++ b/discovery/displayvideo-v2.json @@ -3750,7 +3750,7 @@ "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.", + "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", "flatPath": "v2/advertisers/{advertiserId}/locationLists/{locationListsId}/assignedLocations:bulkEdit", "httpMethod": "POST", "id": "displayvideo.advertisers.locationLists.assignedLocations.bulkEdit", @@ -5236,7 +5236,7 @@ "youtubeAdGroups": { "methods": { "bulkListAdGroupAssignedTargetingOptions": { - "description": "Lists assigned targeting options for multiple YouTube ad groups across targeting types. Inherieted assigned targeting options are not included.", + "description": "Lists assigned targeting options for multiple YouTube ad groups across targeting types. Inherited assigned targeting options are not included.", "flatPath": "v2/advertisers/{advertisersId}/youtubeAdGroups:bulkListAdGroupAssignedTargetingOptions", "httpMethod": "GET", "id": "displayvideo.advertisers.youtubeAdGroups.bulkListAdGroupAssignedTargetingOptions", @@ -5258,7 +5258,7 @@ "type": "string" }, "orderBy": { - "description": "Optional. Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (acceptable in v2) * `adGroupId` (acceptable in v3) * `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`.", + "description": "Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", "location": "query", "type": "string" }, @@ -9172,7 +9172,7 @@ } } }, - "revision": "20230921", + "revision": "20231009", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActivateManualTriggerRequest": { @@ -9377,7 +9377,7 @@ }, "billingConfig": { "$ref": "AdvertiserBillingConfig", - "description": "Billing related settings of the advertiser." + "description": "Required. Billing related settings of the advertiser." }, "creativeConfig": { "$ref": "AdvertiserCreativeConfig", @@ -9466,7 +9466,7 @@ "id": "AdvertiserBillingConfig", "properties": { "billingProfileId": { - "description": "The ID of a billing profile assigned to the advertiser. This field will default to the default billing profile ID of the advertiser's parent partner if a value is not provided.", + "description": "The ID of a billing profile assigned to the advertiser.", "format": "int64", "type": "string" } @@ -9559,7 +9559,7 @@ "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.", + "description": "Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.", "enum": [ "AGE_RANGE_UNSPECIFIED", "AGE_RANGE_18_24", @@ -9831,7 +9831,7 @@ "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.", + "description": "An assignment between a location list and a relevant targeting option.", "id": "AssignedLocation", "properties": { "assignedLocationId": { @@ -9846,7 +9846,7 @@ "type": "string" }, "targetingOptionId": { - "description": "Required. The ID of the targeting option assigned to the location list. Assigned locations can only be modified in TARGETING_LOCATION_TYPE_REGIONAL location lists. When creating or deleting assigned locations, this value must be of type TARGETING_TYPE_GEO_REGION.", + "description": "Required. The ID of the targeting option assigned to the location list.", "type": "string" } }, @@ -10306,7 +10306,7 @@ "id": "AudioContentTypeAssignedTargetingOptionDetails", "properties": { "audioContentType": { - "description": "The audio content type. Output only in v1. Required in v2.", + "description": "Required. The audio content type.", "enum": [ "AUDIO_CONTENT_TYPE_UNSPECIFIED", "AUDIO_CONTENT_TYPE_UNKNOWN", @@ -10630,14 +10630,14 @@ "id": "BulkEditAssignedLocationsRequest", "properties": { "createdAssignedLocations": { - "description": "The assigned locations to create in bulk, specified as a list of AssignedLocations.", + "description": "The assigned locations to create in bulk, specified as a list of AssignedLocation resources.", "items": { "$ref": "AssignedLocation" }, "type": "array" }, "deletedAssignedLocations": { - "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids.", + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.", "items": { "format": "int64", "type": "string" @@ -10648,7 +10648,6 @@ "type": "object" }, "BulkEditAssignedLocationsResponse": { - "description": "Response message for AssignedLocationService.BulkEditAssignedLocations.", "id": "BulkEditAssignedLocationsResponse", "properties": { "assignedLocations": { @@ -10873,7 +10872,7 @@ "id": "BulkListAdGroupAssignedTargetingOptionsResponse", "properties": { "nextPageToken": { - "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more youtube_ad_group_assigned_targeting_options or ad_group_assigned_targeting_options to return.", + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return.", "type": "string" }, "youtubeAdGroupAssignedTargetingOptions": { @@ -11802,7 +11801,7 @@ "type": "string" }, "contentInstreamPosition": { - "description": "The content instream position for video or audio ads. Output only in v1. Required in v2.", + "description": "Required. The content instream position for video or audio ads.", "enum": [ "CONTENT_INSTREAM_POSITION_UNSPECIFIED", "CONTENT_INSTREAM_POSITION_PRE_ROLL", @@ -11870,7 +11869,7 @@ "type": "string" }, "contentOutstreamPosition": { - "description": "The content outstream position. Output only in v1. Required in v2.", + "description": "Required. The content outstream position.", "enum": [ "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", "CONTENT_OUTSTREAM_POSITION_UNKNOWN", @@ -12789,7 +12788,7 @@ "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.", + "description": "Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.", "items": { "$ref": "ScriptError" }, @@ -13171,7 +13170,7 @@ "id": "DeviceTypeAssignedTargetingOptionDetails", "properties": { "deviceType": { - "description": "The display name of the device type. Output only in v1. Required in v2.", + "description": "Required. The display name of the device type.", "enum": [ "DEVICE_TYPE_UNSPECIFIED", "DEVICE_TYPE_COMPUTER", @@ -13181,10 +13180,10 @@ ], "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." + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet." ], "type": "string" }, @@ -13212,10 +13211,10 @@ ], "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." + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet." ], "readOnly": true, "type": "string" @@ -13815,7 +13814,7 @@ "id": "EnvironmentAssignedTargetingOptionDetails", "properties": { "environment": { - "description": "The serving environment. Output only in v1. Required in v2.", + "description": "Required. The serving environment.", "enum": [ "ENVIRONMENT_UNSPECIFIED", "ENVIRONMENT_WEB_OPTIMIZED", @@ -14968,7 +14967,7 @@ "id": "GenderAssignedTargetingOptionDetails", "properties": { "gender": { - "description": "The gender of the audience. Output only in v1. Required in v2.", + "description": "Required. The gender of the audience.", "enum": [ "GENDER_UNSPECIFIED", "GENDER_MALE", @@ -15070,8 +15069,8 @@ "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital display out of home. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital video out of home. Line items of this type and their targeting cannot be created or updated using the API." + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." ], "type": "string" }, @@ -15633,7 +15632,7 @@ "id": "HouseholdIncomeAssignedTargetingOptionDetails", "properties": { "householdIncome": { - "description": "The household income of the audience. Output only in v1. Required in v2.", + "description": "Required. The household income of the audience.", "enum": [ "HOUSEHOLD_INCOME_UNSPECIFIED", "HOUSEHOLD_INCOME_UNKNOWN", @@ -15945,9 +15944,9 @@ ], "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.", + "Automatic budget allocation. Allow the system to automatically shift budget to owning line items to optimize performance defined by kpi. No automation on bid settings.", "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", - "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by performance_goal." + "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." ], "type": "string" }, @@ -17016,8 +17015,8 @@ "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital display out of home. Line items of this type and their targeting cannot be created or updated using the API.", - "Digital video out of home. Line items of this type and their targeting cannot be created or updated using the API." + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." ], "type": "string" }, @@ -18116,7 +18115,7 @@ "id": "NativeContentPositionAssignedTargetingOptionDetails", "properties": { "contentPosition": { - "description": "The content position. Output only in v1. Required in v2.", + "description": "Required. The content position.", "enum": [ "NATIVE_CONTENT_POSITION_UNSPECIFIED", "NATIVE_CONTENT_POSITION_UNKNOWN", @@ -18304,7 +18303,7 @@ "id": "OmidAssignedTargetingOptionDetails", "properties": { "omid": { - "description": "The type of Open Measurement enabled inventory. Output only in v1. Required in v2.", + "description": "Required. The type of Open Measurement enabled inventory.", "enum": [ "OMID_UNSPECIFIED", "OMID_FOR_MOBILE_DISPLAY_ADS" @@ -18489,7 +18488,7 @@ "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`.", + "description": "Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.", "enum": [ "PACING_PERIOD_UNSPECIFIED", "PACING_PERIOD_DAILY", @@ -18588,7 +18587,7 @@ "id": "ParentalStatusAssignedTargetingOptionDetails", "properties": { "parentalStatus": { - "description": "The parental status of the audience. Output only in v1. Required in v2.", + "description": "Required. The parental status of the audience.", "enum": [ "PARENTAL_STATUS_UNSPECIFIED", "PARENTAL_STATUS_PARENT", @@ -18882,7 +18881,7 @@ "type": "object" }, "PerformanceGoal": { - "description": "Settings that control the performance goal of a campaign or insertion order.", + "description": "Settings that control the performance goal of a campaign.", "id": "PerformanceGoal", "properties": { "performanceGoalAmountMicros": { @@ -20717,7 +20716,7 @@ "id": "VideoPlayerSizeAssignedTargetingOptionDetails", "properties": { "videoPlayerSize": { - "description": "The video player size. Output only in v1. Required in v2.", + "description": "Required. The video player size.", "enum": [ "VIDEO_PLAYER_SIZE_UNSPECIFIED", "VIDEO_PLAYER_SIZE_SMALL", @@ -20768,7 +20767,7 @@ "id": "ViewabilityAssignedTargetingOptionDetails", "properties": { "viewability": { - "description": "The predicted viewability percentage. Output only in v1. Required in v2.", + "description": "Required. The predicted viewability percentage.", "enum": [ "VIEWABILITY_UNSPECIFIED", "VIEWABILITY_10_PERCENT_OR_MORE", @@ -21020,7 +21019,7 @@ "type": "object" }, "YoutubeAdGroupAssignedTargetingOption": { - "description": "Wrapper object associating an assigned_targeting_option resource and the youtube ad group it is assigned to.", + "description": "Wrapper object associating an AssignedTargetingOption resource and the youtube ad group it is assigned to.", "id": "YoutubeAdGroupAssignedTargetingOption", "properties": { "assignedTargetingOption": { @@ -21040,7 +21039,7 @@ "id": "YoutubeAndPartnersBiddingStrategy", "properties": { "adGroupEffectiveTargetCpaSource": { - "description": "Output only. Source of the effective targetCpa value for AdGroup.", + "description": "Output only. Source of the effective target CPA value for ad group.", "enum": [ "BIDDING_SOURCE_UNSPECIFIED", "BIDDING_SOURCE_LINE_ITEM", @@ -21049,13 +21048,13 @@ "enumDescriptions": [ "Bidding source is not specified or unknown.", "Bidding value is inherited from the line item.", - "Bidding value is defined on the ad group." + "Bidding value is defined in the ad group." ], "readOnly": true, "type": "string" }, "adGroupEffectiveTargetCpaValue": { - "description": "Output only. The effective targetCpa for AdGroup, in micros of advertiser's currency.", + "description": "Output only. The effective target CPA for ad group, in micros of advertiser's currency.", "format": "int64", "readOnly": true, "type": "string" diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json new file mode 100644 index 0000000000..6a2dfb9c51 --- /dev/null +++ b/discovery/displayvideo-v3.json @@ -0,0 +1,21774 @@ +{ + "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:v3", + "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": "v3/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": "v3/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": "v3/advertisers", + "httpMethod": "POST", + "id": "displayvideo.advertisers.create", + "parameterOrder": [], + "parameters": {}, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}:editAssignedTargetingOptions", + "request": { + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditAdvertiserAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an advertiser.", + "flatPath": "v3/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": "v3/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": "v3/advertisers", + "httpMethod": "GET", + "id": "displayvideo.advertisers.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertisers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner that the fetched advertisers should all belong to. The system only supports listing advertisers for one partner at a time.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/advertisers/{advertisersId}:listAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.listAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType=\"TARGETING_TYPE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is '5000'. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}", + "request": { + "$ref": "Advertiser" + }, + "response": { + "$ref": "Advertiser" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "adGroupAds": { + "methods": { + "get": { + "description": "Gets an ad group ad.", + "flatPath": "v3/advertisers/{advertisersId}/adGroupAds/{adGroupAdsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroupAds.get", + "parameterOrder": [ + "advertiserId", + "adGroupAdId" + ], + "parameters": { + "adGroupAdId": { + "description": "Required. The ID of the ad group ad to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser this ad group ad belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}", + "response": { + "$ref": "AdGroupAd" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists ad group ads.", + "flatPath": "v3/advertisers/{advertisersId}/adGroupAds", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroupAds.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the ad groups belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId=\"1234\"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroupAds", + "response": { + "$ref": "ListAdGroupAdsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "adGroups": { + "methods": { + "bulkListAdGroupAssignedTargetingOptions": { + "description": "Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included.", + "flatPath": "v3/advertisers/{advertisersId}/adGroups:bulkListAdGroupAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.bulkListAdGroupAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "adGroupIds": { + "description": "Required. The IDs of the ad groups to list assigned targeting options for.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the line items belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType=\"TARGETING_TYPE_YOUTUBE_VIDEO\" OR targetingType=\"TARGETING_TYPE_YOUTUBE_CHANNEL\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions", + "response": { + "$ref": "BulkListAdGroupAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an ad group.", + "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.get", + "parameterOrder": [ + "advertiserId", + "adGroupId" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser this ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}", + "response": { + "$ref": "AdGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists ad groups.", + "flatPath": "v3/advertisers/{advertisersId}/adGroups", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the ad groups belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroups", + "response": { + "$ref": "ListAdGroupsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "get": { + "description": "Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included.", + "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}", + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included.", + "flatPath": "v3/advertisers/{advertisersId}/adGroups/{adGroupsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.adGroups.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "adGroupId", + "targetingType" + ], + "parameters": { + "adGroupId": { + "description": "Required. The ID of the ad group to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "advertiserId": { + "description": "Required. The ID of the advertiser the ad group belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "response": { + "$ref": "ListAdGroupAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + } + } + }, + "assets": { + "methods": { + "upload": { + "description": "Uploads an asset. Returns the ID of the newly uploaded asset if successful. The asset file size should be no more than 10 MB for images, 200 MB for ZIP files, and 1 GB for videos. Must be used within the [multipart media upload process](/display-video/api/guides/how-tos/upload#multipart). Examples using provided client libraries can be found in our [Creating Creatives guide](/display-video/api/guides/creating-creatives/overview#upload_an_asset).", + "flatPath": "v3/advertisers/{advertisersId}/assets", + "httpMethod": "POST", + "id": "displayvideo.advertisers.assets.upload", + "mediaUpload": { + "accept": [ + "*/*" + ], + "protocols": { + "simple": { + "multipart": true, + "path": "/upload/v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/campaigns", + "httpMethod": "GET", + "id": "displayvideo.advertisers.campaigns.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser to list campaigns for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCampaigns` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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 fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType=\"TARGETING_TYPE_LANGUAGE\" OR targetingType=\"TARGETING_TYPE_GENDER\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "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": "v3/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": "v3/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": "v3/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": "v3/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", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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 fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "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", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/channels", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the channels.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the channels.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.advertisers.channels.sites.list", + "parameterOrder": [ + "advertiserId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/creatives/{+creativeId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a creative.", + "flatPath": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/creatives", + "httpMethod": "GET", + "id": "displayvideo.advertisers.creatives.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list creatives for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width}x{height}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange}-{reviewStatus}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType=\"CREATIVE_TYPE_NATIVE\"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus=\"ENTITY_STATUS_ACTIVE\" AND (dimensions=\"300x400\" OR dimensions=\"50x100\")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic=\"true\" AND minDuration=\"5.2s\" AND (exchangeReviewStatus=\"EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED\" OR exchangeReviewStatus=\"EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED\")` * All video creatives that are associated with line item ID 1 or 2: `creativeType=\"CREATIVE_TYPE_VIDEO\" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `creativeId` (default) * `createTime` * `mediaDuration` * `dimensions` (sorts by width first, then by height) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `createTime desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCreatives` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/insertionOrders", + "httpMethod": "GET", + "id": "displayvideo.advertisers.insertionOrders.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list insertion orders for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * \"displayName\" (default) * \"entityStatus\" * \"updateTime\" The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInsertionOrders` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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 fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "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": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}", + "request": { + "$ref": "InsertionOrder" + }, + "response": { + "$ref": "InsertionOrder" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "create": { + "description": "Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`", + "flatPath": "v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create", + "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" + }, + "insertionOrderId": { + "description": "Required. The ID of the insertion order the assigned targeting option will belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/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 insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`", + "flatPath": "v3/advertisers/{advertisersId}/insertionOrders/{insertionOrdersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete", + "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. The ID of the assigned targeting option to delete.", + "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. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/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 insertion order.", + "flatPath": "v3/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. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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 fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "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. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/advertisers/{advertisersId}/invoices", + "httpMethod": "GET", + "id": "displayvideo.advertisers.invoices.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list invoices for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "issueMonth": { + "description": "The month to list the invoices for. If not set, the request will retrieve invoices for the previous month. Must be in the format YYYYMM.", + "location": "query", + "type": "string" + }, + "loiSapinInvoiceType": { + "description": "Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise.", + "enum": [ + "LOI_SAPIN_INVOICE_TYPE_UNSPECIFIED", + "LOI_SAPIN_INVOICE_TYPE_MEDIA", + "LOI_SAPIN_INVOICE_TYPE_PLATFORM" + ], + "enumDescriptions": [ + "Value is not specified.", + "Invoices with Media cost.", + "Invoices with Platform fee." + ], + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInvoices` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency", + "response": { + "$ref": "LookupInvoiceCurrencyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video", + "https://www.googleapis.com/auth/display-video-mediaplanning" + ] + } + } + }, + "lineItems": { + "methods": { + "bulkEditAssignedTargetingOptions": { + "description": "Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete", + "flatPath": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/lineItems:bulkListAssignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.bulkListAssignedTargetingOptions", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line items belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType=\"TARGETING_TYPE_PROXIMITY_LOCATION_LIST\" OR targetingType=\"TARGETING_TYPE_CHANNEL\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "lineItemIds": { + "description": "Required. The IDs of the line items to list assigned targeting options for.", + "format": "int64", + "location": "query", + "repeated": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `lineItemId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingType desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions", + "response": { + "$ref": "BulkListAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "bulkUpdate": { + "description": "Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete", + "flatPath": "v3/advertisers/{advertisersId}/lineItems:bulkUpdate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.bulkUpdate", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/lineItems:bulkUpdate", + "request": { + "$ref": "BulkUpdateLineItemsRequest" + }, + "response": { + "$ref": "BulkUpdateLineItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "create": { + "description": "Creates a new line item. Returns the newly created line item if successful.", + "flatPath": "v3/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": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "duplicate": { + "description": "Duplicates a line item. Returns the ID of the created line item if successful.", + "flatPath": "v3/advertisers/{advertisersId}/lineItems/{lineItemsId}:duplicate", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.duplicate", + "parameterOrder": [ + "advertiserId", + "lineItemId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser this line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item to duplicate.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate", + "request": { + "$ref": "DuplicateLineItemRequest" + }, + "response": { + "$ref": "DuplicateLineItemResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "generateDefault": { + "description": "Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type", + "flatPath": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/lineItems", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser to list line items for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId=\"1234\"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND lineItemType=\"LINE_ITEM_TYPE_DISPLAY_DEFAULT\"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<=\"2020-11-04T18:54:47Z\"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime>=\"2020-11-04T18:54:47Z\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` * `updateTime` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItems` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/lineItems", + "response": { + "$ref": "ListLineItemsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "patch": { + "description": "Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete", + "flatPath": "v3/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": "v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}", + "request": { + "$ref": "LineItem" + }, + "response": { + "$ref": "LineItem" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "targetingTypes": { + "resources": { + "assignedTargetingOptions": { + "methods": { + "create": { + "description": "Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption", + "flatPath": "v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.create", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option will belong to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions", + "request": { + "$ref": "AssignedTargetingOption" + }, + "response": { + "$ref": "AssignedTargetingOption" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption", + "flatPath": "v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.delete", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. The ID of the assigned targeting option to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item the assigned targeting option belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/advertisers/{advertisersId}/lineItems/{lineItemsId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.lineItems.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "lineItemId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser the line item belongs to.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId=\"1\" OR assignedTargetingOptionId=\"2\"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance=\"NOT_INHERITED\" OR inheritance=\"INHERITED_FROM_PARTNER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "lineItemId": { + "description": "Required. The ID of the line item to list assigned targeting options for.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLineItemAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items)", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/locationLists", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a location list.", + "flatPath": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/locationLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched location lists belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType=\"TARGETING_LOCATION_TYPE_REGIONAL\"` * All proximity location list: `locationType=\"TARGETING_LOCATION_TYPE_PROXIMITY\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `locationListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListLocationLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/advertisers/{+advertiserId}/locationLists/{locationListId}", + "request": { + "$ref": "LocationList" + }, + "response": { + "$ref": "LocationList" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "assignedLocations": { + "methods": { + "bulkEdit": { + "description": "Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations.", + "flatPath": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "httpMethod": "GET", + "id": "displayvideo.advertisers.locationLists.assignedLocations.list", + "parameterOrder": [ + "advertiserId", + "locationListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the location list belongs.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "locationListId": { + "description": "Required. The ID of the location list to which these assignments are assigned.", + "format": "int64", + "location": "path", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedLocationId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedLocationId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedLocations` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations", + "response": { + "$ref": "ListAssignedLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "negativeKeywordLists": { + "methods": { + "create": { + "description": "Creates a new negative keyword list. Returns the newly created negative keyword list if successful.", + "flatPath": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/negativeKeywordLists", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.list", + "parameterOrder": [ + "advertiserId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywordLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/advertisers/{advertisersId}/negativeKeywordLists/{negativeKeywordListsId}/negativeKeywords", + "httpMethod": "GET", + "id": "displayvideo.advertisers.negativeKeywordLists.negativeKeywords.list", + "parameterOrder": [ + "advertiserId", + "negativeKeywordListId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains \"google\": `keywordValue : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "negativeKeywordListId": { + "description": "Required. The ID of the parent negative keyword list to which the requested negative keywords belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `keywordValue` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `keywordValue desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `1000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListNegativeKeywords` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/advertisers/{advertisersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.advertisers.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "advertiserId", + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The ID of the advertiser.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdvertiserAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_YOUTUBE_VIDEO` * `TARGETING_TYPE_YOUTUBE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/combinedAudiences", + "httpMethod": "GET", + "id": "displayvideo.combinedAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched combined audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains \"Google\": `displayName : \"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `combinedAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCombinedAudiences` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched combined audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/customBiddingAlgorithms", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.create", + "parameterOrder": [], + "parameters": {}, + "path": "v3/customBiddingAlgorithms", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a custom bidding algorithm.", + "flatPath": "v3/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": "v3/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": "v3/customBiddingAlgorithms", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 advertiser that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains \"politics\": `displayName:\"politics\"`. * All custom bidding algorithms for which the type is \"SCRIPT_BASED\": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithms` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the DV360 partner that has access to the custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}", + "request": { + "$ref": "CustomBiddingAlgorithm" + }, + "response": { + "$ref": "CustomBiddingAlgorithm" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "uploadRules": { + "description": "Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource.", + "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}:uploadRules", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.uploadRules", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules", + "response": { + "$ref": "CustomBiddingAlgorithmRulesRef" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "uploadScript": { + "description": "Creates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.", + "flatPath": "v3/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": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript", + "response": { + "$ref": "CustomBiddingScriptRef" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + }, + "resources": { + "rules": { + "methods": { + "create": { + "description": "Creates a new rules resource. Returns the newly created rules resource if successful.", + "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", + "httpMethod": "POST", + "id": "displayvideo.customBiddingAlgorithms.rules.create", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", + "request": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "response": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Retrieves a rules resource.", + "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules/{rulesId}", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.rules.get", + "parameterOrder": [ + "customBiddingAlgorithmId", + "customBiddingAlgorithmRulesId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "customBiddingAlgorithmRulesId": { + "description": "Required. The ID of the rules resource to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}", + "response": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "list": { + "description": "Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter.", + "flatPath": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/rules", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.rules.list", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm that owns the rules resource.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules", + "response": { + "$ref": "ListCustomBiddingAlgorithmRulesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + }, + "scripts": { + "methods": { + "create": { + "description": "Creates a new custom bidding script. Returns the newly created script if successful.", + "flatPath": "v3/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": "v3/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": "v3/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": "v3/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": "v3/customBiddingAlgorithms/{customBiddingAlgorithmsId}/scripts", + "httpMethod": "GET", + "id": "displayvideo.customBiddingAlgorithms.scripts.list", + "parameterOrder": [ + "customBiddingAlgorithmId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent custom bidding algorithm.", + "format": "int64", + "location": "query", + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Required. The ID of the custom bidding algorithm owns the script.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `createTime desc` (default) The default sorting order is descending. To specify ascending order for a field, the suffix \"desc\" should be removed. Example: `createTime`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingScripts` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this custom bidding script.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts", + "response": { + "$ref": "ListCustomBiddingScriptsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "customLists": { + "methods": { + "get": { + "description": "Gets a custom list.", + "flatPath": "v3/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": "v3/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": "v3/customLists", + "httpMethod": "GET", + "id": "displayvideo.customLists.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the DV360 advertiser that has access to the fetched custom lists.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `customListId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomLists` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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 can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "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 `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/googleAudiences", + "httpMethod": "GET", + "id": "displayvideo.googleAudiences.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the fetched Google audiences.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains \"Google\": `displayName:\"Google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `googleAudienceId` (default) * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGoogleAudiences` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the fetched Google audiences.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors", + "request": { + "$ref": "EditGuaranteedOrderReadAccessorsRequest" + }, + "response": { + "$ref": "EditGuaranteedOrderReadAccessorsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a guaranteed order.", + "flatPath": "v3/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": "v3/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": "v3/guaranteedOrders", + "httpMethod": "GET", + "id": "displayvideo.guaranteedOrders.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListGuaranteedOrders` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the guaranteed order.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/inventorySourceGroups", + "request": { + "$ref": "InventorySourceGroup" + }, + "response": { + "$ref": "InventorySourceGroup" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "delete": { + "description": "Deletes an inventory source group.", + "flatPath": "v3/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": "v3/inventorySourceGroups/{+inventorySourceGroupId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source group.", + "flatPath": "v3/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": "v3/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": "v3/inventorySourceGroups", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the inventory source group. If an inventory source group is partner-owned, only advertisers to which the group is explicitly shared can access the group.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `inventorySourceGroupId` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/inventorySourceGroups/{inventorySourceGroupsId}/assignedInventorySources", + "httpMethod": "GET", + "id": "displayvideo.inventorySourceGroups.assignedInventorySources.list", + "parameterOrder": [ + "inventorySourceGroupId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the assignment. If the parent inventory source group is partner-owned, only advertisers to which the parent group is explicitly shared can access the assigned inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Required. The ID of the inventory source group to which these assignments are assigned.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedInventorySourceId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `assignedInventorySourceId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAssignedInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the assignment. If the parent inventory source group is advertiser-owned, the assignment cannot be accessed via a partner.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors", + "request": { + "$ref": "EditInventorySourceReadWriteAccessorsRequest" + }, + "response": { + "$ref": "InventorySourceAccessors" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets an inventory source.", + "flatPath": "v3/inventorySources/{inventorySourcesId}", + "httpMethod": "GET", + "id": "displayvideo.inventorySources.get", + "parameterOrder": [ + "inventorySourceId" + ], + "parameters": { + "advertiserId": { + "description": "Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser.", + "format": "int64", + "location": "query", + "type": "string" + }, + "inventorySourceId": { + "description": "Required. The ID of the inventory source to fetch.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the DV360 partner to which the fetched inventory source is permissioned.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/inventorySources", + "httpMethod": "GET", + "id": "displayvideo.inventorySources.list", + "parameterOrder": [], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that has access to the inventory source.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus=\"ENTITY_STATUS_ACTIVE\"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange=\"EXCHANGE_GOOGLE_AD_MANAGER\" OR exchange=\"EXCHANGE_RUBICON\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListInventorySources` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that has access to the inventory source.", + "format": "int64", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/partners/{+partnerId}:editAssignedTargetingOptions", + "request": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsRequest" + }, + "response": { + "$ref": "BulkEditPartnerAssignedTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + }, + "get": { + "description": "Gets a partner.", + "flatPath": "v3/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": "v3/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": "v3/partners", + "httpMethod": "GET", + "id": "displayvideo.partners.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus=\"ENTITY_STATUS_ACTIVE\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartners` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/partners/{partnersId}/channels", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.list", + "parameterOrder": [ + "partnerId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the channels.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains \"google\": `displayName : \"google\"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) * `channelId` The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListChannels` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the channels.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/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": "v3/partners/{partnersId}/channels/{channelsId}/sites", + "httpMethod": "GET", + "id": "displayvideo.partners.channels.sites.list", + "parameterOrder": [ + "partnerId", + "channelId" + ], + "parameters": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "location": "query", + "type": "string" + }, + "channelId": { + "description": "Required. The ID of the parent channel to which the requested sites belong.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "filter": { + "description": "Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains \"google\": `urlOrAppId : \"google\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `urlOrAppId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \" desc\" should be added to the field name. Example: `urlOrAppId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `10000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListSites` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/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": "v3/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": "v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "POST", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.create", + "parameterOrder": [ + "partnerId", + "targetingType" + ], + "parameters": { + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "DELETE", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.delete", + "parameterOrder": [ + "partnerId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "assignedTargetingOptionId": { + "description": "Required. The ID of the assigned targeting option to delete.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions/{assignedTargetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.get", + "parameterOrder": [ + "partnerId", + "targetingType", + "assignedTargetingOptionId" + ], + "parameters": { + "assignedTargetingOptionId": { + "description": "Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/partners/{partnersId}/targetingTypes/{targetingTypesId}/assignedTargetingOptions", + "httpMethod": "GET", + "id": "displayvideo.partners.targetingTypes.assignedTargetingOptions.list", + "parameterOrder": [ + "partnerId", + "targetingType" + ], + "parameters": { + "filter": { + "description": "Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId=\"123456\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `assignedTargetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListPartnerAssignedTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "partnerId": { + "description": "Required. The ID of the partner.", + "format": "int64", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/sdfdownloadtasks", + "httpMethod": "POST", + "id": "displayvideo.sdfdownloadtasks.create", + "parameterOrder": [], + "parameters": {}, + "path": "v3/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": "v3/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": "v3/{+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": "v3/targetingTypes/{targetingTypesId}/targetingOptions/{targetingOptionsId}", + "httpMethod": "GET", + "id": "displayvideo.targetingTypes.targetingOptions.get", + "parameterOrder": [ + "targetingType", + "targetingOptionId" + ], + "parameters": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "location": "query", + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The ID of the of targeting option to retrieve.", + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + }, + "targetingType": { + "description": "Required. The type of targeting option to retrieve. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/targetingTypes/{targetingTypesId}/targetingOptions", + "httpMethod": "GET", + "id": "displayvideo.targetingTypes.targetingOptions.list", + "parameterOrder": [ + "targetingType" + ], + "parameters": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "location": "query", + "type": "string" + }, + "filter": { + "description": "Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_COUNTRY\" OR geoRegionDetails.geoRegionType=\"GEO_REGION_TYPE_STATE\"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type=\"CARRIER_AND_ISP_TYPE_CARRIER\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `targetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `targetingOptionId desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListTargetingOptions` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + }, + "targetingType": { + "description": "Required. The type of targeting option to be listed. Accepted values are: * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/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": "v3/targetingTypes/{targetingTypesId}/targetingOptions:search", + "httpMethod": "POST", + "id": "displayvideo.targetingTypes.targetingOptions.search", + "parameterOrder": [ + "targetingType" + ], + "parameters": { + "targetingType": { + "description": "Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN`", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "location": "path", + "pattern": "^[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v3/targetingTypes/{+targetingType}/targetingOptions:search", + "request": { + "$ref": "SearchTargetingOptionsRequest" + }, + "response": { + "$ref": "SearchTargetingOptionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video" + ] + } + } + } + } + }, + "users": { + "methods": { + "bulkEditAssignedUserRoles": { + "description": "Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/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": "v3/users/{+userId}:bulkEditAssignedUserRoles", + "request": { + "$ref": "BulkEditAssignedUserRolesRequest" + }, + "response": { + "$ref": "BulkEditAssignedUserRolesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "create": { + "description": "Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/users", + "httpMethod": "POST", + "id": "displayvideo.users.create", + "parameterOrder": [], + "parameters": {}, + "path": "v3/users", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "delete": { + "description": "Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/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": "v3/users/{+userId}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "get": { + "description": "Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/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": "v3/users/{+userId}", + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "list": { + "description": "Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/users", + "httpMethod": "GET", + "id": "displayvideo.users.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field} {operator} {value}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Field by which to sort the list. Acceptable values are: * `displayName` (default) The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. For example, `displayName desc`.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListUsers` method. If not specified, the first page of results will be returned.", + "location": "query", + "type": "string" + } + }, + "path": "v3/users", + "response": { + "$ref": "ListUsersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + }, + "patch": { + "description": "Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The \"Try this method\" feature does not work for this method.", + "flatPath": "v3/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": "v3/users/{+userId}", + "request": { + "$ref": "User" + }, + "response": { + "$ref": "User" + }, + "scopes": [ + "https://www.googleapis.com/auth/display-video-user-management" + ] + } + } + } + }, + "revision": "20231009", + "rootUrl": "https://displayvideo.googleapis.com/", + "schemas": { + "ActiveViewVideoViewabilityMetricConfig": { + "description": "Configuration for custom Active View video viewability metrics.", + "id": "ActiveViewVideoViewabilityMetricConfig", + "properties": { + "displayName": { + "description": "Required. The display name of the custom metric.", + "type": "string" + }, + "minimumDuration": { + "description": "The minimum visible video duration required (in seconds) in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "enum": [ + "VIDEO_DURATION_UNSPECIFIED", + "VIDEO_DURATION_SECONDS_NONE", + "VIDEO_DURATION_SECONDS_0", + "VIDEO_DURATION_SECONDS_1", + "VIDEO_DURATION_SECONDS_2", + "VIDEO_DURATION_SECONDS_3", + "VIDEO_DURATION_SECONDS_4", + "VIDEO_DURATION_SECONDS_5", + "VIDEO_DURATION_SECONDS_6", + "VIDEO_DURATION_SECONDS_7", + "VIDEO_DURATION_SECONDS_8", + "VIDEO_DURATION_SECONDS_9", + "VIDEO_DURATION_SECONDS_10", + "VIDEO_DURATION_SECONDS_11", + "VIDEO_DURATION_SECONDS_12", + "VIDEO_DURATION_SECONDS_13", + "VIDEO_DURATION_SECONDS_14", + "VIDEO_DURATION_SECONDS_15", + "VIDEO_DURATION_SECONDS_30", + "VIDEO_DURATION_SECONDS_45", + "VIDEO_DURATION_SECONDS_60" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "No duration value.", + "0 seconds.", + "1 second.", + "2 seconds.", + "3 seconds.", + "4 seconds.", + "5 seconds.", + "6 seconds.", + "7 seconds.", + "8 seconds.", + "9 seconds.", + "10 seconds.", + "11 seconds.", + "12 seconds.", + "13 seconds.", + "14 seconds.", + "15 seconds.", + "30 seconds.", + "45 seconds.", + "60 seconds." + ], + "type": "string" + }, + "minimumQuartile": { + "description": "The minimum visible video duration required, based on the video quartiles, in order for an impression to be recorded. You must specify minimum_duration, minimum_quartile or both. If both are specified, an impression meets the metric criteria if either requirement is met (whichever happens first).", + "enum": [ + "VIDEO_DURATION_QUARTILE_UNSPECIFIED", + "VIDEO_DURATION_QUARTILE_NONE", + "VIDEO_DURATION_QUARTILE_FIRST", + "VIDEO_DURATION_QUARTILE_SECOND", + "VIDEO_DURATION_QUARTILE_THIRD", + "VIDEO_DURATION_QUARTILE_FOURTH" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "No quartile value.", + "First quartile.", + "Second quartile (midpoint).", + "Third quartile.", + "Fourth quartile (completion)." + ], + "type": "string" + }, + "minimumViewability": { + "description": "Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded.", + "enum": [ + "VIEWABILITY_PERCENT_UNSPECIFIED", + "VIEWABILITY_PERCENT_0", + "VIEWABILITY_PERCENT_25", + "VIEWABILITY_PERCENT_50", + "VIEWABILITY_PERCENT_75", + "VIEWABILITY_PERCENT_100" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% viewable.", + "25% viewable.", + "50% viewable.", + "75% viewable.", + "100% viewable." + ], + "type": "string" + }, + "minimumVolume": { + "description": "Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded.", + "enum": [ + "VIDEO_VOLUME_PERCENT_UNSPECIFIED", + "VIDEO_VOLUME_PERCENT_0", + "VIDEO_VOLUME_PERCENT_10" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "0% volume.", + "10% volume." + ], + "type": "string" + } + }, + "type": "object" + }, + "AdGroup": { + "description": "A single ad group associated with a line item.", + "id": "AdGroup", + "properties": { + "adGroupFormat": { + "description": "The format of the ads in the ad group.", + "enum": [ + "AD_GROUP_FORMAT_UNSPECIFIED", + "AD_GROUP_FORMAT_IN_STREAM", + "AD_GROUP_FORMAT_VIDEO_DISCOVERY", + "AD_GROUP_FORMAT_BUMPER", + "AD_GROUP_FORMAT_NON_SKIPPABLE_IN_STREAM", + "AD_GROUP_FORMAT_AUDIO", + "AD_GROUP_FORMAT_ACTION", + "AD_GROUP_FORMAT_REACH", + "AD_GROUP_FORMAT_MASTHEAD" + ], + "enumDescriptions": [ + "Format value is not specified or is unknown in this version.", + "In-stream ads.", + "In-feed ads.", + "Bumper ads.", + "Non-skippable in-stream ads.", + "Non-skippable in-stream audio ads.", + "[Responsive ads for video action campaigns] (https://support.google.com/displayvideo/answer/9065351).", + "[Effective reach ad groups] (https://support.google.com/displayvideo/answer/9173684), including in-stream and bumper ads.", + "Masthead Ad that is surfaced on the top slot on the YouTube homepage." + ], + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy." + }, + "displayName": { + "description": "The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "lineItemId": { + "description": "The unique ID of the line item that the ad group belongs to.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "The resource name of the ad group.", + "type": "string" + }, + "productFeedData": { + "$ref": "ProductFeedData", + "description": "The settings of the product feed in this ad group." + }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group." + } + }, + "type": "object" + }, + "AdGroupAd": { + "description": "A single ad associated with an ad group.", + "id": "AdGroupAd", + "properties": { + "adGroupAdId": { + "description": "The unique ID of the ad. Assigned by the system.", + "format": "int64", + "type": "string" + }, + "adGroupId": { + "description": "The unique ID of the ad group that the ad belongs to.", + "format": "int64", + "type": "string" + }, + "adUrls": { + "description": "List of URLs used by the ad.", + "items": { + "$ref": "AdUrl" + }, + "type": "array" + }, + "advertiserId": { + "description": "The unique ID of the advertiser the ad belongs to.", + "format": "int64", + "type": "string" + }, + "audioAd": { + "$ref": "AudioAd", + "description": "Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives." + }, + "bumperAd": { + "$ref": "BumperAd", + "description": "Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach." + }, + "displayName": { + "description": "The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "displayVideoSourceAd": { + "$ref": "DisplayVideoSourceAd", + "description": "Details of an ad sourced from a Display & Video 360 creative." + }, + "entityStatus": { + "description": "The entity status of the ad.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "inStreamAd": { + "$ref": "InStreamAd", + "description": "Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives." + }, + "mastheadAd": { + "$ref": "MastheadAd", + "description": "Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826)." + }, + "name": { + "description": "The resource name of the ad.", + "type": "string" + }, + "nonSkippableAd": { + "$ref": "NonSkippableAd", + "description": "Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives." + }, + "videoDiscoverAd": { + "$ref": "VideoDiscoveryAd", + "description": "Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery." + }, + "videoPerformanceAd": { + "$ref": "VideoPerformanceAd", + "description": "Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product." + } + }, + "type": "object" + }, + "AdGroupAssignedTargetingOption": { + "description": "Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to.", + "id": "AdGroupAssignedTargetingOption", + "properties": { + "adGroupId": { + "description": "The ID of the ad group the assigned targeting option is assigned to.", + "format": "int64", + "type": "string" + }, + "assignedTargetingOption": { + "$ref": "AssignedTargetingOption", + "description": "The assigned targeting option resource." + } + }, + "type": "object" + }, + "AdUrl": { + "description": "Additional URLs related to the ad, including beacons.", + "id": "AdUrl", + "properties": { + "type": { + "description": "The type of the Ad URL.", + "enum": [ + "AD_URL_TYPE_UNSPECIFIED", + "AD_URL_TYPE_BEACON_IMPRESSION", + "AD_URL_TYPE_BEACON_EXPANDABLE_DCM_IMPRESSION", + "AD_URL_TYPE_BEACON_CLICK", + "AD_URL_TYPE_BEACON_SKIP" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "A 1x1 tracking pixel to ping when an impression of a creative is delivered.", + "Expandable DCM impression beacon. At serving time, it is expanded to several beacons.", + "Tracking URL to ping when the click event is triggered.", + "Tracking URL to ping when the skip event is triggered." + ], + "type": "string" + }, + "url": { + "description": "The URL string value.", + "type": "string" + } + }, + "type": "object" + }, + "Adloox": { + "description": "Details of Adloox 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" + }, + "billingConfig": { + "$ref": "AdvertiserBillingConfig", + "description": "Required. Billing related settings of the advertiser." + }, + "creativeConfig": { + "$ref": "AdvertiserCreativeConfig", + "description": "Required. Creative related settings of the advertiser." + }, + "dataAccessConfig": { + "$ref": "AdvertiserDataAccessConfig", + "description": "Settings that control how advertiser data may be accessed." + }, + "displayName": { + "description": "Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not insertion orders and line items of the advertiser can spend their budgets and bid on inventory. * Accepted values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_PAUSED` and `ENTITY_STATUS_SCHEDULED_FOR_DELETION`. * If set to `ENTITY_STATUS_SCHEDULED_FOR_DELETION`, the advertiser will be deleted 30 days from when it was first scheduled for deletion.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "generalConfig": { + "$ref": "AdvertiserGeneralConfig", + "description": "Required. General settings of the advertiser." + }, + "integrationDetails": { + "$ref": "IntegrationDetails", + "description": "Integration details of the advertiser. Only integrationCode is currently applicable to advertiser. Other fields of IntegrationDetails are not supported and will be ignored if provided." + }, + "name": { + "description": "Output only. The resource name of the advertiser.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Required. Immutable. The unique ID of the partner that the advertiser belongs to.", + "format": "int64", + "type": "string" + }, + "prismaEnabled": { + "description": "Whether integration with Mediaocean (Prisma) is enabled. By enabling this, you agree to the following: On behalf of my company, I authorize Mediaocean (Prisma) to send budget segment plans to Google, and I authorize Google to send corresponding reporting and invoices from DV360 to Mediaocean for the purposes of budget planning, billing, and reconciliation for this advertiser.", + "type": "boolean" + }, + "servingConfig": { + "$ref": "AdvertiserTargetingConfig", + "description": "Targeting settings related to ad serving of the advertiser." + }, + "updateTime": { + "description": "Output only. The timestamp when the advertiser was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserAdServerConfig": { + "description": "Ad server related settings of an advertiser.", + "id": "AdvertiserAdServerConfig", + "properties": { + "cmHybridConfig": { + "$ref": "CmHybridConfig", + "description": "The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers." + }, + "thirdPartyOnlyConfig": { + "$ref": "ThirdPartyOnlyConfig", + "description": "The configuration for advertisers that use third-party ad servers only." + } + }, + "type": "object" + }, + "AdvertiserBillingConfig": { + "description": "Billing related settings of an advertiser.", + "id": "AdvertiserBillingConfig", + "properties": { + "billingProfileId": { + "description": "The ID of a billing profile assigned to the advertiser.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AdvertiserCreativeConfig": { + "description": "Creatives related settings of an advertiser.", + "id": "AdvertiserCreativeConfig", + "properties": { + "dynamicCreativeEnabled": { + "description": "Whether or not the advertiser is enabled for dynamic creatives.", + "type": "boolean" + }, + "iasClientId": { + "description": "An ID for configuring campaign monitoring provided by Integral Ad Service (IAS). The DV360 system will append an IAS \"Campaign Monitor\" tag containing this ID to the creative tag.", + "format": "int64", + "type": "string" + }, + "obaComplianceDisabled": { + "description": "Whether or not to 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": "Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.", + "enum": [ + "AGE_RANGE_UNSPECIFIED", + "AGE_RANGE_18_24", + "AGE_RANGE_25_34", + "AGE_RANGE_35_44", + "AGE_RANGE_45_54", + "AGE_RANGE_55_64", + "AGE_RANGE_65_PLUS", + "AGE_RANGE_UNKNOWN", + "AGE_RANGE_18_20", + "AGE_RANGE_21_24", + "AGE_RANGE_25_29", + "AGE_RANGE_30_34", + "AGE_RANGE_35_39", + "AGE_RANGE_40_44", + "AGE_RANGE_45_49", + "AGE_RANGE_50_54", + "AGE_RANGE_55_59", + "AGE_RANGE_60_64" + ], + "enumDescriptions": [ + "Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", + "The age range of the audience is 18 to 24.", + "The age range of the audience is 25 to 34.", + "The age range of the audience is 35 to 44.", + "The age range of the audience is 45 to 54.", + "The age range of the audience is 55 to 64.", + "The age range of the audience is 65 and up.", + "The age range of the audience is unknown.", + "The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." + ], + "type": "string" + } + }, + "type": "object" + }, + "AgeRangeTargetingOptionDetails": { + "description": "Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`.", + "id": "AgeRangeTargetingOptionDetails", + "properties": { + "ageRange": { + "description": "Output only. The age range of an audience.", + "enum": [ + "AGE_RANGE_UNSPECIFIED", + "AGE_RANGE_18_24", + "AGE_RANGE_25_34", + "AGE_RANGE_35_44", + "AGE_RANGE_45_54", + "AGE_RANGE_55_64", + "AGE_RANGE_65_PLUS", + "AGE_RANGE_UNKNOWN", + "AGE_RANGE_18_20", + "AGE_RANGE_21_24", + "AGE_RANGE_25_29", + "AGE_RANGE_30_34", + "AGE_RANGE_35_39", + "AGE_RANGE_40_44", + "AGE_RANGE_45_49", + "AGE_RANGE_50_54", + "AGE_RANGE_55_59", + "AGE_RANGE_60_64" + ], + "enumDescriptions": [ + "Default value when age range is not specified in this version. This enum is a placeholder for default value and does not represent a real age range option.", + "The age range of the audience is 18 to 24.", + "The age range of the audience is 25 to 34.", + "The age range of the audience is 35 to 44.", + "The age range of the audience is 45 to 54.", + "The age range of the audience is 55 to 64.", + "The age range of the audience is 65 and up.", + "The age range of the audience is unknown.", + "The age range of the audience is 18 to 20, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 21 to 24, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 25 to 29, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 30 to 34, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 35 to 39, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 40 to 44, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 45 to 49, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 50 to 54, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 55 to 59, only supported for the AdGroup of YouTube Programmatic Reservation line item.", + "The age range of the audience is 60 to 64, only supported for the AdGroup of YouTube Programmatic Reservation line item." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRules": { + "description": "Rule-based algorithm.", + "id": "AlgorithmRules", + "properties": { + "impressionSignalRuleset": { + "$ref": "AlgorithmRulesRuleset", + "description": "Rules for the impression signals." + } + }, + "type": "object" + }, + "AlgorithmRulesComparisonValue": { + "description": "A value to compare the signal to.", + "id": "AlgorithmRulesComparisonValue", + "properties": { + "boolValue": { + "description": "Boolean value.", + "type": "boolean" + }, + "creativeDimensionValue": { + "$ref": "Dimensions", + "description": "Creative dimension value." + }, + "dayAndTimeValue": { + "$ref": "DayAndTime", + "description": "Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported." + }, + "deviceTypeValue": { + "description": "Device type value.", + "enum": [ + "RULE_DEVICE_TYPE_UNSPECIFIED", + "RULE_DEVICE_TYPE_COMPUTER", + "RULE_DEVICE_TYPE_CONNECTED_TV", + "RULE_DEVICE_TYPE_SMART_PHONE", + "RULE_DEVICE_TYPE_TABLET", + "RULE_DEVICE_TYPE_CONNECTED_DEVICE", + "RULE_DEVICE_TYPE_SET_TOP_BOX" + ], + "enumDescriptions": [ + "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet.", + "Connected device.", + "Set top box." + ], + "type": "string" + }, + "doubleValue": { + "description": "Double value.", + "format": "double", + "type": "number" + }, + "environmentValue": { + "description": "Environment value.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "type": "string" + }, + "exchangeValue": { + "description": "Exchange value.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + }, + "int64Value": { + "description": "Integer value.", + "format": "int64", + "type": "string" + }, + "onScreenPositionValue": { + "description": "Ad position value.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "type": "string" + }, + "stringValue": { + "description": "String value.", + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRulesRule": { + "description": "Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met.", + "id": "AlgorithmRulesRule", + "properties": { + "conditions": { + "description": "List of conditions in this rule. The criteria among conditions should be mutually exclusive.", + "items": { + "$ref": "AlgorithmRulesRuleCondition" + }, + "type": "array" + }, + "defaultReturnValue": { + "$ref": "AlgorithmRulesSignalValue", + "description": "The default return value applied when none of the conditions are met." + } + }, + "type": "object" + }, + "AlgorithmRulesRuleCondition": { + "description": "Set of signal comparisons. Equivalent of an `if` statement.", + "id": "AlgorithmRulesRuleCondition", + "properties": { + "returnValue": { + "$ref": "AlgorithmRulesSignalValue", + "description": "The value returned if the `signalComparisons` condition evaluates to `TRUE`." + }, + "signalComparisons": { + "description": "List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators.", + "items": { + "$ref": "AlgorithmRulesSignalComparison" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlgorithmRulesRuleset": { + "description": "A ruleset consisting of a list of rules and how to aggregate the resulting values.", + "id": "AlgorithmRulesRuleset", + "properties": { + "aggregationType": { + "description": "How to aggregate values of evaluated rules.", + "enum": [ + "RULE_AGGREGATION_TYPE_UNSPECIFIED", + "SUM_OF_VALUES", + "PRODUCT_OF_VALUES", + "MAXIMUM_VALUE" + ], + "enumDescriptions": [ + "Unknown aggregation type.", + "The sum of rule values.", + "The product of rule values.", + "The maximum rule value." + ], + "type": "string" + }, + "maxValue": { + "description": "Maximum value the ruleset can evaluate to.", + "format": "double", + "type": "number" + }, + "rules": { + "description": "List of rules to generate the impression value.", + "items": { + "$ref": "AlgorithmRulesRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlgorithmRulesSignal": { + "description": "Signal used to evaluate rules.", + "id": "AlgorithmRulesSignal", + "properties": { + "impressionSignal": { + "description": "Signal based on impressions.", + "enum": [ + "IMPRESSION_SIGNAL_UNSPECIFIED", + "DAY_AND_TIME", + "DEVICE_TYPE", + "AD_POSITION", + "OPERATING_SYSTEM_ID", + "MOBILE_MODEL_ID", + "EXCHANGE_ID", + "ENVIRONMENT", + "COUNTRY_ID", + "CITY_ID", + "BROWSER_ID", + "CREATIVE_DIMENSION" + ], + "enumDescriptions": [ + "Unknown signal.", + "The day of the week and hour of day the impression was made using browser's local time zone. Value is stored in the dayAndTimeValue field of the comparison value.", + "Device type. Value is stored in the deviceTypeValue field of the comparison value.", + "Ad position. Value is stored in the onScreenPositionValue field of the comparison value.", + "The operating system identifier. Value is stored in the int64Value field of the comparison value.", + "The mobile model identifier. Value is stored in the int64Value field of the comparison value.", + "The exchange identifier. Value is stored in the int64Value field of the comparison value.", + "Serving environment. Value is stored in the environmentValue field of the comparison value.", + "The country or region identifier. Value is stored in the int64Value field of the comparison value.", + "The city identifier. Value is stored in the int64Value field of the comparison value.", + "The browser identifier. Value is stored in the int64Value field of the comparison value.", + "Creative height and width in pixels. Value is stored in the creativeDimensionValue field of the comparison value." + ], + "type": "string" + } + }, + "type": "object" + }, + "AlgorithmRulesSignalComparison": { + "description": "A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123.", + "id": "AlgorithmRulesSignalComparison", + "properties": { + "comparisonOperator": { + "description": "Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second.", + "enum": [ + "COMPARISON_OPERATOR_UNSPECIFIED", + "EQUAL", + "GREATER_THAN", + "LESS_THAN", + "GREATER_THAN_OR_EQUAL_TO", + "LESS_THAN_OR_EQUAL_TO" + ], + "enumDescriptions": [ + "Unknown operator.", + "Values are equal.", + "First value is greater than the comparison value.", + "First value is less than the second.", + "First value is greater than or equal to the second.", + "First value is less or equals to the comparison value." + ], + "type": "string" + }, + "comparisonValue": { + "$ref": "AlgorithmRulesComparisonValue", + "description": "Value to compare signal to." + }, + "signal": { + "$ref": "AlgorithmRulesSignal", + "description": "Signal to compare." + } + }, + "type": "object" + }, + "AlgorithmRulesSignalValue": { + "description": "Adjusted value of the signal used for rule evaluation.", + "id": "AlgorithmRulesSignalValue", + "properties": { + "number": { + "description": "Value to use as result.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "AppAssignedTargetingOptionDetails": { + "description": "Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`.", + "id": "AppAssignedTargetingOptionDetails", + "properties": { + "appId": { + "description": "Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.", + "type": "string" + }, + "appPlatform": { + "description": "Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.", + "enum": [ + "APP_PLATFORM_UNSPECIFIED", + "APP_PLATFORM_IOS", + "APP_PLATFORM_ANDROID", + "APP_PLATFORM_ROKU", + "APP_PLATFORM_AMAZON_FIRETV", + "APP_PLATFORM_PLAYSTATION", + "APP_PLATFORM_APPLE_TV", + "APP_PLATFORM_XBOX", + "APP_PLATFORM_SAMSUNG_TV", + "APP_PLATFORM_ANDROID_TV", + "APP_PLATFORM_GENERIC_CTV" + ], + "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. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "AssetAssociation": { + "description": "Asset association for the creative.", + "id": "AssetAssociation", + "properties": { + "asset": { + "$ref": "Asset", + "description": "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_VIDEO`", + "Long headline of a native creative. The content must be UTF-8 encoded with a length of no more than 50 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Body text of a native creative. The content must be UTF-8 encoded with a length of no more than 90 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "Long body text of a native creative. The content must be UTF-8 encoded with a length of no more than 150 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "A short, friendly version of the landing page URL to show in the creative. This URL gives people an idea of where they'll arrive after they click on the creative. The content must be UTF-8 encoded with a length of no more than 30 characters. For example, if the landing page URL is 'http://www.example.com/page', the caption URL can be 'example.com'. The protocol (http://) is optional, but the URL can't contain spaces or special characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text to use on the call-to-action button of a native creative. The content must be UTF-8 encoded with a length of no more than 15 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The text that identifies the advertiser or brand name. The content must be UTF-8 encoded with a length of no more than 25 characters. This role is only supported in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "The purchase price of your app in the Google play store or iOS app store (for example, $5.99). Note that this value is not automatically synced with the actual value listed in the store. It will always be the one provided when save the creative. The content must be UTF-8 encoded with a length of no more than 15 characters. Assets of this role are read-only.", + "The ID of an Android app in the Google play store. You can find this ID in the App’s Google Play Store URL after ‘id’. For example, in https://play.google.com/store/apps/details?id=com.company.appname the identifier is com.company.appname. Assets of this role are read-only.", + "The ID of an iOS app in the Apple app store. This ID number can be found in the Apple App Store URL as the string of numbers directly after \"id\". For example, in https://apps.apple.com/us/app/gmail-email-by-google/id422689480 the ID is 422689480. Assets of this role are read-only.", + "The rating of an app in the Google play store or iOS app store. Note that this value is not automatically synced with the actual rating in the store. It will always be the one provided when save the creative. Assets of this role are read-only.", + "The icon of a creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE`", + "The cover image of a native video creative. This role is only supported and required in following creative_type: * `CREATIVE_TYPE_VIDEO`" + ], + "type": "string" + } + }, + "type": "object" + }, + "AssignedInventorySource": { + "description": "An assignment between a targetable inventory source and an inventory source group.", + "id": "AssignedInventorySource", + "properties": { + "assignedInventorySourceId": { + "description": "Output only. The unique ID of the assigned inventory source. The ID is only unique within a given inventory source group. It may be reused in other contexts.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "inventorySourceId": { + "description": "Required. The ID of the inventory source entity being targeted.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned inventory source.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AssignedLocation": { + "description": "An assignment between a location list and a relevant targeting option.", + "id": "AssignedLocation", + "properties": { + "assignedLocationId": { + "description": "Output only. The unique ID of the assigned location. The ID is only unique within a location list. It may be reused in other contexts.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the assigned location.", + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The ID of the targeting option assigned to the location list.", + "type": "string" + } + }, + "type": "object" + }, + "AssignedTargetingOption": { + "description": "A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.", + "id": "AssignedTargetingOption", + "properties": { + "ageRangeDetails": { + "$ref": "AgeRangeAssignedTargetingOptionDetails", + "description": "Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`." + }, + "appCategoryDetails": { + "$ref": "AppCategoryAssignedTargetingOptionDetails", + "description": "App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`." + }, + "appDetails": { + "$ref": "AppAssignedTargetingOptionDetails", + "description": "App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`." + }, + "assignedTargetingOptionId": { + "description": "Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.", + "readOnly": true, + "type": "string" + }, + "assignedTargetingOptionIdAlias": { + "description": "Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`", + "readOnly": true, + "type": "string" + }, + "audienceGroupDetails": { + "$ref": "AudienceGroupAssignedTargetingOptionDetails", + "description": "Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource." + }, + "audioContentTypeDetails": { + "$ref": "AudioContentTypeAssignedTargetingOptionDetails", + "description": "Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`." + }, + "authorizedSellerStatusDetails": { + "$ref": "AuthorizedSellerStatusAssignedTargetingOptionDetails", + "description": "Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default." + }, + "browserDetails": { + "$ref": "BrowserAssignedTargetingOptionDetails", + "description": "Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`." + }, + "businessChainDetails": { + "$ref": "BusinessChainAssignedTargetingOptionDetails", + "description": "Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." + }, + "carrierAndIspDetails": { + "$ref": "CarrierAndIspAssignedTargetingOptionDetails", + "description": "Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`." + }, + "categoryDetails": { + "$ref": "CategoryAssignedTargetingOptionDetails", + "description": "Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence." + }, + "channelDetails": { + "$ref": "ChannelAssignedTargetingOptionDetails", + "description": "Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`." + }, + "contentDurationDetails": { + "$ref": "ContentDurationAssignedTargetingOptionDetails", + "description": "Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`." + }, + "contentGenreDetails": { + "$ref": "ContentGenreAssignedTargetingOptionDetails", + "description": "Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`." + }, + "contentInstreamPositionDetails": { + "$ref": "ContentInstreamPositionAssignedTargetingOptionDetails", + "description": "Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`." + }, + "contentOutstreamPositionDetails": { + "$ref": "ContentOutstreamPositionAssignedTargetingOptionDetails", + "description": "Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`." + }, + "contentStreamTypeDetails": { + "$ref": "ContentStreamTypeAssignedTargetingOptionDetails", + "description": "Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`." + }, + "dayAndTimeDetails": { + "$ref": "DayAndTimeAssignedTargetingOptionDetails", + "description": "Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`." + }, + "deviceMakeModelDetails": { + "$ref": "DeviceMakeModelAssignedTargetingOptionDetails", + "description": "Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`." + }, + "deviceTypeDetails": { + "$ref": "DeviceTypeAssignedTargetingOptionDetails", + "description": "Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`." + }, + "digitalContentLabelExclusionDetails": { + "$ref": "DigitalContentLabelAssignedTargetingOptionDetails", + "description": "Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded." + }, + "environmentDetails": { + "$ref": "EnvironmentAssignedTargetingOptionDetails", + "description": "Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`." + }, + "exchangeDetails": { + "$ref": "ExchangeAssignedTargetingOptionDetails", + "description": "Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`." + }, + "genderDetails": { + "$ref": "GenderAssignedTargetingOptionDetails", + "description": "Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`." + }, + "geoRegionDetails": { + "$ref": "GeoRegionAssignedTargetingOptionDetails", + "description": "Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`." + }, + "householdIncomeDetails": { + "$ref": "HouseholdIncomeAssignedTargetingOptionDetails", + "description": "Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`." + }, + "inheritance": { + "description": "Output only. The inheritance status of the assigned targeting option.", + "enum": [ + "INHERITANCE_UNSPECIFIED", + "NOT_INHERITED", + "INHERITED_FROM_PARTNER", + "INHERITED_FROM_ADVERTISER" + ], + "enumDescriptions": [ + "The inheritance is unspecified or unknown.", + "The assigned targeting option is not inherited from higher level entity.", + "The assigned targeting option is inherited from partner targeting settings.", + "The assigned targeting option is inherited from advertiser targeting settings." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceDetails": { + "$ref": "InventorySourceAssignedTargetingOptionDetails", + "description": "Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`." + }, + "inventorySourceGroupDetails": { + "$ref": "InventorySourceGroupAssignedTargetingOptionDetails", + "description": "Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`." + }, + "keywordDetails": { + "$ref": "KeywordAssignedTargetingOptionDetails", + "description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned." + }, + "languageDetails": { + "$ref": "LanguageAssignedTargetingOptionDetails", + "description": "Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`." + }, + "name": { + "description": "Output only. The resource name for this assigned targeting option.", + "readOnly": true, + "type": "string" + }, + "nativeContentPositionDetails": { + "$ref": "NativeContentPositionAssignedTargetingOptionDetails", + "description": "Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`." + }, + "negativeKeywordListDetails": { + "$ref": "NegativeKeywordListAssignedTargetingOptionDetails", + "description": "Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource." + }, + "omidDetails": { + "$ref": "OmidAssignedTargetingOptionDetails", + "description": "Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`." + }, + "onScreenPositionDetails": { + "$ref": "OnScreenPositionAssignedTargetingOptionDetails", + "description": "On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`." + }, + "operatingSystemDetails": { + "$ref": "OperatingSystemAssignedTargetingOptionDetails", + "description": "Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`." + }, + "parentalStatusDetails": { + "$ref": "ParentalStatusAssignedTargetingOptionDetails", + "description": "Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`." + }, + "poiDetails": { + "$ref": "PoiAssignedTargetingOptionDetails", + "description": "POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`." + }, + "proximityLocationListDetails": { + "$ref": "ProximityLocationListAssignedTargetingOptionDetails", + "description": "Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`." + }, + "regionalLocationListDetails": { + "$ref": "RegionalLocationListAssignedTargetingOptionDetails", + "description": "Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`." + }, + "sensitiveCategoryExclusionDetails": { + "$ref": "SensitiveCategoryAssignedTargetingOptionDetails", + "description": "Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them." + }, + "sessionPositionDetails": { + "$ref": "SessionPositionAssignedTargetingOptionDetails", + "description": "Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`." + }, + "subExchangeDetails": { + "$ref": "SubExchangeAssignedTargetingOptionDetails", + "description": "Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`." + }, + "targetingType": { + "description": "Output only. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "readOnly": true, + "type": "string" + }, + "thirdPartyVerifierDetails": { + "$ref": "ThirdPartyVerifierAssignedTargetingOptionDetails", + "description": "Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`." + }, + "urlDetails": { + "$ref": "UrlAssignedTargetingOptionDetails", + "description": "URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`." + }, + "userRewardedContentDetails": { + "$ref": "UserRewardedContentAssignedTargetingOptionDetails", + "description": "User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`." + }, + "videoPlayerSizeDetails": { + "$ref": "VideoPlayerSizeAssignedTargetingOptionDetails", + "description": "Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`." + }, + "viewabilityDetails": { + "$ref": "ViewabilityAssignedTargetingOptionDetails", + "description": "Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource." + }, + "youtubeChannelDetails": { + "$ref": "YoutubeChannelAssignedTargetingOptionDetails", + "description": "YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`." + }, + "youtubeVideoDetails": { + "$ref": "YoutubeVideoAssignedTargetingOptionDetails", + "description": "YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`." + } + }, + "type": "object" + }, + "AssignedUserRole": { + "description": "A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser.", + "id": "AssignedUserRole", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that the assigend user role applies to.", + "format": "int64", + "type": "string" + }, + "assignedUserRoleId": { + "description": "Output only. The ID of the assigned user role.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "The ID of the partner that the assigned user role applies to.", + "format": "int64", + "type": "string" + }, + "userRole": { + "description": "Required. The user role to assign to a user for the entity.", + "enum": [ + "USER_ROLE_UNSPECIFIED", + "ADMIN", + "ADMIN_PARTNER_CLIENT", + "STANDARD", + "STANDARD_PLANNER", + "STANDARD_PLANNER_LIMITED", + "STANDARD_PARTNER_CLIENT", + "READ_ONLY", + "REPORTING_ONLY", + "LIMITED_REPORTING_ONLY", + "CREATIVE", + "CREATIVE_ADMIN" + ], + "enumDescriptions": [ + "Default value when the user role is not specified or is unknown in this version.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can view and edit billing information, create or modify users, and enable or disable exchanges. This role can only be assigned for a partner entity.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They can create and modify other `ADMIN_PARTNER_CLIENT` users and view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for a partner entity.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create and modify users or view billing information.", + "The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity, including all cost data. They can create and modify planning-related features, including plans and inventory.", + "The user can view all campaigns, creatives, insertion orders, line items, and reports for the entity. They can create or modify planning-related features, including plans and inventory. They have no access to cost data and cannot start, accept, or negotiate deals.", + "The user can manage campaigns, creatives, insertion orders, line items, and reports for the entity. They cannot create or modify other users or view billing information. They cannot view revenue models, markups, or any other reseller-sensitive fields. This role can only be assigned for an advertiser entity.", + "The user can only build reports and view data for the entity.", + "The user can only create and manage reports.", + "The user can only create and manage the following client-safe reports: General, Audience Performance, Cross-Partner, Keyword, Order ID, Category, and Third-Party Data Provider.", + "The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace.", + "The user can view media plan information they need to collaborate, but can't view cost-related data or Marketplace. In addition, they can add other creative admins or creative users to the entity." + ], + "type": "string" + } + }, + "type": "object" + }, + "AudienceGroupAssignedTargetingOptionDetails": { + "description": "Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups.", + "id": "AudienceGroupAssignedTargetingOptionDetails", + "properties": { + "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 ‘OR’ 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 ‘OR’ 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" + }, + "AudioAd": { + "description": "Details for an audio ad.", + "id": "AudioAd", + "properties": { + "displayUrl": { + "description": "The webpage address that appears with the ad.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video of the ad." + } + }, + "type": "object" + }, + "AudioContentTypeAssignedTargetingOptionDetails": { + "description": "Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect.", + "id": "AudioContentTypeAssignedTargetingOptionDetails", + "properties": { + "audioContentType": { + "description": "Required. The audio content type.", + "enum": [ + "AUDIO_CONTENT_TYPE_UNSPECIFIED", + "AUDIO_CONTENT_TYPE_UNKNOWN", + "AUDIO_CONTENT_TYPE_MUSIC", + "AUDIO_CONTENT_TYPE_BROADCAST", + "AUDIO_CONTENT_TYPE_PODCAST" + ], + "enumDescriptions": [ + "Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The audio content type is unknown.", + "The audio content type is music.", + "The audio content type is broadcast.", + "The audio content type is podcast." + ], + "type": "string" + } + }, + "type": "object" + }, + "AudioContentTypeTargetingOptionDetails": { + "description": "Represents a targetable audio content type. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.", + "id": "AudioContentTypeTargetingOptionDetails", + "properties": { + "audioContentType": { + "description": "Output only. The audio content type.", + "enum": [ + "AUDIO_CONTENT_TYPE_UNSPECIFIED", + "AUDIO_CONTENT_TYPE_UNKNOWN", + "AUDIO_CONTENT_TYPE_MUSIC", + "AUDIO_CONTENT_TYPE_BROADCAST", + "AUDIO_CONTENT_TYPE_PODCAST" + ], + "enumDescriptions": [ + "Audio content type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The audio content type is unknown.", + "The audio content type is music.", + "The audio content type is broadcast.", + "The audio content type is podcast." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "AudioVideoOffset": { + "description": "The length an audio or a video has been played.", + "id": "AudioVideoOffset", + "properties": { + "percentage": { + "description": "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`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the \"Authorized Direct Sellers and Resellers\" option.", + "id": "AuthorizedSellerStatusAssignedTargetingOptionDetails", + "properties": { + "authorizedSellerStatus": { + "description": "Output only. The authorized seller status to target.", + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" + ], + "enumDescriptions": [ + "Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", + "type": "string" + } + }, + "type": "object" + }, + "AuthorizedSellerStatusTargetingOptionDetails": { + "description": "Represents a targetable authorized seller status. This will be populated in the authorized_seller_status_details field when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.", + "id": "AuthorizedSellerStatusTargetingOptionDetails", + "properties": { + "authorizedSellerStatus": { + "description": "Output only. The authorized seller status.", + "enum": [ + "AUTHORIZED_SELLER_STATUS_UNSPECIFIED", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_DIRECT_SELLERS_ONLY", + "AUTHORIZED_SELLER_STATUS_AUTHORIZED_AND_NON_PARTICIPATING_PUBLISHERS" + ], + "enumDescriptions": [ + "Default value when authorized seller status is not specified in this version. This enum is a placeholder for the default value, or \"Authorized Direct Sellers and Resellers\" in the UI.", + "Only authorized sellers that directly own the inventory being monetized, as indicated by a DIRECT declaration in the ads.txt file. This value is equivalent to \"Authorized Direct Sellers\" in the UI.", + "All authorized sellers, including publishers that have not posted an ads.txt file. Display & Video 360 automatically disallows unauthorized sellers. This value is equivalent to \"Authorized and Non-Participating Publishers\" in the UI." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BiddingStrategy": { + "description": "Settings that control the bid strategy. Bid strategy determines the bid price.", + "id": "BiddingStrategy", + "properties": { + "fixedBid": { + "$ref": "FixedBidStrategy", + "description": "A strategy that uses a fixed bid price." + }, + "maximizeSpendAutoBid": { + "$ref": "MaximizeSpendBidStrategy", + "description": "A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, when performance_goal_type is one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` , the line_item_type of the insertion order line items must be either: * `LINE_ITEM_TYPE_DISPLAY_DEFAULT` * `LINE_ITEM_TYPE_VIDEO_DEFAULT` , and when performance_goal_type is either: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` the line_item_type of the insertion order line items must be `LINE_ITEM_TYPE_VIDEO_DEFAULT`." + }, + "performanceGoalAutoBid": { + "$ref": "PerformanceGoalBidStrategy", + "description": "A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity." + }, + "youtubeAndPartnersBid": { + "$ref": "YoutubeAndPartnersBiddingStrategy", + "description": "A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity." + } + }, + "type": "object" + }, + "BrowserAssignedTargetingOptionDetails": { + "description": "Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`.", + "id": "BrowserAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the browser.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.", + "type": "string" + } + }, + "type": "object" + }, + "BrowserTargetingOptionDetails": { + "description": "Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`.", + "id": "BrowserTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the browser.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "BudgetSummary": { + "description": "Summarized information of an individual campaign budget.", + "id": "BudgetSummary", + "properties": { + "externalBudgetId": { + "description": "Corresponds to the external_budget_id of a campaign budget. If the value is not set in the campaign budget, this field will be empty.", + "type": "string" + }, + "preTaxAmountMicros": { + "description": "The sum of charges made under this budget before taxes, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "prismaCpeCode": { + "$ref": "PrismaCpeCode", + "description": "Relevant client, product, and estimate codes from the Mediaocean Prisma tool. Only applicable for campaign budgets with an external_budget_source of EXTERNAL_BUDGET_SOURCE_MEDIA_OCEAN." + }, + "taxAmountMicros": { + "description": "The amount of tax applied to charges under this budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The total sum of charges made under this budget, including tax, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditAdvertiserAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditAdvertiserAssignedTargetingOptions.", + "id": "BulkEditAdvertiserAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`", + "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 AssignedLocation resources.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "deletedAssignedLocations": { + "description": "The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedLocationsResponse": { + "id": "BulkEditAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditLineItemsAssignedTargetingOptions.", + "id": "BulkEditAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY`", + "items": { + "$ref": "DeleteAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "lineItemIds": { + "description": "Required. The ID of the line items whose targeting is being updated.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedTargetingOptionsResponse": { + "id": "BulkEditAssignedTargetingOptionsResponse", + "properties": { + "errors": { + "description": "The error information for each line item that failed to update.", + "items": { + "$ref": "Status" + }, + "type": "array" + }, + "failedLineItemIds": { + "description": "Output only. The IDs of the line items which failed.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "updatedLineItemIds": { + "description": "Output only. The IDs of the line items which successfully updated.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedUserRolesRequest": { + "description": "Request message for BulkEditAssignedUserRoles.", + "id": "BulkEditAssignedUserRolesRequest", + "properties": { + "createdAssignedUserRoles": { + "description": "The assigned user roles to create in batch, specified as a list of AssignedUserRoles.", + "items": { + "$ref": "AssignedUserRole" + }, + "type": "array" + }, + "deletedAssignedUserRoles": { + "description": "The assigned user roles to delete in batch, specified as a list of assigned_user_role_ids. The format of assigned_user_role_id is `entityType-entityid`, for example `partner-123`.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditAssignedUserRolesResponse": { + "id": "BulkEditAssignedUserRolesResponse", + "properties": { + "createdAssignedUserRoles": { + "description": "The list of assigned user roles that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedUserRole" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditNegativeKeywordsRequest": { + "description": "Request message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsRequest", + "properties": { + "createdNegativeKeywords": { + "description": "The negative keywords to create in batch, specified as a list of NegativeKeywords.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "deletedNegativeKeywords": { + "description": "The negative keywords to delete in batch, specified as a list of keyword_values.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.BulkEditNegativeKeywords.", + "id": "BulkEditNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditPartnerAssignedTargetingOptionsRequest": { + "description": "Request message for BulkEditPartnerAssignedTargetingOptions.", + "id": "BulkEditPartnerAssignedTargetingOptionsRequest", + "properties": { + "createRequests": { + "description": "The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "items": { + "$ref": "CreateAssignedTargetingOptionsRequest" + }, + "type": "array" + }, + "deleteRequests": { + "description": "The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL`", + "items": { + "$ref": "DeleteAssignedTargetingOptionsRequest" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditPartnerAssignedTargetingOptionsResponse": { + "id": "BulkEditPartnerAssignedTargetingOptionsResponse", + "properties": { + "createdAssignedTargetingOptions": { + "description": "The list of assigned targeting options that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkEditSitesRequest": { + "description": "Request message for SiteService.BulkEditSites.", + "id": "BulkEditSitesRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser that owns the parent channel.", + "format": "int64", + "type": "string" + }, + "createdSites": { + "description": "The sites to create in batch, specified as a list of Sites.", + "items": { + "$ref": "Site" + }, + "type": "array" + }, + "deletedSites": { + "description": "The sites to delete in batch, specified as a list of site url_or_app_ids.", + "items": { + "type": "string" + }, + "type": "array" + }, + "partnerId": { + "description": "The ID of the partner that owns the parent channel.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "BulkEditSitesResponse": { + "description": "Response message for SiteService.BulkEditSites.", + "id": "BulkEditSitesResponse", + "properties": { + "sites": { + "description": "The list of sites that have been successfully created. This list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "BulkListAdGroupAssignedTargetingOptionsResponse": { + "id": "BulkListAdGroupAssignedTargetingOptionsResponse", + "properties": { + "adGroupAssignedTargetingOptions": { + "description": "The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty.", + "items": { + "$ref": "AdGroupAssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkListAdvertiserAssignedTargetingOptionsResponse": { + "id": "BulkListAdvertiserAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkListAssignedTargetingOptionsResponse": { + "id": "BulkListAssignedTargetingOptionsResponse", + "properties": { + "lineItemAssignedTargetingOptions": { + "description": "The list of wrapper objects, each providing an assigned targeting option and the line item it is assigned to. This list will be absent if empty.", + "items": { + "$ref": "LineItemAssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more line_item_assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "BulkListCampaignAssignedTargetingOptionsResponse": { + "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": { + "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" + }, + "BumperAd": { + "description": "Details for a bumper ad.", + "id": "BumperAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + } + }, + "type": "object" + }, + "BusinessChainAssignedTargetingOptionDetails": { + "description": "Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", + "id": "BusinessChainAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of a business chain, e.g. \"KFC\", \"Chase Bank\".", + "readOnly": true, + "type": "string" + }, + "proximityRadiusAmount": { + "description": "Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.", + "format": "double", + "type": "number" + }, + "proximityRadiusUnit": { + "description": "Required. The unit of distance by which the targeting radius is measured.", + "enum": [ + "DISTANCE_UNIT_UNSPECIFIED", + "DISTANCE_UNIT_MILES", + "DISTANCE_UNIT_KILOMETERS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Miles.", + "Kilometers." + ], + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.", + "type": "string" + } + }, + "type": "object" + }, + "BusinessChainSearchTerms": { + "description": "Search terms for Business Chain targeting options. At least one of the field should be populated.", + "id": "BusinessChainSearchTerms", + "properties": { + "businessChainQuery": { + "description": "The search query for the desired business chain. The query must be the full name of the business, e.g. \"KFC\", \"mercedes-benz\".", + "type": "string" + }, + "regionQuery": { + "description": "The search query for the desired geo region, e.g. \"Seattle\", \"United State\".", + "type": "string" + } + }, + "type": "object" + }, + "BusinessChainTargetingOptionDetails": { + "description": "Represents a targetable business chain within a geo region. This will be populated in the business_chain_details field when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.", + "id": "BusinessChainTargetingOptionDetails", + "properties": { + "businessChain": { + "description": "Output only. The display name of the business chain, e.g. \"KFC\", \"Chase Bank\".", + "readOnly": true, + "type": "string" + }, + "geoRegion": { + "description": "Output only. The display name of the geographic region, e.g. \"Ontario, Canada\".", + "readOnly": true, + "type": "string" + }, + "geoRegionType": { + "description": "Output only. The type of the geographic region.", + "enum": [ + "GEO_REGION_TYPE_UNKNOWN", + "GEO_REGION_TYPE_OTHER", + "GEO_REGION_TYPE_COUNTRY", + "GEO_REGION_TYPE_REGION", + "GEO_REGION_TYPE_TERRITORY", + "GEO_REGION_TYPE_PROVINCE", + "GEO_REGION_TYPE_STATE", + "GEO_REGION_TYPE_PREFECTURE", + "GEO_REGION_TYPE_GOVERNORATE", + "GEO_REGION_TYPE_CANTON", + "GEO_REGION_TYPE_UNION_TERRITORY", + "GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", + "GEO_REGION_TYPE_DMA_REGION", + "GEO_REGION_TYPE_METRO", + "GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", + "GEO_REGION_TYPE_COUNTY", + "GEO_REGION_TYPE_MUNICIPALITY", + "GEO_REGION_TYPE_CITY", + "GEO_REGION_TYPE_POSTAL_CODE", + "GEO_REGION_TYPE_DEPARTMENT", + "GEO_REGION_TYPE_AIRPORT", + "GEO_REGION_TYPE_TV_REGION", + "GEO_REGION_TYPE_OKRUG", + "GEO_REGION_TYPE_BOROUGH", + "GEO_REGION_TYPE_CITY_REGION", + "GEO_REGION_TYPE_ARRONDISSEMENT", + "GEO_REGION_TYPE_NEIGHBORHOOD", + "GEO_REGION_TYPE_UNIVERSITY", + "GEO_REGION_TYPE_DISTRICT" + ], + "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 ‘OR’ 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" + }, + "CommonInStreamAttribute": { + "description": "Common attributes for in-stream, non-skippable and bumper ads.", + "id": "CommonInStreamAttribute", + "properties": { + "actionButtonLabel": { + "description": "The text on the call-to-action button.", + "type": "string" + }, + "actionHeadline": { + "description": "The headline of the call-to-action banner.", + "type": "string" + }, + "companionBanner": { + "$ref": "ImageAsset", + "description": "The image which shows next to the video ad." + }, + "displayUrl": { + "description": "The webpage address that appears with the ad.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video of the ad." + } + }, + "type": "object" + }, + "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": "Required. The content instream position for video or audio ads.", + "enum": [ + "CONTENT_INSTREAM_POSITION_UNSPECIFIED", + "CONTENT_INSTREAM_POSITION_PRE_ROLL", + "CONTENT_INSTREAM_POSITION_MID_ROLL", + "CONTENT_INSTREAM_POSITION_POST_ROLL", + "CONTENT_INSTREAM_POSITION_UNKNOWN" + ], + "enumDescriptions": [ + "Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", + "Ads that play before streaming content.", + "Ads that play between the beginning and end of streaming content.", + "Ads that play at the end of streaming content.", + "Ads instream position is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContentInstreamPositionTargetingOptionDetails": { + "description": "Represents a targetable content instream position, which could be used by video and audio ads. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.", + "id": "ContentInstreamPositionTargetingOptionDetails", + "properties": { + "contentInstreamPosition": { + "description": "Output only. The content instream position.", + "enum": [ + "CONTENT_INSTREAM_POSITION_UNSPECIFIED", + "CONTENT_INSTREAM_POSITION_PRE_ROLL", + "CONTENT_INSTREAM_POSITION_MID_ROLL", + "CONTENT_INSTREAM_POSITION_POST_ROLL", + "CONTENT_INSTREAM_POSITION_UNKNOWN" + ], + "enumDescriptions": [ + "Content instream position is not specified in this version. This enum is a place holder for a default value and does not represent a real in stream ad position.", + "Ads that play before streaming content.", + "Ads that play between the beginning and end of streaming content.", + "Ads that play at the end of streaming content.", + "Ads instream position is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentOutstreamPositionAssignedTargetingOptionDetails": { + "description": "Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", + "id": "ContentOutstreamPositionAssignedTargetingOptionDetails", + "properties": { + "adType": { + "description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", + "enum": [ + "AD_TYPE_UNSPECIFIED", + "AD_TYPE_DISPLAY", + "AD_TYPE_VIDEO", + "AD_TYPE_AUDIO" + ], + "enumDescriptions": [ + "Ad type is not specified or is unknown in this version.", + "Display creatives, e.g. image and HTML5.", + "Video creatives, e.g. video ads that play during streaming content in video players.", + "Audio creatives, e.g. audio ads that play during audio content." + ], + "readOnly": true, + "type": "string" + }, + "contentOutstreamPosition": { + "description": "Required. The content outstream position.", + "enum": [ + "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", + "CONTENT_OUTSTREAM_POSITION_UNKNOWN", + "CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", + "CONTENT_OUTSTREAM_POSITION_IN_BANNER", + "CONTENT_OUTSTREAM_POSITION_IN_FEED", + "CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" + ], + "enumDescriptions": [ + "Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", + "The ad position is unknown in the content outstream.", + "Ads that appear between the paragraphs of your pages.", + "Ads that display on the top and the sides of a page.", + "Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Ads shown before or between content loads." + ], + "type": "string" + } + }, + "type": "object" + }, + "ContentOutstreamPositionTargetingOptionDetails": { + "description": "Represents a targetable content outstream position, which could be used by display and video ads. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.", + "id": "ContentOutstreamPositionTargetingOptionDetails", + "properties": { + "contentOutstreamPosition": { + "description": "Output only. The content outstream position.", + "enum": [ + "CONTENT_OUTSTREAM_POSITION_UNSPECIFIED", + "CONTENT_OUTSTREAM_POSITION_UNKNOWN", + "CONTENT_OUTSTREAM_POSITION_IN_ARTICLE", + "CONTENT_OUTSTREAM_POSITION_IN_BANNER", + "CONTENT_OUTSTREAM_POSITION_IN_FEED", + "CONTENT_OUTSTREAM_POSITION_INTERSTITIAL" + ], + "enumDescriptions": [ + "Content outstream position is not specified in this version. This enum is a place holder for a default value and does not represent a real content outstream position.", + "The ad position is unknown in the content outstream.", + "Ads that appear between the paragraphs of your pages.", + "Ads that display on the top and the sides of a page.", + "Ads that appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Ads shown before or between content loads." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ContentStreamTypeAssignedTargetingOptionDetails": { + "description": "Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect.", + "id": "ContentStreamTypeAssignedTargetingOptionDetails", + "properties": { + "contentStreamType": { + "description": "Output only. The content stream type.", + "enum": [ + "CONTENT_STREAM_TYPE_UNSPECIFIED", + "CONTENT_LIVE_STREAM", + "CONTENT_ON_DEMAND" + ], + "enumDescriptions": [ + "Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The content is being live-streamed.", + "The content is viewed on-demand." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", + "type": "string" + } + }, + "type": "object" + }, + "ContentStreamTypeTargetingOptionDetails": { + "description": "Represents a targetable content stream type. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.", + "id": "ContentStreamTypeTargetingOptionDetails", + "properties": { + "contentStreamType": { + "description": "Output only. The content stream type.", + "enum": [ + "CONTENT_STREAM_TYPE_UNSPECIFIED", + "CONTENT_LIVE_STREAM", + "CONTENT_ON_DEMAND" + ], + "enumDescriptions": [ + "Content stream type is not specified in this version. This enum is a place holder for a default value and does not represent a real content stream type.", + "The content is being live-streamed.", + "The content is viewed on-demand." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ConversionCountingConfig": { + "description": "Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting.", + "id": "ConversionCountingConfig", + "properties": { + "floodlightActivityConfigs": { + "description": "The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field.", + "items": { + "$ref": "TrackingFloodlightActivityConfig" + }, + "type": "array" + }, + "postViewCountPercentageMillis": { + "description": "The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "CounterEvent": { + "description": "Counter event of the creative.", + "id": "CounterEvent", + "properties": { + "name": { + "description": "Required. The name of the counter event.", + "type": "string" + }, + "reportingName": { + "description": "Required. The name used to identify this counter event in reports.", + "type": "string" + } + }, + "type": "object" + }, + "CreateAssetRequest": { + "description": "A request message for CreateAsset.", + "id": "CreateAssetRequest", + "properties": { + "filename": { + "description": "Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "CreateAssetResponse": { + "description": "A response message for CreateAsset.", + "id": "CreateAssetResponse", + "properties": { + "asset": { + "$ref": "Asset", + "description": "The uploaded asset, if successful." + } + }, + "type": "object" + }, + "CreateAssignedTargetingOptionsRequest": { + "description": "A request listing which assigned targeting options of a given targeting type should be created and added.", + "id": "CreateAssignedTargetingOptionsRequest", + "properties": { + "assignedTargetingOptions": { + "description": "Required. The assigned targeting options to create and add.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "type": "string" + } + }, + "type": "object" + }, + "CreateSdfDownloadTaskRequest": { + "description": "Request message for [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "CreateSdfDownloadTaskRequest", + "properties": { + "advertiserId": { + "description": "The ID of the advertiser to download SDF for.", + "format": "int64", + "type": "string" + }, + "idFilter": { + "$ref": "IdFilter", + "description": "Filters on entities by their entity IDs." + }, + "inventorySourceFilter": { + "$ref": "InventorySourceFilter", + "description": "Filters on Inventory Sources by their IDs." + }, + "parentEntityFilter": { + "$ref": "ParentEntityFilter", + "description": "Filters on selected file types. The entities in each file are filtered by a chosen set of filter entities. The filter entities must be the same type as, or a parent type of, the selected file types." + }, + "partnerId": { + "description": "The ID of the partner to download SDF for.", + "format": "int64", + "type": "string" + }, + "version": { + "description": "Required. The SDF version of the downloaded file. If set to `SDF_VERSION_UNSPECIFIED`, this will default to the version specified by the advertiser or partner identified by `root_id`. An advertiser inherits its SDF version from its partner unless configured otherwise.", + "enum": [ + "SDF_VERSION_UNSPECIFIED", + "SDF_VERSION_3_1", + "SDF_VERSION_4", + "SDF_VERSION_4_1", + "SDF_VERSION_4_2", + "SDF_VERSION_5", + "SDF_VERSION_5_1", + "SDF_VERSION_5_2", + "SDF_VERSION_5_3", + "SDF_VERSION_5_4", + "SDF_VERSION_5_5", + "SDF_VERSION_6" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6" + ], + "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_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0.", + "items": { + "$ref": "Dimensions" + }, + "type": "array" + }, + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the creative belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "appendedTag": { + "description": "Third-party HTML tracking tag to be appended to the creative tag.", + "type": "string" + }, + "assets": { + "description": "Required. Assets associated to this creative.", + "items": { + "$ref": "AssetAssociation" + }, + "type": "array" + }, + "cmPlacementId": { + "description": "Output only. The unique ID of the Campaign Manager 360 placement associated with the creative. This field is only applicable for creatives that are synced from Campaign Manager.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "cmTrackingAd": { + "$ref": "CmTrackingAd", + "description": "The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases." + }, + "companionCreativeIds": { + "description": "The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO`", + "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 **not** supported for this creative type.", + "Square native app install creative. Create and update methods are **not** supported for this creative type.", + "Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", + "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type." + ], + "type": "string" + }, + "dimensions": { + "$ref": "Dimensions", + "description": "Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO`" + }, + "displayName": { + "description": "Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "dynamic": { + "description": "Output only. Indicates whether the creative is dynamic.", + "readOnly": true, + "type": "boolean" + }, + "entityStatus": { + "description": "Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED`", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "exitEvents": { + "description": "Required. Exit events for this creative. An exit (also known as a click tag) is any area in your creative that someone can click or tap to open an advertiser's landing page. Every creative must include at least one exit. You can add an exit to your creative in any of the following ways: * Use Google Web Designer's tap area. * Define a JavaScript variable called \"clickTag\". * Use the Enabler (Enabler.exit()) to track exits in rich media formats.", + "items": { + "$ref": "ExitEvent" + }, + "type": "array" + }, + "expandOnHover": { + "description": "Optional. Indicates the creative will automatically expand on hover. Optional and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", + "type": "boolean" + }, + "expandingDirection": { + "description": "Optional. Specifies the expanding direction of the creative. Required and only valid for third-party expandable creatives. Third-party expandable creatives are creatives with following hosting source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_EXPANDABLE`", + "enum": [ + "EXPANDING_DIRECTION_UNSPECIFIED", + "EXPANDING_DIRECTION_NONE", + "EXPANDING_DIRECTION_UP", + "EXPANDING_DIRECTION_DOWN", + "EXPANDING_DIRECTION_LEFT", + "EXPANDING_DIRECTION_RIGHT", + "EXPANDING_DIRECTION_UP_AND_LEFT", + "EXPANDING_DIRECTION_UP_AND_RIGHT", + "EXPANDING_DIRECTION_DOWN_AND_LEFT", + "EXPANDING_DIRECTION_DOWN_AND_RIGHT", + "EXPANDING_DIRECTION_UP_OR_DOWN", + "EXPANDING_DIRECTION_LEFT_OR_RIGHT", + "EXPANDING_DIRECTION_ANY_DIAGONAL" + ], + "enumDescriptions": [ + "The expanding direction is not specified.", + "Does not expand in any direction.", + "Expands up.", + "Expands down.", + "Expands left.", + "Expands right.", + "Expands up and to the left side.", + "Expands up and to the right side.", + "Expands down and to the left side.", + "Expands down and to the right side.", + "Expands either up or down.", + "Expands to either the left or the right side.", + "Can expand in any diagonal direction." + ], + "type": "string" + }, + "hostingSource": { + "description": "Required. Indicates where the creative is hosted.", + "enum": [ + "HOSTING_SOURCE_UNSPECIFIED", + "HOSTING_SOURCE_CM", + "HOSTING_SOURCE_THIRD_PARTY", + "HOSTING_SOURCE_HOSTED", + "HOSTING_SOURCE_RICH_MEDIA" + ], + "enumDescriptions": [ + "Hosting source is not specified or is unknown in this version.", + "A creative synced from Campaign Manager 360. Create and update methods are **not** supported for this hosting type.", + "A creative hosted by a third-party ad server (3PAS). Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A creative created in DV360 and hosted by Campaign Manager 360. Create and update methods are supported for this hosting type if the creative_type is one of the following: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO`", + "A rich media creative created in Studio and hosted by Campaign Manager 360. Create and update methods are **not** supported for this hosting type." + ], + "type": "string" + }, + "html5Video": { + "description": "Output only. Indicates the third-party VAST tag creative requires HTML5 Video support. Output only and only valid for third-party VAST tag creatives. Third-party VAST tag creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_VIDEO`", + "readOnly": true, + "type": "boolean" + }, + "iasCampaignMonitoring": { + "description": "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 writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "type": "string" + }, + "lineItemIds": { + "description": "Output only. The IDs of the line items this creative is associated with. To associate a creative to a line item, use LineItem.creative_ids instead.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "mediaDuration": { + "description": "Output only. Media duration of the creative. Applicable when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_PUBLISHER_HOSTED`", + "format": "google-duration", + "readOnly": true, + "type": "string" + }, + "mp3Audio": { + "description": "Output only. Indicates the third-party audio creative supports MP3. Output only and only valid for third-party audio creatives. Third-party audio creatives are creatives with following hosting_source: * `HOSTING_SOURCE_THIRD_PARTY` combined with following creative_type: * `CREATIVE_TYPE_AUDIO`", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of the creative.", + "readOnly": true, + "type": "string" + }, + "notes": { + "description": "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 writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO`", + "items": { + "type": "string" + }, + "type": "array" + }, + "transcodes": { + "description": "Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s 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 **not** supported for this creative type.", + "Square native app install creative. Create and update methods are **not** supported for this creative type.", + "Audio creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Publisher hosted creative. Create and update methods are **not** supported for this creative type.", + "Native video creative. Create and update methods are supported for this creative type if the hosting_source is `HOSTING_SOURCE_HOSTED`", + "Templated app install mobile video creative. Create and update methods are **not** supported for this creative type." + ], + "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", + "RULE_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.", + "Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object. This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error." + ], + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED`", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "modelDetails": { + "description": "Output only. The details of custom bidding models for each advertiser who has access. This field may only include the details of the queried advertiser if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", + "items": { + "$ref": "CustomBiddingModelDetails" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the custom bidding algorithm.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Immutable. The unique ID of the partner that owns the custom bidding algorithm.", + "format": "int64", + "type": "string" + }, + "sharedAdvertiserIds": { + "description": "The IDs of the advertisers who have access to this algorithm. If advertiser_id is set, this field will only consist of that value. This field will not be set if the algorithm [`owner`](/display-video/api/reference/rest/v1/customBiddingAlgorithms#CustomBiddingAlgorithm.FIELDS.oneof_owner) is a partner and is being retrieved using an advertiser [`accessor`](/display-video/api/reference/rest/v1/customBiddingAlgorithms/list#body.QUERY_PARAMETERS.oneof_accessor).", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRules": { + "description": "A single custom bidding algorithm rules.", + "id": "CustomBiddingAlgorithmRules", + "properties": { + "active": { + "description": "Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time when the rules resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmRulesId": { + "description": "Output only. The unique ID of the rules resource.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "error": { + "$ref": "CustomBiddingAlgorithmRulesError", + "description": "Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`.", + "readOnly": true + }, + "name": { + "description": "Output only. The resource name of the rules resource.", + "readOnly": true, + "type": "string" + }, + "rules": { + "$ref": "CustomBiddingAlgorithmRulesRef", + "description": "Required. Immutable. The reference to the uploaded AlgorithmRules file." + }, + "state": { + "description": "Output only. The state of the rules resource.", + "enum": [ + "STATE_UNSPECIFIED", + "ACCEPTED", + "REJECTED" + ], + "enumDescriptions": [ + "The rules state are unspecified or unknown in this version.", + "The rules have been accepted for scoring impressions.", + "The rules have been rejected by backend pipelines. They may have errors." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRulesError": { + "description": "An error message for a CustomBiddingAlgorithmRules resource.", + "id": "CustomBiddingAlgorithmRulesError", + "properties": { + "errorCode": { + "description": "The type of error.", + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "SYNTAX_ERROR", + "CONSTRAINT_VIOLATION_ERROR", + "INTERNAL_ERROR" + ], + "enumDescriptions": [ + "The error is not specified or is unknown in this version.", + "The rules have a syntax error.", + "The rules have a constraint violation error.", + "Internal errors were thrown while processing the rules." + ], + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingAlgorithmRulesRef": { + "description": "The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.", + "id": "CustomBiddingAlgorithmRulesRef", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/rulesRef/{ref_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingModelDetails": { + "description": "The details of a custom bidding algorithm model for a single shared advertiser.", + "id": "CustomBiddingModelDetails", + "properties": { + "advertiserId": { + "description": "The unique ID of the relevant advertiser.", + "format": "int64", + "type": "string" + }, + "readinessState": { + "description": "The readiness state of custom bidding model.", + "enum": [ + "READINESS_STATE_UNSPECIFIED", + "READINESS_STATE_ACTIVE", + "READINESS_STATE_INSUFFICIENT_DATA", + "READINESS_STATE_TRAINING", + "READINESS_STATE_NO_VALID_SCRIPT", + "READINESS_STATE_EVALUATION_FAILURE" + ], + "enumDescriptions": [ + "State is not specified or is unknown in this version.", + "The model is trained and ready for serving.", + "There is not enough data to train the serving model.", + "The model is training and not ready for serving.", + "A valid custom bidding script has not been provided with which to train the model. This state will only be applied to algorithms whose `custom_bidding_algorithm_type` is `SCRIPT_BASED`.", + "A valid script was provided but failed evaluation. This is applicable for scripts that could not be evaluated in the alloted time." + ], + "type": "string" + }, + "suspensionState": { + "description": "Output only. The suspension state of custom bidding model.", + "enum": [ + "SUSPENSION_STATE_UNSPECIFIED", + "SUSPENSION_STATE_ENABLED", + "SUSPENSION_STATE_DORMANT", + "SUSPENSION_STATE_SUSPENDED" + ], + "enumDescriptions": [ + "State is not specified or is unknown in this version.", + "Model is enabled, either recently used, currently used or scheduled to be used. The algorithm is actively scoring impressions for this advertiser.", + "Model has not been used recently. Although the model still acts as `ENABLED`, it will eventually be suspended if not used.", + "Model is suspended from scoring impressions and cannot serve. If the algorithm is assigned to a line item under this advertiser or otherwise updated, it will switch back to the `ENABLED` state and require time to prepare the serving model again." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingScript": { + "description": "A single custom bidding script.", + "id": "CustomBiddingScript", + "properties": { + "active": { + "description": "Output only. Whether the script is currently being used for scoring by the parent algorithm.", + "readOnly": true, + "type": "boolean" + }, + "createTime": { + "description": "Output only. The time when the script was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "customBiddingAlgorithmId": { + "description": "Output only. The unique ID of the custom bidding algorithm the script belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "customBiddingScriptId": { + "description": "Output only. The unique ID of the custom bidding script.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "errors": { + "description": "Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED.", + "items": { + "$ref": "ScriptError" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Output only. The resource name of the custom bidding script.", + "readOnly": true, + "type": "string" + }, + "script": { + "$ref": "CustomBiddingScriptRef", + "description": "The reference to the uploaded script file." + }, + "state": { + "description": "Output only. The state of the custom bidding script.", + "enum": [ + "STATE_UNSPECIFIED", + "ACCEPTED", + "REJECTED", + "PENDING" + ], + "enumDescriptions": [ + "The script state is not specified or is unknown in this version.", + "The script has been accepted for scoring impressions.", + "The script has been rejected by backend pipelines. It may have errors.", + "The script is being processed for backend pipelines." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomBiddingScriptRef": { + "description": "The reference to the uploaded custom bidding script file.", + "id": "CustomBiddingScriptRef", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to Download the script files. Or media.upload to Upload the script files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id}/scriptRef/{ref_id}`.", + "type": "string" + } + }, + "type": "object" + }, + "CustomLabel": { + "description": "The key and value of a custom label.", + "id": "CustomLabel", + "properties": { + "key": { + "description": "The key of the label.", + "enum": [ + "CUSTOM_LABEL_KEY_UNSPECIFIED", + "CUSTOM_LABEL_KEY_0", + "CUSTOM_LABEL_KEY_1", + "CUSTOM_LABEL_KEY_2", + "CUSTOM_LABEL_KEY_3", + "CUSTOM_LABEL_KEY_4" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "Key index 0.", + "Key index 1.", + "Key index 2.", + "Key index 3.", + "Key index 4." + ], + "type": "string" + }, + "value": { + "description": "The value of the label.", + "type": "string" + } + }, + "type": "object" + }, + "CustomList": { + "description": "Describes a custom list entity, such as a custom affinity or custom intent audience list.", + "id": "CustomList", + "properties": { + "customListId": { + "description": "Output only. The unique ID of the custom list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Output only. The display name of the custom list. .", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the custom list.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "CustomListGroup": { + "description": "Details of custom list group. All custom list targeting settings are logically ‘OR’ 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" + }, + "DayAndTime": { + "description": "Representation of time defined by day of the week and hour of the day.", + "id": "DayAndTime", + "properties": { + "dayOfWeek": { + "description": "Required. Day of the week.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "hourOfDay": { + "description": "Required. Hour of the day.", + "format": "int32", + "type": "integer" + }, + "timeZoneResolution": { + "description": "Required. The mechanism used to determine the relevant timezone.", + "enum": [ + "TIME_ZONE_RESOLUTION_UNSPECIFIED", + "TIME_ZONE_RESOLUTION_END_USER", + "TIME_ZONE_RESOLUTION_ADVERTISER" + ], + "enumDescriptions": [ + "Time zone resolution is either unspecific or unknown.", + "Times are resolved in the time zone of the user that saw the ad.", + "Times are resolved in the time zone of the advertiser that served the ad." + ], + "type": "string" + } + }, + "type": "object" + }, + "DayAndTimeAssignedTargetingOptionDetails": { + "description": "Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`.", + "id": "DayAndTimeAssignedTargetingOptionDetails", + "properties": { + "dayOfWeek": { + "description": "Required. The day of the week for this day and time targeting setting.", + "enum": [ + "DAY_OF_WEEK_UNSPECIFIED", + "MONDAY", + "TUESDAY", + "WEDNESDAY", + "THURSDAY", + "FRIDAY", + "SATURDAY", + "SUNDAY" + ], + "enumDescriptions": [ + "The day of the week is unspecified.", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday", + "Sunday" + ], + "type": "string" + }, + "endHour": { + "description": "Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).", + "format": "int32", + "type": "integer" + }, + "startHour": { + "description": "Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).", + "format": "int32", + "type": "integer" + }, + "timeZoneResolution": { + "description": "Required. The mechanism used to determine which timezone to use for this day and time targeting setting.", + "enum": [ + "TIME_ZONE_RESOLUTION_UNSPECIFIED", + "TIME_ZONE_RESOLUTION_END_USER", + "TIME_ZONE_RESOLUTION_ADVERTISER" + ], + "enumDescriptions": [ + "Time zone resolution is either unspecific or unknown.", + "Times are resolved in the time zone of the user that saw the ad.", + "Times are resolved in the time zone of the advertiser that served the ad." + ], + "type": "string" + } + }, + "type": "object" + }, + "DeleteAssignedTargetingOptionsRequest": { + "description": "A request listing which assigned targeting options of a given targeting type should be deleted.", + "id": "DeleteAssignedTargetingOptionsRequest", + "properties": { + "assignedTargetingOptionIds": { + "description": "Required. The assigned targeting option IDs to delete.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetingType": { + "description": "Required. Identifies the type of this assigned targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "type": "string" + } + }, + "type": "object" + }, + "DeviceMakeModelAssignedTargetingOptionDetails": { + "description": "Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "id": "DeviceMakeModelAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the device make and model.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "type": "string" + } + }, + "type": "object" + }, + "DeviceMakeModelTargetingOptionDetails": { + "description": "Represents a targetable device make and model. This will be populated in the device_make_model_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.", + "id": "DeviceMakeModelTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the device make and model.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DeviceTypeAssignedTargetingOptionDetails": { + "description": "Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.", + "id": "DeviceTypeAssignedTargetingOptionDetails", + "properties": { + "deviceType": { + "description": "Required. The display name of the device type.", + "enum": [ + "DEVICE_TYPE_UNSPECIFIED", + "DEVICE_TYPE_COMPUTER", + "DEVICE_TYPE_CONNECTED_TV", + "DEVICE_TYPE_SMART_PHONE", + "DEVICE_TYPE_TABLET" + ], + "enumDescriptions": [ + "Default value when device type is not specified in this version. This enum is a placeholder for default value and does not represent a real device type option.", + "Computer.", + "Connected TV.", + "Smart phone.", + "Tablet." + ], + "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.", + "Computer.", + "Connected TV.", + "Smart phone.", + "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" + }, + "DisplayVideoSourceAd": { + "description": "The ad sourced from a DV360 creative.", + "id": "DisplayVideoSourceAd", + "properties": { + "creativeId": { + "description": "The ID of the source creative.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerify": { + "description": "Details of DoubleVerify settings.", + "id": "DoubleVerify", + "properties": { + "appStarRating": { + "$ref": "DoubleVerifyAppStarRating", + "description": "Avoid bidding on apps with the star ratings." + }, + "avoidedAgeRatings": { + "description": "Avoid bidding on apps with the age rating.", + "items": { + "enum": [ + "AGE_RATING_UNSPECIFIED", + "APP_AGE_RATE_UNKNOWN", + "APP_AGE_RATE_4_PLUS", + "APP_AGE_RATE_9_PLUS", + "APP_AGE_RATE_12_PLUS", + "APP_AGE_RATE_17_PLUS", + "APP_AGE_RATE_18_PLUS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any age rating options.", + "Apps with unknown age rating.", + "Apps rated for Everyone (4+).", + "Apps rated for Everyone (9+).", + "Apps rated for Teens (12+).", + "Apps rated for Mature (17+).", + "Apps rated for Adults Only (18+)." + ], + "type": "string" + }, + "type": "array" + }, + "brandSafetyCategories": { + "$ref": "DoubleVerifyBrandSafetyCategories", + "description": "DV Brand Safety Controls." + }, + "customSegmentId": { + "description": "The custom segment ID provided by DoubleVerify. The ID must start with \"51\" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic", + "format": "int64", + "type": "string" + }, + "displayViewability": { + "$ref": "DoubleVerifyDisplayViewability", + "description": "Display viewability settings (applicable to display line items only)." + }, + "fraudInvalidTraffic": { + "$ref": "DoubleVerifyFraudInvalidTraffic", + "description": "Avoid Sites and Apps with historical Fraud & IVT Rates." + }, + "videoViewability": { + "$ref": "DoubleVerifyVideoViewability", + "description": "Video viewability settings (applicable to video line items only)." + } + }, + "type": "object" + }, + "DoubleVerifyAppStarRating": { + "description": "Details of DoubleVerify star ratings settings.", + "id": "DoubleVerifyAppStarRating", + "properties": { + "avoidInsufficientStarRating": { + "description": "Avoid bidding on apps with insufficient star ratings.", + "type": "boolean" + }, + "avoidedStarRating": { + "description": "Avoid bidding on apps with the star ratings.", + "enum": [ + "APP_STAR_RATE_UNSPECIFIED", + "APP_STAR_RATE_1_POINT_5_LESS", + "APP_STAR_RATE_2_LESS", + "APP_STAR_RATE_2_POINT_5_LESS", + "APP_STAR_RATE_3_LESS", + "APP_STAR_RATE_3_POINT_5_LESS", + "APP_STAR_RATE_4_LESS", + "APP_STAR_RATE_4_POINT_5_LESS" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any app star rating options.", + "Official Apps with rating < 1.5 Stars.", + "Official Apps with rating < 2 Stars.", + "Official Apps with rating < 2.5 Stars.", + "Official Apps with rating < 3 Stars.", + "Official Apps with rating < 3.5 Stars.", + "Official Apps with rating < 4 Stars.", + "Official Apps with rating < 4.5 Stars." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyBrandSafetyCategories": { + "description": "Settings for brand safety controls.", + "id": "DoubleVerifyBrandSafetyCategories", + "properties": { + "avoidUnknownBrandSafetyCategory": { + "description": "Unknown or unrateable.", + "type": "boolean" + }, + "avoidedHighSeverityCategories": { + "description": "Brand safety high severity avoidance categories.", + "items": { + "enum": [ + "HIGHER_SEVERITY_UNSPECIFIED", + "ADULT_CONTENT_PORNOGRAPHY", + "COPYRIGHT_INFRINGEMENT", + "SUBSTANCE_ABUSE", + "GRAPHIC_VIOLENCE_WEAPONS", + "HATE_PROFANITY", + "CRIMINAL_SKILLS", + "NUISANCE_INCENTIVIZED_MALWARE_CLUTTER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any high severity categories.", + "Adult Content: Pornography, Mature Topics & Nudity.", + "Copyright Infringement.", + "Drugs/Alcohol/Controlled Substances: Substance Abuse.", + "Extreme Graphic/Explicit Violence/Weapons.", + "Hate/Profanity.", + "Illegal Activities: Criminal Skills.", + "Incentivized/Malware/Clutter." + ], + "type": "string" + }, + "type": "array" + }, + "avoidedMediumSeverityCategories": { + "description": "Brand safety medium severity avoidance categories.", + "items": { + "enum": [ + "MEDIUM_SEVERITY_UNSPECIFIED", + "AD_SERVERS", + "ADULT_CONTENT_SWIMSUIT", + "ALTERNATIVE_LIFESTYLES", + "CELEBRITY_GOSSIP", + "GAMBLING", + "OCCULT", + "SEX_EDUCATION", + "DISASTER_AVIATION", + "DISASTER_MAN_MADE", + "DISASTER_NATURAL", + "DISASTER_TERRORIST_EVENTS", + "DISASTER_VEHICLE", + "ALCOHOL", + "SMOKING", + "NEGATIVE_NEWS_FINANCIAL", + "NON_ENGLISH", + "PARKING_PAGE", + "UNMODERATED_UGC", + "INFLAMMATORY_POLITICS_AND_NEWS", + "NEGATIVE_NEWS_PHARMACEUTICAL" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any medium severity categories.", + "Ad Servers.", + "Adult Content: Swimsuit.", + "Controversial Subjects: Alternative Lifestyles.", + "Controversial Subjects: Celebrity Gossip.", + "Controversial Subjects: Gambling.", + "Controversial Subjects: Occult.", + "Controversial Subjects: Sex Education.", + "Disaster: Aviation.", + "Disaster: Man-made.", + "Disaster: Natural.", + "Disaster: Terrorist Events.", + "Disaster: Vehicle.", + "Drugs/Alcohol/Controlled Substances: Alcohol.", + "Drugs/Alcohol/Controlled Substances: Smoking.", + "Negative News: Financial.", + "Non-Std Content: Non-English.", + "Non-Std Content: Parking Page.", + "Unmoderated UGC: Forums, Images & Video.", + "Controversial Subjects: Inflammatory Politics and News.", + "Negative News: Pharmaceutical." + ], + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "DoubleVerifyDisplayViewability": { + "description": "Details of DoubleVerify display viewability settings.", + "id": "DoubleVerifyDisplayViewability", + "properties": { + "iab": { + "description": "Target web and app inventory to maximize IAB viewable rate.", + "enum": [ + "IAB_VIEWED_RATE_UNSPECIFIED", + "IAB_VIEWED_RATE_80_PERCENT_HIGHER", + "IAB_VIEWED_RATE_75_PERCENT_HIGHER", + "IAB_VIEWED_RATE_70_PERCENT_HIGHER", + "IAB_VIEWED_RATE_65_PERCENT_HIGHER", + "IAB_VIEWED_RATE_60_PERCENT_HIGHER", + "IAB_VIEWED_RATE_55_PERCENT_HIGHER", + "IAB_VIEWED_RATE_50_PERCENT_HIGHER", + "IAB_VIEWED_RATE_40_PERCENT_HIGHER", + "IAB_VIEWED_RATE_30_PERCENT_HIGHER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any IAB viewed rate options.", + "Target web and app inventory to maximize IAB viewable rate 80% or higher.", + "Target web and app inventory to maximize IAB viewable rate 75% or higher.", + "Target web and app inventory to maximize IAB viewable rate 70% or higher.", + "Target web and app inventory to maximize IAB viewable rate 65% or higher.", + "Target web and app inventory to maximize IAB viewable rate 60% or higher.", + "Target web and app inventory to maximize IAB viewable rate 55% or higher.", + "Target web and app inventory to maximize IAB viewable rate 50% or higher.", + "Target web and app inventory to maximize IAB viewable rate 40% or higher.", + "Target web and app inventory to maximize IAB viewable rate 30% or higher." + ], + "type": "string" + }, + "viewableDuring": { + "description": "Target web and app inventory to maximize 100% viewable duration.", + "enum": [ + "AVERAGE_VIEW_DURATION_UNSPECIFIED", + "AVERAGE_VIEW_DURATION_5_SEC", + "AVERAGE_VIEW_DURATION_10_SEC", + "AVERAGE_VIEW_DURATION_15_SEC" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any average view duration options.", + "Target web and app inventory to maximize 100% viewable duration 5 seconds or more.", + "Target web and app inventory to maximize 100% viewable duration 10 seconds or more.", + "Target web and app inventory to maximize 100% viewable duration 15 seconds or more." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyFraudInvalidTraffic": { + "description": "DoubleVerify Fraud & Invalid Traffic settings.", + "id": "DoubleVerifyFraudInvalidTraffic", + "properties": { + "avoidInsufficientOption": { + "description": "Insufficient Historical Fraud & IVT Stats.", + "type": "boolean" + }, + "avoidedFraudOption": { + "description": "Avoid Sites and Apps with historical Fraud & IVT.", + "enum": [ + "FRAUD_UNSPECIFIED", + "AD_IMPRESSION_FRAUD_100", + "AD_IMPRESSION_FRAUD_50", + "AD_IMPRESSION_FRAUD_25", + "AD_IMPRESSION_FRAUD_10", + "AD_IMPRESSION_FRAUD_8", + "AD_IMPRESSION_FRAUD_6", + "AD_IMPRESSION_FRAUD_4", + "AD_IMPRESSION_FRAUD_2" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any fraud and invalid traffic options.", + "100% Fraud & IVT.", + "50% or Higher Fraud & IVT.", + "25% or Higher Fraud & IVT.", + "10% or Higher Fraud & IVT.", + "8% or Higher Fraud & IVT.", + "6% or Higher Fraud & IVT.", + "4% or Higher Fraud & IVT.", + "2% or Higher Fraud & IVT." + ], + "type": "string" + } + }, + "type": "object" + }, + "DoubleVerifyVideoViewability": { + "description": "Details of DoubleVerify video viewability settings.", + "id": "DoubleVerifyVideoViewability", + "properties": { + "playerImpressionRate": { + "description": "Target inventory to maximize impressions with 400x300 or greater player size.", + "enum": [ + "PLAYER_SIZE_400X300_UNSPECIFIED", + "PLAYER_SIZE_400X300_95", + "PLAYER_SIZE_400X300_70", + "PLAYER_SIZE_400X300_25", + "PLAYER_SIZE_400X300_5" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any impressions options.", + "Sites with 95%+ of impressions.", + "Sites with 70%+ of impressions.", + "Sites with 25%+ of impressions.", + "Sites with 5%+ of impressions." + ], + "type": "string" + }, + "videoIab": { + "description": "Target web inventory to maximize IAB viewable rate.", + "enum": [ + "VIDEO_IAB_UNSPECIFIED", + "IAB_VIEWABILITY_80_PERCENT_HIGHER", + "IAB_VIEWABILITY_75_PERCENT_HIGHER", + "IAB_VIEWABILITY_70_PERCENT_HIGHER", + "IAB_VIEWABILITY_65_PERCENT_HIHGER", + "IAB_VIEWABILITY_60_PERCENT_HIGHER", + "IAB_VIEWABILITY_55_PERCENT_HIHGER", + "IAB_VIEWABILITY_50_PERCENT_HIGHER", + "IAB_VIEWABILITY_40_PERCENT_HIHGER", + "IAB_VIEWABILITY_30_PERCENT_HIHGER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any video IAB viewable rate options.", + "Target web and app inventory to maximize IAB viewable rate 80% or higher.", + "Target web and app inventory to maximize IAB viewable rate 75% or higher.", + "Target web and app inventory to maximize IAB viewable rate 70% or higher.", + "Target web and app inventory to maximize IAB viewable rate 65% or higher.", + "Target web and app inventory to maximize IAB viewable rate 60% or higher.", + "Target web and app inventory to maximize IAB viewable rate 55% or higher.", + "Target web and app inventory to maximize IAB viewable rate 50% or higher.", + "Target web and app inventory to maximize IAB viewable rate 40% or higher.", + "Target web and app inventory to maximize IAB viewable rate 30% or higher." + ], + "type": "string" + }, + "videoViewableRate": { + "description": "Target web inventory to maximize fully viewable rate.", + "enum": [ + "VIDEO_VIEWABLE_RATE_UNSPECIFIED", + "VIEWED_PERFORMANCE_40_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_35_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_30_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_25_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_20_PERCENT_HIGHER", + "VIEWED_PERFORMANCE_10_PERCENT_HIGHER" + ], + "enumDescriptions": [ + "This enum is only a placeholder and it doesn't specify any video viewable rate options.", + "Target web inventory to maximize fully viewable rate 40% or higher.", + "Target web inventory to maximize fully viewable rate 35% or higher.", + "Target web inventory to maximize fully viewable rate 30% or higher.", + "Target web inventory to maximize fully viewable rate 25% or higher.", + "Target web inventory to maximize fully viewable rate 20% or higher.", + "Target web inventory to maximize fully viewable rate 10% or higher." + ], + "type": "string" + } + }, + "type": "object" + }, + "DuplicateLineItemRequest": { + "description": "Request message for LineItemService.DuplicateLineItem.", + "id": "DuplicateLineItemRequest", + "properties": { + "targetDisplayName": { + "description": "The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "DuplicateLineItemResponse": { + "id": "DuplicateLineItemResponse", + "properties": { + "duplicateLineItemId": { + "description": "The ID of the created line item.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "EditCustomerMatchMembersRequest": { + "description": "Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers.", + "id": "EditCustomerMatchMembersRequest", + "properties": { + "addedContactInfoList": { + "$ref": "ContactInfoList", + "description": "Input only. A list of contact information to define the members to be added." + }, + "addedMobileDeviceIdList": { + "$ref": "MobileDeviceIdList", + "description": "Input only. A list of mobile device IDs to define the members to be added." + }, + "advertiserId": { + "description": "Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience.", + "format": "int64", + "type": "string" + } + }, + "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": "Required. The serving environment.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "type": "string" + } + }, + "type": "object" + }, + "EnvironmentTargetingOptionDetails": { + "description": "Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`.", + "id": "EnvironmentTargetingOptionDetails", + "properties": { + "environment": { + "description": "Output only. The serving environment.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "ENVIRONMENT_WEB_OPTIMIZED", + "ENVIRONMENT_WEB_NOT_OPTIMIZED", + "ENVIRONMENT_APP" + ], + "enumDescriptions": [ + "Default value when environment is not specified in this version. This enum is a placeholder for default value and does not represent a real environment option.", + "Target inventory displayed in browsers. This includes inventory that was designed for the device it was viewed on, such as mobile websites viewed on a mobile device. ENVIRONMENT_WEB_NOT_OPTIMIZED, if targeted, should be deleted prior to the deletion of this targeting option.", + "Target inventory displayed in browsers. This includes inventory that was not designed for the device but viewed on it, such as websites optimized for desktop but viewed on a mobile device. ENVIRONMENT_WEB_OPTIMIZED should be targeted prior to the addition of this targeting option.", + "Target inventory displayed in apps." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExchangeAssignedTargetingOptionDetails": { + "description": "Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", + "id": "ExchangeAssignedTargetingOptionDetails", + "properties": { + "exchange": { + "description": "Required. The enum value for the exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + } + }, + "type": "object" + }, + "ExchangeConfig": { + "description": "Settings that control which exchanges are enabled for a partner.", + "id": "ExchangeConfig", + "properties": { + "enabledExchanges": { + "description": "All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored.", + "items": { + "$ref": "ExchangeConfigEnabledExchange" + }, + "type": "array" + } + }, + "type": "object" + }, + "ExchangeConfigEnabledExchange": { + "description": "An enabled exchange in the partner.", + "id": "ExchangeConfigEnabledExchange", + "properties": { + "exchange": { + "description": "The enabled exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + }, + "googleAdManagerAgencyId": { + "description": "Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", + "readOnly": true, + "type": "string" + }, + "googleAdManagerBuyerNetworkId": { + "description": "Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange.", + "readOnly": true, + "type": "string" + }, + "seatId": { + "description": "Output only. Seat ID of the enabled exchange.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ExchangeReviewStatus": { + "description": "Exchange review status for the creative.", + "id": "ExchangeReviewStatus", + "properties": { + "exchange": { + "description": "The exchange reviewing the creative.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + }, + "status": { + "description": "Status of the exchange review.", + "enum": [ + "REVIEW_STATUS_UNSPECIFIED", + "REVIEW_STATUS_APPROVED", + "REVIEW_STATUS_REJECTED", + "REVIEW_STATUS_PENDING" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The creative is approved.", + "The creative is rejected.", + "The creative is pending review." + ], + "type": "string" + } + }, + "type": "object" + }, + "ExchangeTargetingOptionDetails": { + "description": "Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`.", + "id": "ExchangeTargetingOptionDetails", + "properties": { + "exchange": { + "description": "Output only. The type of exchange.", + "enum": [ + "EXCHANGE_UNSPECIFIED", + "EXCHANGE_GOOGLE_AD_MANAGER", + "EXCHANGE_APPNEXUS", + "EXCHANGE_BRIGHTROLL", + "EXCHANGE_ADFORM", + "EXCHANGE_ADMETA", + "EXCHANGE_ADMIXER", + "EXCHANGE_ADSMOGO", + "EXCHANGE_ADSWIZZ", + "EXCHANGE_BIDSWITCH", + "EXCHANGE_BRIGHTROLL_DISPLAY", + "EXCHANGE_CADREON", + "EXCHANGE_DAILYMOTION", + "EXCHANGE_FIVE", + "EXCHANGE_FLUCT", + "EXCHANGE_FREEWHEEL", + "EXCHANGE_GENIEE", + "EXCHANGE_GUMGUM", + "EXCHANGE_IMOBILE", + "EXCHANGE_IBILLBOARD", + "EXCHANGE_IMPROVE_DIGITAL", + "EXCHANGE_INDEX", + "EXCHANGE_KARGO", + "EXCHANGE_MICROAD", + "EXCHANGE_MOPUB", + "EXCHANGE_NEND", + "EXCHANGE_ONE_BY_AOL_DISPLAY", + "EXCHANGE_ONE_BY_AOL_MOBILE", + "EXCHANGE_ONE_BY_AOL_VIDEO", + "EXCHANGE_OOYALA", + "EXCHANGE_OPENX", + "EXCHANGE_PERMODO", + "EXCHANGE_PLATFORMONE", + "EXCHANGE_PLATFORMID", + "EXCHANGE_PUBMATIC", + "EXCHANGE_PULSEPOINT", + "EXCHANGE_REVENUEMAX", + "EXCHANGE_RUBICON", + "EXCHANGE_SMARTCLIP", + "EXCHANGE_SMARTRTB", + "EXCHANGE_SMARTSTREAMTV", + "EXCHANGE_SOVRN", + "EXCHANGE_SPOTXCHANGE", + "EXCHANGE_STROER", + "EXCHANGE_TEADSTV", + "EXCHANGE_TELARIA", + "EXCHANGE_TVN", + "EXCHANGE_UNITED", + "EXCHANGE_YIELDLAB", + "EXCHANGE_YIELDMO", + "EXCHANGE_UNRULYX", + "EXCHANGE_OPEN8", + "EXCHANGE_TRITON", + "EXCHANGE_TRIPLELIFT", + "EXCHANGE_TABOOLA", + "EXCHANGE_INMOBI", + "EXCHANGE_SMAATO", + "EXCHANGE_AJA", + "EXCHANGE_SUPERSHIP", + "EXCHANGE_NEXSTAR_DIGITAL", + "EXCHANGE_WAZE", + "EXCHANGE_SOUNDCAST", + "EXCHANGE_SHARETHROUGH", + "EXCHANGE_FYBER", + "EXCHANGE_RED_FOR_PUBLISHERS", + "EXCHANGE_MEDIANET", + "EXCHANGE_TAPJOY", + "EXCHANGE_VISTAR", + "EXCHANGE_DAX", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "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" + ], + "enumDeprecated": [ + false, + false, + false, + false, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "Audience was generated through matching customers to known contact information.", + "Audience was generated through matching customers to known Mobile device IDs.", + "Audience was generated through matching customers to known User IDs.", + "Audience was created based on campaign activity.", + "Audience was created based on excluding the number of impressions they were served.", + "Audience was created based on custom variables attached to pixel.", + "Audience was created based on past interactions with videos, YouTube ads, or YouTube channel.", + "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 ‘OR’ 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": "Required. The gender of the audience.", + "enum": [ + "GENDER_UNSPECIFIED", + "GENDER_MALE", + "GENDER_FEMALE", + "GENDER_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", + "The audience gender is male.", + "The audience gender is female.", + "The audience gender is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "GenderTargetingOptionDetails": { + "description": "Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`.", + "id": "GenderTargetingOptionDetails", + "properties": { + "gender": { + "description": "Output only. The gender of an audience.", + "enum": [ + "GENDER_UNSPECIFIED", + "GENDER_MALE", + "GENDER_FEMALE", + "GENDER_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when gender is not specified in this version. This enum is a place holder for default value and does not represent a real gender option.", + "The audience gender is male.", + "The audience gender is female.", + "The audience gender is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GenerateDefaultLineItemRequest": { + "description": "Request message for LineItemService.GenerateDefaultLineItem.", + "id": "GenerateDefaultLineItemRequest", + "properties": { + "displayName": { + "description": "Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "insertionOrderId": { + "description": "Required. The unique ID of the insertion order that the line item belongs to.", + "format": "int64", + "type": "string" + }, + "lineItemType": { + "description": "Required. The type of the line item.", + "enum": [ + "LINE_ITEM_TYPE_UNSPECIFIED", + "LINE_ITEM_TYPE_DISPLAY_DEFAULT", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_VIDEO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL", + "LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INVENTORY", + "LINE_ITEM_TYPE_AUDIO_DEFAULT", + "LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_ACTION", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_AUDIO", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", + "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", + "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", + "Image, HTML5, native, or rich media ads.", + "Display ads that drive installs of an app.", + "Video ads sold on a CPM basis for a variety of environments.", + "Video ads that drive installs of an app.", + "Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "RTB Audio ads sold for a variety of environments.", + "Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", + "YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", + "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." + ], + "type": "string" + }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." + } + }, + "type": "object" + }, + "GeoRegionAssignedTargetingOptionDetails": { + "description": "Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`.", + "id": "GeoRegionAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the geographic region (e.g., \"Ontario, Canada\").", + "readOnly": true, + "type": "string" + }, + "geoRegionType": { + "description": "Output only. The type of geographic region targeting.", + "enum": [ + "GEO_REGION_TYPE_UNKNOWN", + "GEO_REGION_TYPE_OTHER", + "GEO_REGION_TYPE_COUNTRY", + "GEO_REGION_TYPE_REGION", + "GEO_REGION_TYPE_TERRITORY", + "GEO_REGION_TYPE_PROVINCE", + "GEO_REGION_TYPE_STATE", + "GEO_REGION_TYPE_PREFECTURE", + "GEO_REGION_TYPE_GOVERNORATE", + "GEO_REGION_TYPE_CANTON", + "GEO_REGION_TYPE_UNION_TERRITORY", + "GEO_REGION_TYPE_AUTONOMOUS_COMMUNITY", + "GEO_REGION_TYPE_DMA_REGION", + "GEO_REGION_TYPE_METRO", + "GEO_REGION_TYPE_CONGRESSIONAL_DISTRICT", + "GEO_REGION_TYPE_COUNTY", + "GEO_REGION_TYPE_MUNICIPALITY", + "GEO_REGION_TYPE_CITY", + "GEO_REGION_TYPE_POSTAL_CODE", + "GEO_REGION_TYPE_DEPARTMENT", + "GEO_REGION_TYPE_AIRPORT", + "GEO_REGION_TYPE_TV_REGION", + "GEO_REGION_TYPE_OKRUG", + "GEO_REGION_TYPE_BOROUGH", + "GEO_REGION_TYPE_CITY_REGION", + "GEO_REGION_TYPE_ARRONDISSEMENT", + "GEO_REGION_TYPE_NEIGHBORHOOD", + "GEO_REGION_TYPE_UNIVERSITY", + "GEO_REGION_TYPE_DISTRICT" + ], + "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" + ], + "enumDeprecated": [ + false, + false, + false, + true, + true, + false, + false + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "Affinity type Google audience.", + "In-Market type Google audience.", + "Installed-Apps type Google audience.", + "New-Mobile-Devices type Google audience.", + "Life-Event type Google audience.", + "Extended-Demographic type Google audience." + ], + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the google audience.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAudienceGroup": { + "description": "Details of Google audience group. All Google audience targeting settings are logically ‘OR’ 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", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + }, + "guaranteedOrderId": { + "description": "Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange}-{legacy_guaranteed_order_id}`.", + "readOnly": true, + "type": "string" + }, + "legacyGuaranteedOrderId": { + "description": "Output only. The legacy ID of the guaranteed order. Assigned by the original exchange. The legacy ID is unique within one exchange, but is not guaranteed to be unique across all guaranteed orders. This ID is used in SDF and UI.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the guaranteed order.", + "readOnly": true, + "type": "string" + }, + "publisherName": { + "description": "Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "readAccessInherited": { + "description": "Whether all advertisers of read_write_partner_id have read access to the guaranteed order. Only applicable if read_write_partner_id is set. If True, overrides read_advertiser_ids.", + "type": "boolean" + }, + "readAdvertiserIds": { + "description": "The IDs of advertisers with read access to the guaranteed order. This field must not include the advertiser assigned to read_write_advertiser_id if it is set. All advertisers in this field must belong to read_write_partner_id or the same partner as read_write_advertiser_id.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "readWriteAdvertiserId": { + "description": "The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order.", + "format": "int64", + "type": "string" + }, + "readWritePartnerId": { + "description": "The partner with read/write access to the guaranteed order.", + "format": "int64", + "type": "string" + }, + "status": { + "$ref": "GuaranteedOrderStatus", + "description": "The status settings of the guaranteed order." + }, + "updateTime": { + "description": "Output only. The timestamp when the guaranteed order was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GuaranteedOrderStatus": { + "description": "The status settings of the guaranteed order.", + "id": "GuaranteedOrderStatus", + "properties": { + "configStatus": { + "description": "Output only. The configuration status of the guaranteed order. Acceptable values are `PENDING` and `COMPLETED`. A guaranteed order must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve. Currently the configuration action can only be performed via UI.", + "enum": [ + "GUARANTEED_ORDER_CONFIG_STATUS_UNSPECIFIED", + "PENDING", + "COMPLETED" + ], + "enumDescriptions": [ + "The approval status is not specified or is unknown in this version.", + "The beginning state of a guaranteed order. The guaranteed order in this state needs to be configured before it can serve.", + "The state after the buyer configures a guaranteed order." + ], + "readOnly": true, + "type": "string" + }, + "entityPauseReason": { + "description": "The user-provided reason for pausing this guaranteed order. Must be UTF-8 encoded with a maximum length of 100 bytes. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", + "type": "string" + }, + "entityStatus": { + "description": "Whether or not the guaranteed order is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + } + }, + "type": "object" + }, + "HouseholdIncomeAssignedTargetingOptionDetails": { + "description": "Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", + "id": "HouseholdIncomeAssignedTargetingOptionDetails", + "properties": { + "householdIncome": { + "description": "Required. The household income of the audience.", + "enum": [ + "HOUSEHOLD_INCOME_UNSPECIFIED", + "HOUSEHOLD_INCOME_UNKNOWN", + "HOUSEHOLD_INCOME_LOWER_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", + "HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", + "HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", + "HOUSEHOLD_INCOME_TOP_10_PERCENT" + ], + "enumDescriptions": [ + "Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", + "The household income of the audience is unknown.", + "The audience is in the lower 50% of U.S. household incomes.", + "The audience is in the top 41-50% of U.S. household incomes.", + "The audience is in the top 31-40% of U.S. household incomes.", + "The audience is in the top 21-30% of U.S. household incomes.", + "The audience is in the top 11-20% of U.S. household incomes.", + "The audience is in the top 10% of U.S. household incomes." + ], + "type": "string" + } + }, + "type": "object" + }, + "HouseholdIncomeTargetingOptionDetails": { + "description": "Represents a targetable household income. This will be populated in the household_income_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.", + "id": "HouseholdIncomeTargetingOptionDetails", + "properties": { + "householdIncome": { + "description": "Output only. The household income of an audience.", + "enum": [ + "HOUSEHOLD_INCOME_UNSPECIFIED", + "HOUSEHOLD_INCOME_UNKNOWN", + "HOUSEHOLD_INCOME_LOWER_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_41_TO_50_PERCENT", + "HOUSEHOLD_INCOME_TOP_31_TO_40_PERCENT", + "HOUSEHOLD_INCOME_TOP_21_TO_30_PERCENT", + "HOUSEHOLD_INCOME_TOP_11_TO_20_PERCENT", + "HOUSEHOLD_INCOME_TOP_10_PERCENT" + ], + "enumDescriptions": [ + "Default value when household income is not specified in this version. This enum is a placeholder for default value and does not represent a real household income option.", + "The household income of the audience is unknown.", + "The audience is in the lower 50% of U.S. household incomes.", + "The audience is in the top 41-50% of U.S. household incomes.", + "The audience is in the top 31-40% of U.S. household incomes.", + "The audience is in the top 21-30% of U.S. household incomes.", + "The audience is in the top 11-20% of U.S. household incomes.", + "The audience is in the top 10% of U.S. household incomes." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "IdFilter": { + "description": "A filtering option that filters entities by their entity IDs.", + "id": "IdFilter", + "properties": { + "adGroupAdIds": { + "description": "YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "adGroupIds": { + "description": "YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + }, + "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" + }, + "ImageAsset": { + "description": "Meta data of an image asset.", + "id": "ImageAsset", + "properties": { + "fileSize": { + "description": "File size of the image asset in bytes.", + "format": "int64", + "type": "string" + }, + "fullSize": { + "$ref": "Dimensions", + "description": "Metadata for this image at its original size." + }, + "mimeType": { + "description": "MIME type of the image asset.", + "type": "string" + } + }, + "type": "object" + }, + "InStreamAd": { + "description": "Details for an in-stream ad.", + "id": "InStreamAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + }, + "customParameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The custom parameters to pass custom values to tracking URL template.", + "type": "object" + } + }, + "type": "object" + }, + "InsertionOrder": { + "description": "A single insertion order.", + "id": "InsertionOrder", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the insertion order belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "The bidding strategy of the insertion order. By default, fixed_bid is set." + }, + "budget": { + "$ref": "InsertionOrderBudget", + "description": "Required. The budget allocation settings of the insertion order." + }, + "campaignId": { + "description": "Required. Immutable. The unique ID of the campaign that the insertion order belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Required. Controls whether or not the insertion order can spend its budget and bid on inventory. * For CreateInsertionOrder method, only `ENTITY_STATUS_DRAFT` is allowed. To activate an insertion order, use UpdateInsertionOrder method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * An insertion order cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * An insertion order cannot be set to `ENTITY_STATUS_ACTIVE` if its parent campaign is not active.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "frequencyCap": { + "$ref": "FrequencyCap", + "description": "Required. The frequency capping setting of the insertion order." + }, + "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." + }, + "kpi": { + "$ref": "Kpi", + "description": "Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the \"Goal\" in the Display & Video 360 interface." + }, + "name": { + "description": "Output only. The resource name of the insertion order.", + "readOnly": true, + "type": "string" + }, + "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" + }, + "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 kpi. No automation on bid settings.", + "No automation of bid or budget on insertion order level. Bid and budget must be manually configured at the line item level.", + "Allow the system to automatically adjust bids and shift budget to owning line items to optimize performance defined by kpi." + ], + "type": "string" + }, + "budgetSegments": { + "description": "Required. The list of budget segments. Use a budget segment to specify a specific budget for a given period of time an insertion order is running.", + "items": { + "$ref": "InsertionOrderBudgetSegment" + }, + "type": "array" + }, + "budgetUnit": { + "description": "Required. Immutable. The budget unit specifies whether the budget is currency based or impression based.", + "enum": [ + "BUDGET_UNIT_UNSPECIFIED", + "BUDGET_UNIT_CURRENCY", + "BUDGET_UNIT_IMPRESSIONS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Budgeting in currency amounts.", + "Budgeting in impression amounts." + ], + "type": "string" + } + }, + "type": "object" + }, + "InsertionOrderBudgetSegment": { + "description": "Settings that control the budget of a single budget segment.", + "id": "InsertionOrderBudgetSegment", + "properties": { + "budgetAmountMicros": { + "description": "Required. The budget amount the insertion order will spend for the given date_range. The amount is in micros. Must be greater than 0. For example, 500000000 represents 500 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "campaignBudgetId": { + "description": "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.", + "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", + "EXCHANGE_JCD", + "EXCHANGE_PLACE_EXCHANGE", + "EXCHANGE_APPLOVIN", + "EXCHANGE_CONNATIX", + "EXCHANGE_RESET_DIGITAL", + "EXCHANGE_HIVESTACK" + ], + "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öer SSP.", + "TeadsTv.", + "Telaria.", + "TVN.", + "United.", + "Yieldlab.", + "Yieldmo.", + "UnrulyX.", + "Open8.", + "Triton.", + "TripleLift.", + "Taboola.", + "InMobi.", + "Smaato.", + "Aja.", + "Supership.", + "Nexstar Digital.", + "Waze.", + "SoundCast.", + "Sharethrough.", + "Fyber.", + "Red For Publishers.", + "Media.net.", + "Tapjoy.", + "Vistar.", + "DAX.", + "JCD.", + "Place Exchange.", + "AppLovin.", + "Connatix.", + "Reset Digital.", + "Hivestack." + ], + "type": "string" + }, + "guaranteedOrderId": { + "description": "Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`.", + "type": "string" + }, + "inventorySourceId": { + "description": "Output only. The unique ID of the inventory source. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "inventorySourceProductType": { + "description": "Output only. The product type of the inventory source, denoting the way through which it sells inventory.", + "enum": [ + "INVENTORY_SOURCE_PRODUCT_TYPE_UNSPECIFIED", + "PREFERRED_DEAL", + "PRIVATE_AUCTION", + "PROGRAMMATIC_GUARANTEED", + "TAG_GUARANTEED", + "YOUTUBE_RESERVE", + "INSTANT_RESERVE", + "GUARANTEED_PACKAGE", + "PROGRAMMATIC_TV", + "AUCTION_PACKAGE" + ], + "enumDescriptions": [ + "The product type is not specified or is unknown in this version. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Preferred Deal.", + "The inventory source sells inventory through Private Auction.", + "The inventory source sells inventory through Programmatic Guaranteed.", + "The inventory source sells inventory through Tag Guaranteed.", + "The inventory source sells inventory through YouTube Reserve.", + "The inventory source sells inventory through Instant Reserve. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Guaranteed Package. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Programmtic TV. Modifying inventory sources of this product type are not supported via API.", + "The inventory source sells inventory through Auction Package. Modifying inventory sources of this product type are not supported via API." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceType": { + "description": "Denotes the type of the inventory source.", + "enum": [ + "INVENTORY_SOURCE_TYPE_UNSPECIFIED", + "INVENTORY_SOURCE_TYPE_PRIVATE", + "INVENTORY_SOURCE_TYPE_AUCTION_PACKAGE" + ], + "enumDescriptions": [ + "The inventory source type is not specified or is unknown in this version.", + "Private inventory source.", + "Auction package." + ], + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the inventory source.", + "readOnly": true, + "type": "string" + }, + "publisherName": { + "description": "The publisher/seller name of the inventory source.", + "type": "string" + }, + "rateDetails": { + "$ref": "RateDetails", + "description": "Required. The rate details of the inventory source." + }, + "readAdvertiserIds": { + "description": "Output only. The IDs of advertisers with read-only access to the inventory source.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "readPartnerIds": { + "description": "Output only. The IDs of partners with read-only access to the inventory source. All advertisers of partners in this field inherit read-only access to the inventory source.", + "items": { + "format": "int64", + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "readWriteAccessors": { + "$ref": "InventorySourceAccessors", + "description": "The partner or advertisers that have read/write access to the inventory source. Output only when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`, in which case the read/write accessors are inherited from the parent guaranteed order. Required when commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED`. If commitment is `INVENTORY_SOURCE_COMMITMENT_NON_GUARANTEED` and a partner is set in this field, all advertisers under this partner will automatically have read-only access to the inventory source. These advertisers will not be included in read_advertiser_ids." + }, + "status": { + "$ref": "InventorySourceStatus", + "description": "The status settings of the inventory source." + }, + "timeRange": { + "$ref": "TimeRange", + "description": "The time range when this inventory source starts and stops serving." + }, + "updateTime": { + "description": "Output only. The timestamp when the inventory source was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceAccessors": { + "description": "The partner or advertisers with access to the inventory source.", + "id": "InventorySourceAccessors", + "properties": { + "advertisers": { + "$ref": "InventorySourceAccessorsAdvertiserAccessors", + "description": "The advertisers with access to the inventory source. All advertisers must belong to the same partner." + }, + "partner": { + "$ref": "InventorySourceAccessorsPartnerAccessor", + "description": "The partner with access to the inventory source." + } + }, + "type": "object" + }, + "InventorySourceAccessorsAdvertiserAccessors": { + "description": "The advertisers with access to the inventory source.", + "id": "InventorySourceAccessorsAdvertiserAccessors", + "properties": { + "advertiserIds": { + "description": "The IDs of the advertisers.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventorySourceAccessorsPartnerAccessor": { + "description": "The partner with access to the inventory source.", + "id": "InventorySourceAccessorsPartnerAccessor", + "properties": { + "partnerId": { + "description": "The ID of the partner.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceAssignedTargetingOptionDetails": { + "description": "Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.", + "id": "InventorySourceAssignedTargetingOptionDetails", + "properties": { + "inventorySourceId": { + "description": "Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceDisplayCreativeConfig": { + "description": "The configuration for display creatives.", + "id": "InventorySourceDisplayCreativeConfig", + "properties": { + "creativeSize": { + "$ref": "Dimensions", + "description": "The size requirements for display creatives that can be assigned to the inventory source." + } + }, + "type": "object" + }, + "InventorySourceFilter": { + "description": "A filtering option for filtering on Inventory Source entities.", + "id": "InventorySourceFilter", + "properties": { + "inventorySourceIds": { + "description": "Inventory Sources to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. Leave empty to download all Inventory Sources for the selected Advertiser or Partner.", + "items": { + "format": "int64", + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "InventorySourceGroup": { + "description": "A collection of targetable inventory sources.", + "id": "InventorySourceGroup", + "properties": { + "displayName": { + "description": "Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "inventorySourceGroupId": { + "description": "Output only. The unique ID of the inventory source group. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the inventory source group.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceGroupAssignedTargetingOptionDetails": { + "description": "Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.", + "id": "InventorySourceGroupAssignedTargetingOptionDetails", + "properties": { + "inventorySourceGroupId": { + "description": "Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceStatus": { + "description": "The status related settings of the inventory source.", + "id": "InventorySourceStatus", + "properties": { + "configStatus": { + "description": "Output only. The configuration status of the inventory source. Only applicable for guaranteed inventory sources. Acceptable values are `INVENTORY_SOURCE_CONFIG_STATUS_PENDING` and `INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED`. An inventory source must be configured (fill in the required fields, choose creatives, and select a default campaign) before it can serve.", + "enum": [ + "INVENTORY_SOURCE_CONFIG_STATUS_UNSPECIFIED", + "INVENTORY_SOURCE_CONFIG_STATUS_PENDING", + "INVENTORY_SOURCE_CONFIG_STATUS_COMPLETED" + ], + "enumDescriptions": [ + "The approval status is not specified or is unknown in this version.", + "The beginning state of a guaranteed inventory source. The inventory source in this state needs to be configured.", + "The state after the buyer configures a guaranteed inventory source." + ], + "readOnly": true, + "type": "string" + }, + "entityPauseReason": { + "description": "The user-provided reason for pausing this inventory source. Must not exceed 100 characters. Only applicable when entity_status is set to `ENTITY_STATUS_PAUSED`.", + "type": "string" + }, + "entityStatus": { + "description": "Whether or not the inventory source is servable. Acceptable values are `ENTITY_STATUS_ACTIVE`, `ENTITY_STATUS_ARCHIVED`, and `ENTITY_STATUS_PAUSED`. Default value is `ENTITY_STATUS_ACTIVE`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "type": "string" + }, + "sellerPauseReason": { + "description": "Output only. The seller-provided reason for pausing this inventory source. Only applicable for inventory sources synced directly from the publishers and when seller_status is set to `ENTITY_STATUS_PAUSED`.", + "readOnly": true, + "type": "string" + }, + "sellerStatus": { + "description": "Output only. The status set by the seller for the inventory source. Only applicable for inventory sources synced directly from the publishers. Acceptable values are `ENTITY_STATUS_ACTIVE` and `ENTITY_STATUS_PAUSED`.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "InventorySourceVideoCreativeConfig": { + "description": "The configuration for video creatives.", + "id": "InventorySourceVideoCreativeConfig", + "properties": { + "duration": { + "description": "The duration requirements for the video creatives that can be assigned to the inventory source.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "Invoice": { + "description": "A single invoice.", + "id": "Invoice", + "properties": { + "budgetInvoiceGroupingId": { + "description": "The budget grouping ID for this invoice. This field will only be set if the invoice level of the corresponding billing profile was set to \"Budget invoice grouping ID\".", + "type": "string" + }, + "budgetSummaries": { + "description": "The list of summarized information for each budget associated with this invoice. This field will only be set if the invoice detail level of the corresponding billing profile was set to \"Budget level PO\".", + "items": { + "$ref": "BudgetSummary" + }, + "type": "array" + }, + "correctedInvoiceId": { + "description": "The ID of the original invoice being adjusted by this invoice, if applicable. May appear on the invoice PDF as `Reference invoice number`. If replaced_invoice_ids is set, this field will be empty.", + "type": "string" + }, + "currencyCode": { + "description": "The currency used in the invoice in ISO 4217 format.", + "type": "string" + }, + "displayName": { + "description": "The display name of the invoice.", + "type": "string" + }, + "dueDate": { + "$ref": "Date", + "description": "The date when the invoice is due." + }, + "invoiceId": { + "description": "The unique ID of the invoice.", + "type": "string" + }, + "invoiceType": { + "description": "The type of invoice document.", + "enum": [ + "INVOICE_TYPE_UNSPECIFIED", + "INVOICE_TYPE_CREDIT", + "INVOICE_TYPE_INVOICE" + ], + "enumDescriptions": [ + "Not specified or is unknown in this version.", + "The invoice has a negative amount.", + "The invoice has a positive amount." + ], + "type": "string" + }, + "issueDate": { + "$ref": "Date", + "description": "The date when the invoice was issued." + }, + "name": { + "description": "The resource name of the invoice.", + "type": "string" + }, + "nonBudgetMicros": { + "description": "The total amount of costs or adjustments not tied to a particular budget, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "paymentsAccountId": { + "description": "The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`.", + "type": "string" + }, + "paymentsProfileId": { + "description": "The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`.", + "type": "string" + }, + "pdfUrl": { + "description": "The URL to download a PDF copy of the invoice. This URL is user specific and requires a valid OAuth 2.0 access token to access. The access token must be provided in an `Authorization: Bearer` HTTP header and be authorized for one of the following scopes: * `https://www.googleapis.com/auth/display-video-mediaplanning` * `https://www.googleapis.com/auth/display-video` The URL will be valid for 7 days after retrieval of this invoice object or until this invoice is retrieved again.", + "type": "string" + }, + "purchaseOrderNumber": { + "description": "Purchase order number associated with the invoice.", + "type": "string" + }, + "replacedInvoiceIds": { + "description": "The ID(s) of any originally issued invoice that is being cancelled by this invoice, if applicable. Multiple invoices may be listed if those invoices are being consolidated into a single invoice. May appear on invoice PDF as `Replaced invoice numbers`. If corrected_invoice_id is set, this field will be empty.", + "items": { + "type": "string" + }, + "type": "array" + }, + "serviceDateRange": { + "$ref": "DateRange", + "description": "The service start and end dates which are covered by this invoice." + }, + "subtotalAmountMicros": { + "description": "The pre-tax subtotal amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalAmountMicros": { + "description": "The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + }, + "totalTaxAmountMicros": { + "description": "The sum of all taxes in invoice, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "KeywordAssignedTargetingOptionDetails": { + "description": "Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`.", + "id": "KeywordAssignedTargetingOptionDetails", + "properties": { + "keyword": { + "description": "Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.", + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + } + }, + "type": "object" + }, + "Kpi": { + "description": "Settings that control the key performance indicator, or KPI, of an insertion order.", + "id": "Kpi", + "properties": { + "kpiAmountMicros": { + "description": "The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "kpiPercentageMicros": { + "description": "The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07).", + "format": "int64", + "type": "string" + }, + "kpiString": { + "description": "A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`.", + "type": "string" + }, + "kpiType": { + "description": "Required. The type of KPI.", + "enum": [ + "KPI_TYPE_UNSPECIFIED", + "KPI_TYPE_CPM", + "KPI_TYPE_CPC", + "KPI_TYPE_CPA", + "KPI_TYPE_CTR", + "KPI_TYPE_VIEWABILITY", + "KPI_TYPE_CPIAVC", + "KPI_TYPE_CPE", + "KPI_TYPE_CLICK_CVR", + "KPI_TYPE_IMPRESSION_CVR", + "KPI_TYPE_VCPM", + "KPI_TYPE_VTR", + "KPI_TYPE_AUDIO_COMPLETION_RATE", + "KPI_TYPE_VIDEO_COMPLETION_RATE", + "KPI_TYPE_OTHER" + ], + "enumDescriptions": [ + "KPI type is not specified or is unknown in this version.", + "The KPI is CPM (cost per mille).", + "The KPI is CPC (cost per click).", + "The KPI is CPA (cost per action).", + "The KPI is CTR (click-through rate) percentage.", + "The KPI is Viewability percentage.", + "The KPI is CPIAVC (cost per impression audible and visible at completion).", + "The KPI is CPE (cost per engagement).", + "The KPI is click conversion rate (conversions per click) percentage.", + "The KPI is impression conversion rate (conversions per impression) percentage.", + "The KPI is VCPM (cost per thousand viewable impressions).", + "The KPI is YouTube view rate (YouTube views per impression) percentage.", + "The KPI is audio completion rate (complete audio listens per impression) percentage.", + "The KPI is video completion rate (complete video views per impression) percentage.", + "The KPI is some other value." + ], + "type": "string" + } + }, + "type": "object" + }, + "LanguageAssignedTargetingOptionDetails": { + "description": "Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`.", + "id": "LanguageAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the language (e.g., \"French\").", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.", + "type": "string" + } + }, + "type": "object" + }, + "LanguageTargetingOptionDetails": { + "description": "Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`.", + "id": "LanguageTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the language (e.g., \"French\").", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LineItem": { + "description": "A single line item.", + "id": "LineItem", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the line item belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "bidStrategy": { + "$ref": "BiddingStrategy", + "description": "Required. The bidding strategy of the line item." + }, + "budget": { + "$ref": "LineItemBudget", + "description": "Required. The budget allocation setting of the line item." + }, + "campaignId": { + "description": "Output only. The unique ID of the campaign that the line item belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "conversionCounting": { + "$ref": "ConversionCountingConfig", + "description": "The conversion tracking setting of the line item." + }, + "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", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_NON_SKIPPABLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_REACH_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_SIMPLE_OVER_THE_TOP", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_TARGET_FREQUENCY", + "LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIEW", + "LINE_ITEM_TYPE_DISPLAY_OUT_OF_HOME", + "LINE_ITEM_TYPE_VIDEO_OUT_OF_HOME" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version. Line items of this type and their targeting cannot be created or updated using the API.", + "Image, HTML5, native, or rich media ads.", + "Display ads that drive installs of an app.", + "Video ads sold on a CPM basis for a variety of environments.", + "Video ads that drive installs of an app.", + "Display ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on mobile app inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "RTB Audio ads sold for a variety of environments.", + "Over-the-top ads present in OTT insertion orders. This type is only applicable to line items with an insertion order of insertion_order_type `OVER_THE_TOP`.", + "YouTube video ads that promote conversions. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that show a story in a particular sequence using a mix of formats. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube audio ads. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Default YouTube video ads. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads (up to 15 seconds) that cannot be skipped. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV youTube video ads that optimize reaching more unique users at lower cost. May include bumper ads, skippable in-stream ads, or a mix of types. Line items of this type and their targeting cannot be created or updated using the API.", + "Connected TV default YouTube video ads. Only include in-stream ad-format. Line items of this type and their targeting cannot be created or updated using the API.", + "The goal of this line item type is to show the YouTube ads target number of times to the same person in a certain period of time. Line items of this type and their targeting cannot be created or updated using the API.", + "YouTube video ads that aim to get more views with a variety of ad formats. Line items of this type and their targeting cannot be created or updated using the API.", + "Display ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API.", + "Video ads served on digital-out-of-home inventory. Line items of this type and their targeting cannot be created or updated using the API." + ], + "type": "string" + }, + "mobileApp": { + "$ref": "MobileApp", + "description": "The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`." + }, + "name": { + "description": "Output only. The resource name of the line item.", + "readOnly": true, + "type": "string" + }, + "pacing": { + "$ref": "Pacing", + "description": "Required. The budget spending speed setting of the line item." + }, + "partnerCosts": { + "description": "The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.", + "items": { + "$ref": "PartnerCost" + }, + "type": "array" + }, + "partnerRevenueModel": { + "$ref": "PartnerRevenueModel", + "description": "Required. The partner revenue model setting of the line item." + }, + "reservationType": { + "description": "Output only. The reservation type of the line item.", + "enum": [ + "RESERVATION_TYPE_UNSPECIFIED", + "RESERVATION_TYPE_NOT_GUARANTEED", + "RESERVATION_TYPE_PROGRAMMATIC_GUARANTEED", + "RESERVATION_TYPE_TAG_GUARANTEED", + "RESERVATION_TYPE_PETRA_VIRAL", + "RESERVATION_TYPE_INSTANT_RESERVE" + ], + "enumDescriptions": [ + "Reservation type value is not specified or is unknown in this version.", + "Not created through a guaranteed inventory source.", + "Created through a programmatic guaranteed inventory source.", + "Created through a tag guaranteed inventory source.", + "Created through a Petra inventory source. Only applicable to YouTube and Partners line items.", + "Created with an instant quote. Only applicable to YouTube and partners line items." + ], + "readOnly": true, + "type": "string" + }, + "targetingExpansion": { + "$ref": "TargetingExpansionConfig", + "description": "The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists." + }, + "updateTime": { + "description": "Output only. The timestamp when the line item was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "warningMessages": { + "description": "Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.", + "items": { + "enum": [ + "LINE_ITEM_WARNING_MESSAGE_UNSPECIFIED", + "INVALID_FLIGHT_DATES", + "EXPIRED", + "PENDING_FLIGHT", + "ALL_PARTNER_ENABLED_EXCHANGES_NEGATIVELY_TARGETED", + "INVALID_INVENTORY_SOURCE", + "APP_INVENTORY_INVALID_SITE_TARGETING", + "APP_INVENTORY_INVALID_AUDIENCE_LISTS", + "NO_VALID_CREATIVE", + "PARENT_INSERTION_ORDER_PAUSED", + "PARENT_INSERTION_ORDER_EXPIRED" + ], + "enumDescriptions": [ + "Not specified or is unknown.", + "This line item has invalid flight dates. The line item will not run.", + "This line item's end date is in the past.", + "This line item will begin running in the future.", + "All partner enabled exchanges are negatively targeted. The line item will not run.", + "No active inventory sources are being targeted. The line item will not run.", + "This line item's Apps & URLs targeting doesn't include any mobile apps. This line item's type requires you to include mobile apps in your channel, sitelist, or apps targeting. The line item will not run.", + "This line item isn't targeting any mobile users. This line item's type requires you to target a user list with mobile users. The line item will not run.", + "This line item does not contain any valid creative. The line item will not run.", + "The insertion order of this line item is paused. The line item will not run.", + "The insertion order of this line item has its end date set in the past. The line item will not run." + ], + "type": "string" + }, + "readOnly": true, + "type": "array" + }, + "youtubeAndPartnersSettings": { + "$ref": "YoutubeAndPartnersSettings", + "description": "Output only. Settings specific to YouTube and Partners line items.", + "readOnly": true + } + }, + "type": "object" + }, + "LineItemAssignedTargetingOption": { + "description": "Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to.", + "id": "LineItemAssignedTargetingOption", + "properties": { + "assignedTargetingOption": { + "$ref": "AssignedTargetingOption", + "description": "The assigned targeting option resource." + }, + "lineItemId": { + "description": "The ID of the line item the assigned targeting option is assigned to.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "LineItemBudget": { + "description": "Settings that control how budget is allocated.", + "id": "LineItemBudget", + "properties": { + "budgetAllocationType": { + "description": "Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.", + "enum": [ + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNSPECIFIED", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED", + "LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Automatic budget allocation is enabled for the line item.", + "A fixed max budget amount is allocated for the line item.", + "No budget limit is applied to the line item." + ], + "type": "string" + }, + "budgetUnit": { + "description": "Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.", + "enum": [ + "BUDGET_UNIT_UNSPECIFIED", + "BUDGET_UNIT_CURRENCY", + "BUDGET_UNIT_IMPRESSIONS" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Budgeting in currency amounts.", + "Budgeting in impression amounts." + ], + "readOnly": true, + "type": "string" + }, + "maxAmount": { + "description": "The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "LineItemFlight": { + "description": "Settings that control the active duration of a line item.", + "id": "LineItemFlight", + "properties": { + "dateRange": { + "$ref": "DateRange", + "description": "The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037." + }, + "flightDateType": { + "description": "Required. The type of the line item's flight dates.", + "enum": [ + "LINE_ITEM_FLIGHT_DATE_TYPE_UNSPECIFIED", + "LINE_ITEM_FLIGHT_DATE_TYPE_INHERITED", + "LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The line item's flight dates are inherited from its parent insertion order.", + "The line item uses its own custom flight dates." + ], + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupAdsResponse": { + "id": "ListAdGroupAdsResponse", + "properties": { + "adGroupAds": { + "description": "The list of ad group ads. This list will be absent if empty.", + "items": { + "$ref": "AdGroupAd" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupAssignedTargetingOptionsResponse": { + "description": "Response message for ListAdGroupAssignedTargetingOptions.", + "id": "ListAdGroupAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdGroupsResponse": { + "id": "ListAdGroupsResponse", + "properties": { + "adGroups": { + "description": "The list of ad groups. This list will be absent if empty.", + "items": { + "$ref": "AdGroup" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdvertiserAssignedTargetingOptionsResponse": { + "description": "Response message for ListAdvertiserAssignedTargetingOptions.", + "id": "ListAdvertiserAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdvertiserAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListAdvertisersResponse": { + "id": "ListAdvertisersResponse", + "properties": { + "advertisers": { + "description": "The list of advertisers. This list will be absent if empty.", + "items": { + "$ref": "Advertiser" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdvertisers` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAssignedInventorySourcesResponse": { + "description": "Response message for AssignedInventorySourceService.ListAssignedInventorySources.", + "id": "ListAssignedInventorySourcesResponse", + "properties": { + "assignedInventorySources": { + "description": "The list of assigned inventory sources. This list will be absent if empty.", + "items": { + "$ref": "AssignedInventorySource" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedInventorySources` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListAssignedLocationsResponse": { + "description": "Response message for AssignedLocationService.ListAssignedLocations.", + "id": "ListAssignedLocationsResponse", + "properties": { + "assignedLocations": { + "description": "The list of assigned locations. This list will be absent if empty.", + "items": { + "$ref": "AssignedLocation" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAssignedLocations` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "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" + }, + "ListCustomBiddingAlgorithmRulesResponse": { + "id": "ListCustomBiddingAlgorithmRulesResponse", + "properties": { + "customBiddingRules": { + "description": "The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingAlgorithmRules" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomBiddingAlgorithmsResponse": { + "id": "ListCustomBiddingAlgorithmsResponse", + "properties": { + "customBiddingAlgorithms": { + "description": "The list of custom bidding algorithms. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingAlgorithm" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomBiddingScriptsResponse": { + "id": "ListCustomBiddingScriptsResponse", + "properties": { + "customBiddingScripts": { + "description": "The list of custom bidding scripts. This list will be absent if empty.", + "items": { + "$ref": "CustomBiddingScript" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingScriptsRequest` method to retrieve the next page of results. If this field is null, it means this is the last page.", + "type": "string" + } + }, + "type": "object" + }, + "ListCustomListsResponse": { + "id": "ListCustomListsResponse", + "properties": { + "customLists": { + "description": "The list of custom lists. This list will be absent if empty.", + "items": { + "$ref": "CustomList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomLists` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "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": { + "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" + }, + "ListNegativeKeywordListsResponse": { + "description": "Response message for NegativeKeywordListService.ListNegativeKeywordLists.", + "id": "ListNegativeKeywordListsResponse", + "properties": { + "negativeKeywordLists": { + "description": "The list of negative keyword lists. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeywordList" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywordLists` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListNegativeKeywordsResponse": { + "description": "Response message for NegativeKeywordService.ListNegativeKeywords.", + "id": "ListNegativeKeywordsResponse", + "properties": { + "negativeKeywords": { + "description": "The list of negative keywords. This list will be absent if empty.", + "items": { + "$ref": "NegativeKeyword" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListNegativeKeywords` method to retrieve the next page of results.", + "type": "string" + } + }, + "type": "object" + }, + "ListPartnerAssignedTargetingOptionsResponse": { + "id": "ListPartnerAssignedTargetingOptionsResponse", + "properties": { + "assignedTargetingOptions": { + "description": "The list of assigned targeting options. This list will be absent if empty.", + "items": { + "$ref": "AssignedTargetingOption" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListPartnerAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.", + "type": "string" + } + }, + "type": "object" + }, + "ListPartnersResponse": { + "id": "ListPartnersResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListPartners` method to retrieve the next page of results.", + "type": "string" + }, + "partners": { + "description": "The list of partners. This list will be absent if empty.", + "items": { + "$ref": "Partner" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSitesResponse": { + "description": "Response message for SiteService.ListSites.", + "id": "ListSitesResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListSites` method to retrieve the next page of results.", + "type": "string" + }, + "sites": { + "description": "The list of sites. This list will be absent if empty.", + "items": { + "$ref": "Site" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListTargetingOptionsResponse": { + "description": "Response message for ListTargetingOptions.", + "id": "ListTargetingOptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListTargetingOptions` method to retrieve the next page of results.", + "type": "string" + }, + "targetingOptions": { + "description": "The list of targeting options. This list will be absent if empty.", + "items": { + "$ref": "TargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListUsersResponse": { + "id": "ListUsersResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListUsers` method to retrieve the next page of results. This token will be absent if there are no more results to return.", + "type": "string" + }, + "users": { + "description": "The list of users. This list will be absent if empty.", + "items": { + "$ref": "User" + }, + "type": "array" + } + }, + "type": "object" + }, + "LocationList": { + "description": "A list of locations used for targeting.", + "id": "LocationList", + "properties": { + "advertiserId": { + "description": "Required. Immutable. The unique ID of the advertiser the location list belongs to.", + "format": "int64", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "locationListId": { + "description": "Output only. The unique ID of the location list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "locationType": { + "description": "Required. Immutable. The type of location. All locations in the list will share this type.", + "enum": [ + "TARGETING_LOCATION_TYPE_UNSPECIFIED", + "TARGETING_LOCATION_TYPE_PROXIMITY", + "TARGETING_LOCATION_TYPE_REGIONAL" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown.", + "The type for proximity geo location.", + "The type for regional geo location." + ], + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the location list.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LookbackWindow": { + "description": "Specifies how many days into the past to look when determining whether to record a conversion.", + "id": "LookbackWindow", + "properties": { + "clickDays": { + "description": "Lookback window, in days, from the last time a given user clicked on one of your ads.", + "format": "int32", + "type": "integer" + }, + "impressionDays": { + "description": "Lookback window, in days, from the last time a given user viewed one of your ads.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "LookupInvoiceCurrencyResponse": { + "id": "LookupInvoiceCurrencyResponse", + "properties": { + "currencyCode": { + "description": "Currency used by the advertiser in ISO 4217 format.", + "type": "string" + } + }, + "type": "object" + }, + "MastheadAd": { + "description": "Details for a Masthead Ad.", + "id": "MastheadAd", + "properties": { + "autoplayVideoDuration": { + "description": "The duration of time the video will autoplay.", + "format": "google-duration", + "type": "string" + }, + "autoplayVideoStartMillisecond": { + "description": "The amount of time in milliseconds after which the video will start to play.", + "format": "int64", + "type": "string" + }, + "callToActionButtonLabel": { + "description": "The text on the call-to-action button.", + "type": "string" + }, + "callToActionFinalUrl": { + "description": "The destination URL for the call-to-action button.", + "type": "string" + }, + "callToActionTrackingUrl": { + "description": "The tracking URL for the call-to-action button.", + "type": "string" + }, + "companionYoutubeVideos": { + "description": "The videos that appear next to the Masthead Ad on desktop. Can be no more than two.", + "items": { + "$ref": "YoutubeVideoDetails" + }, + "type": "array" + }, + "description": { + "description": "The description of the ad.", + "type": "string" + }, + "headline": { + "description": "The headline of the ad.", + "type": "string" + }, + "showChannelArt": { + "description": "Whether to show a background or banner that appears at the top of a YouTube page.", + "type": "boolean" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video used by the ad." + }, + "videoAspectRatio": { + "description": "The aspect ratio of the autoplaying YouTube video on the Masthead.", + "enum": [ + "VIDEO_ASPECT_RATIO_UNSPECIFIED", + "VIDEO_ASPECT_RATIO_WIDESCREEN", + "VIDEO_ASPECT_RATIO_FIXED_16_9" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "The video is stretched and the top and bottom are cropped.", + "The video uses a fixed 16:9 aspect ratio." + ], + "type": "string" + } + }, + "type": "object" + }, + "MaximizeSpendBidStrategy": { + "description": "A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget.", + "id": "MaximizeSpendBidStrategy", + "properties": { + "customBiddingAlgorithmId": { + "description": "The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.", + "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": "Required. The content position.", + "enum": [ + "NATIVE_CONTENT_POSITION_UNSPECIFIED", + "NATIVE_CONTENT_POSITION_UNKNOWN", + "NATIVE_CONTENT_POSITION_IN_ARTICLE", + "NATIVE_CONTENT_POSITION_IN_FEED", + "NATIVE_CONTENT_POSITION_PERIPHERAL", + "NATIVE_CONTENT_POSITION_RECOMMENDATION" + ], + "enumDescriptions": [ + "Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", + "The native content position is unknown.", + "Native content position is in-article, i.e., ads appear between the paragraphs of pages.", + "Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", + "Native content position is recommendation, i.e., ads appear in sections for recommended content." + ], + "type": "string" + } + }, + "type": "object" + }, + "NativeContentPositionTargetingOptionDetails": { + "description": "Represents a targetable native content position. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.", + "id": "NativeContentPositionTargetingOptionDetails", + "properties": { + "contentPosition": { + "description": "Output only. The content position.", + "enum": [ + "NATIVE_CONTENT_POSITION_UNSPECIFIED", + "NATIVE_CONTENT_POSITION_UNKNOWN", + "NATIVE_CONTENT_POSITION_IN_ARTICLE", + "NATIVE_CONTENT_POSITION_IN_FEED", + "NATIVE_CONTENT_POSITION_PERIPHERAL", + "NATIVE_CONTENT_POSITION_RECOMMENDATION" + ], + "enumDescriptions": [ + "Native content position is not specified in this version. This enum is a place holder for a default value and does not represent a real native content position.", + "The native content position is unknown.", + "Native content position is in-article, i.e., ads appear between the paragraphs of pages.", + "Native content position is in-feed, i.e., ads appear in a scrollable stream of content. A feed is typically editorial (e.g. a list of articles or news) or listings (e.g. a list of products or services).", + "Native content position is peripheral, i.e., ads appear outside of core content on pages, such as the right- or left-hand side of the page.", + "Native content position is recommendation, i.e., ads appear in sections for recommended content." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeyword": { + "description": "A negatively targeted keyword that belongs to a negative keyword list.", + "id": "NegativeKeyword", + "properties": { + "keywordValue": { + "description": "Required. Immutable. The negatively targeted keyword, for example `car insurance`. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10. Valid characters are restricted to ASCII characters only. The only URL-escaping permitted is for representing whitespace between words. Leading or trailing whitespace is ignored.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the negative keyword.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeywordList": { + "description": "A list of negative keywords used for targeting.", + "id": "NegativeKeywordList", + "properties": { + "advertiserId": { + "description": "Output only. The unique ID of the advertiser the negative keyword list belongs to.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the negative keyword list.", + "readOnly": true, + "type": "string" + }, + "negativeKeywordListId": { + "description": "Output only. The unique ID of the negative keyword list. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "targetedLineItemCount": { + "description": "Output only. Number of line items that are directly targeting this negative keyword list.", + "format": "int64", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NegativeKeywordListAssignedTargetingOptionDetails": { + "description": "Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`.", + "id": "NegativeKeywordListAssignedTargetingOptionDetails", + "properties": { + "negativeKeywordListId": { + "description": "Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "NonSkippableAd": { + "description": "Details for a non-skippable ad.", + "id": "NonSkippableAd", + "properties": { + "commonInStreamAttribute": { + "$ref": "CommonInStreamAttribute", + "description": "Common ad attributes." + }, + "customParameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The custom parameters to pass custom values to tracking URL template.", + "type": "object" + } + }, + "type": "object" + }, + "ObaIcon": { + "description": "OBA Icon for a Creative", + "id": "ObaIcon", + "properties": { + "clickTrackingUrl": { + "description": "Required. The click tracking URL of the OBA icon. Only URLs of the following domains are allowed: * https://info.evidon.com * https://l.betrad.com", + "type": "string" + }, + "dimensions": { + "$ref": "Dimensions", + "description": "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: “AdChoices”.", + "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": "Required. The type of Open Measurement enabled inventory.", + "enum": [ + "OMID_UNSPECIFIED", + "OMID_FOR_MOBILE_DISPLAY_ADS" + ], + "enumDescriptions": [ + "Default value when omid targeting is not specified in this version.", + "Open Measurement enabled mobile display inventory." + ], + "type": "string" + } + }, + "type": "object" + }, + "OmidTargetingOptionDetails": { + "description": "Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`.", + "id": "OmidTargetingOptionDetails", + "properties": { + "omid": { + "description": "Output only. The type of Open Measurement enabled inventory.", + "enum": [ + "OMID_UNSPECIFIED", + "OMID_FOR_MOBILE_DISPLAY_ADS" + ], + "enumDescriptions": [ + "Default value when omid targeting is not specified in this version.", + "Open Measurement enabled mobile display inventory." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OnScreenPositionAssignedTargetingOptionDetails": { + "description": "On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "id": "OnScreenPositionAssignedTargetingOptionDetails", + "properties": { + "adType": { + "description": "Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.", + "enum": [ + "AD_TYPE_UNSPECIFIED", + "AD_TYPE_DISPLAY", + "AD_TYPE_VIDEO", + "AD_TYPE_AUDIO" + ], + "enumDescriptions": [ + "Ad type is not specified or is unknown in this version.", + "Display creatives, e.g. image and HTML5.", + "Video creatives, e.g. video ads that play during streaming content in video players.", + "Audio creatives, e.g. audio ads that play during audio content." + ], + "readOnly": true, + "type": "string" + }, + "onScreenPosition": { + "description": "Output only. The on screen position.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "readOnly": true, + "type": "string" + }, + "targetingOptionId": { + "description": "Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "type": "string" + } + }, + "type": "object" + }, + "OnScreenPositionTargetingOptionDetails": { + "description": "Represents a targetable on screen position, which could be used by display and video ads. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.", + "id": "OnScreenPositionTargetingOptionDetails", + "properties": { + "onScreenPosition": { + "description": "Output only. The on screen position.", + "enum": [ + "ON_SCREEN_POSITION_UNSPECIFIED", + "ON_SCREEN_POSITION_UNKNOWN", + "ON_SCREEN_POSITION_ABOVE_THE_FOLD", + "ON_SCREEN_POSITION_BELOW_THE_FOLD" + ], + "enumDescriptions": [ + "On screen position is not specified in this version. This enum is a place holder for a default value and does not represent a real on screen position.", + "The ad position is unknown on the screen.", + "The ad is located above the fold.", + "The ad is located below the fold." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemAssignedTargetingOptionDetails": { + "description": "Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "id": "OperatingSystemAssignedTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the operating system.", + "readOnly": true, + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "targetingOptionId": { + "description": "Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "type": "string" + } + }, + "type": "object" + }, + "OperatingSystemTargetingOptionDetails": { + "description": "Represents a targetable operating system. This will be populated in the operating_system_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.", + "id": "OperatingSystemTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the operating system.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "Pacing": { + "description": "Settings that control the rate at which a budget is spent.", + "id": "Pacing", + "properties": { + "dailyMaxImpressions": { + "description": "Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.", + "format": "int64", + "type": "string" + }, + "dailyMaxMicros": { + "description": "Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.", + "format": "int64", + "type": "string" + }, + "pacingPeriod": { + "description": "Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.", + "enum": [ + "PACING_PERIOD_UNSPECIFIED", + "PACING_PERIOD_DAILY", + "PACING_PERIOD_FLIGHT" + ], + "enumDescriptions": [ + "Period value is not specified or is unknown in this version.", + "The pacing setting will be applied on daily basis.", + "The pacing setting will be applied to the whole flight duration." + ], + "type": "string" + }, + "pacingType": { + "description": "Required. The type of pacing that defines how the budget amount will be spent across the pacing_period.", + "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": "Required. The parental status of the audience.", + "enum": [ + "PARENTAL_STATUS_UNSPECIFIED", + "PARENTAL_STATUS_PARENT", + "PARENTAL_STATUS_NOT_A_PARENT", + "PARENTAL_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", + "The audience is a parent.", + "The audience is not a parent.", + "The parental status of the audience is unknown." + ], + "type": "string" + } + }, + "type": "object" + }, + "ParentalStatusTargetingOptionDetails": { + "description": "Represents a targetable parental status. This will be populated in the parental_status_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.", + "id": "ParentalStatusTargetingOptionDetails", + "properties": { + "parentalStatus": { + "description": "Output only. The parental status of an audience.", + "enum": [ + "PARENTAL_STATUS_UNSPECIFIED", + "PARENTAL_STATUS_PARENT", + "PARENTAL_STATUS_NOT_A_PARENT", + "PARENTAL_STATUS_UNKNOWN" + ], + "enumDescriptions": [ + "Default value when parental status is not specified in this version. This enum is a place holder for default value and does not represent a real parental status option.", + "The audience is a parent.", + "The audience is not a parent.", + "The parental status of the audience is unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Partner": { + "description": "A single partner in Display & Video 360 (DV360).", + "id": "Partner", + "properties": { + "adServerConfig": { + "$ref": "PartnerAdServerConfig", + "description": "Ad server related settings of the partner." + }, + "billingConfig": { + "$ref": "PartnerBillingConfig", + "description": "Billing related settings of the partner." + }, + "dataAccessConfig": { + "$ref": "PartnerDataAccessConfig", + "description": "Settings that control how partner data may be accessed." + }, + "displayName": { + "description": "The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes.", + "type": "string" + }, + "entityStatus": { + "description": "Output only. The status of the partner.", + "enum": [ + "ENTITY_STATUS_UNSPECIFIED", + "ENTITY_STATUS_ACTIVE", + "ENTITY_STATUS_ARCHIVED", + "ENTITY_STATUS_DRAFT", + "ENTITY_STATUS_PAUSED", + "ENTITY_STATUS_SCHEDULED_FOR_DELETION" + ], + "enumDescriptions": [ + "Default value when status is not specified or is unknown in this version.", + "The entity is enabled to bid and spend budget.", + "The entity is archived. Bidding and budget spending are disabled. An entity can be deleted after archived. Deleted entities cannot be retrieved.", + "The entity is under draft. Bidding and budget spending are disabled.", + "Bidding and budget spending are paused for the entity.", + "The entity is scheduled for deletion." + ], + "readOnly": true, + "type": "string" + }, + "exchangeConfig": { + "$ref": "ExchangeConfig", + "description": "Settings that control which exchanges are enabled for the partner." + }, + "generalConfig": { + "$ref": "PartnerGeneralConfig", + "description": "General settings of the partner." + }, + "name": { + "description": "Output only. The resource name of the partner.", + "readOnly": true, + "type": "string" + }, + "partnerId": { + "description": "Output only. The unique ID of the partner. Assigned by the system.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the partner was last updated. Assigned by the system.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "PartnerAdServerConfig": { + "description": "Ad server related settings of a partner.", + "id": "PartnerAdServerConfig", + "properties": { + "measurementConfig": { + "$ref": "MeasurementConfig", + "description": "Measurement settings of a partner." + } + }, + "type": "object" + }, + "PartnerBillingConfig": { + "description": "Billing related settings of a partner.", + "id": "PartnerBillingConfig", + "properties": { + "billingProfileId": { + "description": "The ID of a partner default billing profile.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "PartnerCost": { + "description": "Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.", + "id": "PartnerCost", + "properties": { + "costType": { + "description": "Required. The type of the partner cost.", + "enum": [ + "PARTNER_COST_TYPE_UNSPECIFIED", + "PARTNER_COST_TYPE_ADLOOX", + "PARTNER_COST_TYPE_ADLOOX_PREBID", + "PARTNER_COST_TYPE_ADSAFE", + "PARTNER_COST_TYPE_ADXPOSE", + "PARTNER_COST_TYPE_AGGREGATE_KNOWLEDGE", + "PARTNER_COST_TYPE_AGENCY_TRADING_DESK", + "PARTNER_COST_TYPE_DV360_FEE", + "PARTNER_COST_TYPE_COMSCORE_VCE", + "PARTNER_COST_TYPE_DATA_MANAGEMENT_PLATFORM", + "PARTNER_COST_TYPE_DEFAULT", + "PARTNER_COST_TYPE_DOUBLE_VERIFY", + "PARTNER_COST_TYPE_DOUBLE_VERIFY_PREBID", + "PARTNER_COST_TYPE_EVIDON", + "PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO", + "PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_PREBID", + "PARTNER_COST_TYPE_MEDIA_COST_DATA", + "PARTNER_COST_TYPE_MOAT_VIDEO", + "PARTNER_COST_TYPE_NIELSEN_DAR", + "PARTNER_COST_TYPE_SHOP_LOCAL", + "PARTNER_COST_TYPE_TERACENT", + "PARTNER_COST_TYPE_THIRD_PARTY_AD_SERVER", + "PARTNER_COST_TYPE_TRUST_METRICS", + "PARTNER_COST_TYPE_VIZU", + "PARTNER_COST_TYPE_ADLINGO_FEE", + "PARTNER_COST_TYPE_CUSTOM_FEE_1", + "PARTNER_COST_TYPE_CUSTOM_FEE_2", + "PARTNER_COST_TYPE_CUSTOM_FEE_3", + "PARTNER_COST_TYPE_CUSTOM_FEE_4", + "PARTNER_COST_TYPE_CUSTOM_FEE_5", + "PARTNER_COST_TYPE_SCIBIDS_FEE" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "The cost is charged for using Adloox. Billed by the partner.", + "The cost is charged for using Adloox Pre-Bid. Billed through DV360.", + "The cost is charged for using AdSafe. Billed by the partner.", + "The cost is charged for using AdExpose. Billed by the partner.", + "The cost is charged for using Aggregate Knowledge. Billed by the partner.", + "The cost is charged for using an Agency Trading Desk. Billed by the partner.", + "The cost is charged for using DV360. Billed through DV360.", + "The cost is charged for using comScore vCE. Billed through DV360.", + "The cost is charged for using a Data Management Platform. Billed by the partner.", + "The default cost type. Billed by the partner.", + "The cost is charged for using DoubleVerify. Billed by the partner.", + "The cost is charged for using DoubleVerify Pre-Bid. Billed through DV360.", + "The cost is charged for using Evidon. Billed by the partner.", + "The cost is charged for using Integral Ad Science Video. Billed by the partner.", + "The cost is charged for using Integral Ad Science Pre-Bid. Billed through DV360.", + "The cost is charged for using media cost data. Billed by the partner.", + "The cost is charged for using MOAT Video. Billed by the partner.", + "The cost is charged for using Nielsen Digital Ad Ratings. Billed through DV360.", + "The cost is charged for using ShopLocal. Billed by the partner.", + "The cost is charged for using Teracent. Billed by the partner.", + "The cost is charged for using a third-party ad server. Billed by the partner.", + "The cost is charged for using TrustMetrics. Billed by the partner.", + "The cost is charged for using Vizu. Billed by the partner.", + "The cost is charged for using AdLingo. Billed through DV360.", + "The cost is charged as custom fee 1. Billed by the partner.", + "The cost is charged as custom fee 2. Billed by the partner.", + "The cost is charged as custom fee 3. Billed by the partner.", + "The cost is charged as custom fee 4. Billed by the partner.", + "The cost is charged as custom fee 5. Billed by the partner.", + "The cost is charged for using Scibids. Billed through DV360. This type is currently only available to certain customers. Other customers attempting to use this type will receive an error." + ], + "type": "string" + }, + "feeAmount": { + "description": "The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.", + "format": "int64", + "type": "string" + }, + "feePercentageMillis": { + "description": "The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.", + "format": "int64", + "type": "string" + }, + "feeType": { + "description": "Required. The fee type for this partner cost.", + "enum": [ + "PARTNER_COST_FEE_TYPE_UNSPECIFIED", + "PARTNER_COST_FEE_TYPE_CPM_FEE", + "PARTNER_COST_FEE_TYPE_MEDIA_FEE" + ], + "enumDescriptions": [ + "Value is not specified or is unknown in this version.", + "The partner cost is a fixed CPM fee. Not applicable when the partner cost cost_type is one of: * `PARTNER_COST_TYPE_MEDIA_COST_DATA` * `PARTNER_COST_TYPE_DV360_FEE`.", + "The partner cost is a percentage surcharge based on the media cost. Not applicable when the partner cost_type is one of: * `PARTNER_COST_TYPE_SHOP_LOCAL` * `PARTNER_COST_TYPE_TRUST_METRICS` * `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE_VIDEO` * `PARTNER_COST_TYPE_MOAT_VIDEO`." + ], + "type": "string" + }, + "invoiceType": { + "description": "The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.", + "enum": [ + "PARTNER_COST_INVOICE_TYPE_UNSPECIFIED", + "PARTNER_COST_INVOICE_TYPE_DV360", + "PARTNER_COST_INVOICE_TYPE_PARTNER" + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Partner cost is billed through DV360.", + "Partner cost is billed by the partner." + ], + "type": "string" + } + }, + "type": "object" + }, + "PartnerDataAccessConfig": { + "description": "Settings that control how partner related data may be accessed.", + "id": "PartnerDataAccessConfig", + "properties": { + "sdfConfig": { + "$ref": "SdfConfig", + "description": "Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner." + } + }, + "type": "object" + }, + "PartnerGeneralConfig": { + "description": "General settings of a partner.", + "id": "PartnerGeneralConfig", + "properties": { + "currencyCode": { + "description": "Immutable. Partner's currency in ISO 4217 format.", + "type": "string" + }, + "timeZone": { + "description": "Immutable. The standard TZ database name of the partner's time zone. For example, `America/New_York`. See more at: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones", + "type": "string" + } + }, + "type": "object" + }, + "PartnerRevenueModel": { + "description": "Settings that control how partner revenue is calculated.", + "id": "PartnerRevenueModel", + "properties": { + "markupAmount": { + "description": "Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).", + "format": "int64", + "type": "string" + }, + "markupType": { + "description": "Required. The markup type of the partner revenue model.", + "enum": [ + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_UNSPECIFIED", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP", + "PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP" + ], + "enumDeprecated": [ + false, + false, + true, + false + ], + "enumDescriptions": [ + "Type value is not specified or is unknown in this version.", + "Calculate the partner revenue based on a fixed CPM.", + "Calculate the partner revenue based on a percentage surcharge of its media cost.", + "Calculate the partner revenue based on a percentage surcharge of its total media cost, which includes all partner costs and data costs." + ], + "type": "string" + } + }, + "type": "object" + }, + "PerformanceGoal": { + "description": "Settings that control the performance goal of a campaign.", + "id": "PerformanceGoal", + "properties": { + "performanceGoalAmountMicros": { + "description": "The goal amount, in micros of the advertiser's currency. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CPM` * `PERFORMANCE_GOAL_TYPE_CPC` * `PERFORMANCE_GOAL_TYPE_CPA` * `PERFORMANCE_GOAL_TYPE_CPIAVC` * `PERFORMANCE_GOAL_TYPE_VCPM` For example 1500000 represents 1.5 standard units of the currency.", + "format": "int64", + "type": "string" + }, + "performanceGoalPercentageMicros": { + "description": "The decimal representation of the goal percentage in micros. Applicable when performance_goal_type is one of: * `PERFORMANCE_GOAL_TYPE_CTR` * `PERFORMANCE_GOAL_TYPE_VIEWABILITY` * `PERFORMANCE_GOAL_TYPE_CLICK_CVR` * `PERFORMANCE_GOAL_TYPE_IMPRESSION_CVR` * `PERFORMANCE_GOAL_TYPE_VTR` * `PERFORMANCE_GOAL_TYPE_AUDIO_COMPLETION_RATE` * `PERFORMANCE_GOAL_TYPE_VIDEO_COMPLETION_RATE` For example, 70000 represents 7% (decimal 0.07).", + "format": "int64", + "type": "string" + }, + "performanceGoalString": { + "description": "A key performance indicator (KPI) string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when performance_goal_type is set to `PERFORMANCE_GOAL_TYPE_OTHER`.", + "type": "string" + }, + "performanceGoalType": { + "description": "Required. The type of the performance goal.", + "enum": [ + "PERFORMANCE_GOAL_TYPE_UNSPECIFIED", + "PERFORMANCE_GOAL_TYPE_CPM", + "PERFORMANCE_GOAL_TYPE_CPC", + "PERFORMANCE_GOAL_TYPE_CPA", + "PERFORMANCE_GOAL_TYPE_CTR", + "PERFORMANCE_GOAL_TYPE_VIEWABILITY", + "PERFORMANCE_GOAL_TYPE_CPIAVC", + "PERFORMANCE_GOAL_TYPE_CPE", + "PERFORMANCE_GOAL_TYPE_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" + }, + "ProductFeedData": { + "description": "The details of product feed.", + "id": "ProductFeedData", + "properties": { + "isFeedDisabled": { + "description": "Whether the product feed has opted-out of showing products.", + "type": "boolean" + }, + "productMatchDimensions": { + "description": "A list of dimensions used to match products.", + "items": { + "$ref": "ProductMatchDimension" + }, + "type": "array" + }, + "productMatchType": { + "description": "How products are selected by the product feed.", + "enum": [ + "PRODUCT_MATCH_TYPE_UNSPECIFIED", + "PRODUCT_MATCH_TYPE_ALL_PRODUCTS", + "PRODUCT_MATCH_TYPE_SPECIFIC_PRODUCTS", + "PRODUCT_MATCH_TYPE_CUSTOM_LABEL" + ], + "enumDescriptions": [ + "Not specified or unknown.", + "All the products are matched.", + "Specific products are selected.", + "Match products by their custom labels." + ], + "type": "string" + } + }, + "type": "object" + }, + "ProductMatchDimension": { + "description": "A dimension used to match products.", + "id": "ProductMatchDimension", + "properties": { + "customLabel": { + "$ref": "CustomLabel", + "description": "The custom label to match all the products with the label." + }, + "productOfferId": { + "description": "The ID of the product offer to match with a product with the same offer ID.", + "type": "string" + } + }, + "type": "object" + }, + "ProximityLocationListAssignedTargetingOptionDetails": { + "description": "Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.", + "id": "ProximityLocationListAssignedTargetingOptionDetails", + "properties": { + "proximityLocationListId": { + "description": "Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.", + "format": "int64", + "type": "string" + }, + "proximityRadius": { + "description": "Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.", + "format": "double", + "type": "number" + }, + "proximityRadiusUnit": { + "description": "Required. Radius distance units.", + "enum": [ + "PROXIMITY_RADIUS_UNIT_UNSPECIFIED", + "PROXIMITY_RADIUS_UNIT_MILES", + "PROXIMITY_RADIUS_UNIT_KILOMETERS" + ], + "enumDescriptions": [ + "Default value when distance units is not specified in this version. This enum is a place holder for default value and does not represent a real distance unit.", + "Radius distance unit in miles.", + "Radius distance unit in kilometeres" + ], + "type": "string" + } + }, + "type": "object" + }, + "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", + "SDF_VERSION_6" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6" + ], + "type": "string" + } + }, + "type": "object" + }, + "SdfDownloadTask": { + "description": "Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "SdfDownloadTask", + "properties": { + "resourceName": { + "description": "A resource name to be used in media.download to Download the prepared files. Resource names have the format `download/sdfdownloadtasks/media/{media_id}`. `media_id` will be made available by the long running operation service once the task status is done.", + "type": "string" + } + }, + "type": "object" + }, + "SdfDownloadTaskMetadata": { + "description": "Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask].", + "id": "SdfDownloadTaskMetadata", + "properties": { + "createTime": { + "description": "The time when the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time when execution was completed.", + "format": "google-datetime", + "type": "string" + }, + "version": { + "description": "The SDF version used to execute this download task.", + "enum": [ + "SDF_VERSION_UNSPECIFIED", + "SDF_VERSION_3_1", + "SDF_VERSION_4", + "SDF_VERSION_4_1", + "SDF_VERSION_4_2", + "SDF_VERSION_5", + "SDF_VERSION_5_1", + "SDF_VERSION_5_2", + "SDF_VERSION_5_3", + "SDF_VERSION_5_4", + "SDF_VERSION_5_5", + "SDF_VERSION_6" + ], + "enumDeprecated": [ + false, + true, + true, + true, + true, + true, + true, + true, + true, + false, + false, + false + ], + "enumDescriptions": [ + "SDF version value is not specified or is unknown in this version.", + "SDF version 3.1", + "SDF version 4", + "SDF version 4.1", + "SDF version 4.2", + "SDF version 5.", + "SDF version 5.1", + "SDF version 5.2", + "SDF version 5.3", + "SDF version 5.4", + "SDF version 5.5", + "SDF version 6" + ], + "type": "string" + } + }, + "type": "object" + }, + "SearchTargetingOptionsRequest": { + "description": "Request message for SearchTargetingOptions.", + "id": "SearchTargetingOptionsRequest", + "properties": { + "advertiserId": { + "description": "Required. The Advertiser this request is being made in the context of.", + "format": "int64", + "type": "string" + }, + "businessChainSearchTerms": { + "$ref": "BusinessChainSearchTerms", + "description": "Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`." + }, + "geoRegionSearchTerms": { + "$ref": "GeoRegionSearchTerms", + "description": "Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`." + }, + "pageSize": { + "description": "Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `SearchTargetingOptions` method. If not specified, the first page of results will be returned.", + "type": "string" + }, + "poiSearchTerms": { + "$ref": "PoiSearchTerms", + "description": "Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`." + } + }, + "type": "object" + }, + "SearchTargetingOptionsResponse": { + "description": "Response message for SearchTargetingOptions.", + "id": "SearchTargetingOptionsResponse", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `SearchTargetingOptions` method to retrieve the next page of results.", + "type": "string" + }, + "targetingOptions": { + "description": "The list of targeting options that match the search criteria. This list will be absent if empty.", + "items": { + "$ref": "TargetingOption" + }, + "type": "array" + } + }, + "type": "object" + }, + "SensitiveCategoryAssignedTargetingOptionDetails": { + "description": "Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`.", + "id": "SensitiveCategoryAssignedTargetingOptionDetails", + "properties": { + "excludedSensitiveCategory": { + "description": "Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.", + "enum": [ + "SENSITIVE_CATEGORY_UNSPECIFIED", + "SENSITIVE_CATEGORY_ADULT", + "SENSITIVE_CATEGORY_DEROGATORY", + "SENSITIVE_CATEGORY_DOWNLOADS_SHARING", + "SENSITIVE_CATEGORY_WEAPONS", + "SENSITIVE_CATEGORY_GAMBLING", + "SENSITIVE_CATEGORY_VIOLENCE", + "SENSITIVE_CATEGORY_SUGGESTIVE", + "SENSITIVE_CATEGORY_PROFANITY", + "SENSITIVE_CATEGORY_ALCOHOL", + "SENSITIVE_CATEGORY_DRUGS", + "SENSITIVE_CATEGORY_TOBACCO", + "SENSITIVE_CATEGORY_POLITICS", + "SENSITIVE_CATEGORY_RELIGION", + "SENSITIVE_CATEGORY_TRAGEDY", + "SENSITIVE_CATEGORY_TRANSPORTATION_ACCIDENTS", + "SENSITIVE_CATEGORY_SENSITIVE_SOCIAL_ISSUES", + "SENSITIVE_CATEGORY_SHOCKING", + "SENSITIVE_CATEGORY_EMBEDDED_VIDEO", + "SENSITIVE_CATEGORY_LIVE_STREAMING_VIDEO" + ], + "enumDescriptions": [ + "This enum is only a placeholder and doesn't specify a DV360 sensitive category.", + "Adult or pornographic text, image, or video content.", + "Content that may be construed as biased against individuals, groups, or organizations based on criteria such as race, religion, disability, sex, age, veteran status, sexual orientation, gender identity, or political affiliation. May also indicate discussion of such content, for instance, in an academic or journalistic context.", + "Content related to audio, video, or software downloads.", + "Contains content related to personal weapons, including knives, guns, small firearms, and ammunition. Selecting either \"weapons\" or \"sensitive social issues\" will result in selecting both.", + "Contains content related to betting or wagering in a real-world or online setting.", + "Content which may be considered graphically violent, gory, gruesome, or shocking, such as street fighting videos, accident photos, descriptions of torture, etc.", + "Adult content, as well as suggestive content that's not explicitly pornographic. This category includes all pages categorized as adult.", + "Prominent use of words considered indecent, such as curse words and sexual slang. Pages with only very occasional usage, such as news sites that might include such words in a quotation, are not included.", + "Contains content related to alcoholic beverages, alcohol brands, recipes, etc.", + "Contains content related to the recreational use of legal or illegal drugs, as well as to drug paraphernalia or cultivation.", + "Contains content related to tobacco and tobacco accessories, including lighters, humidors, ashtrays, etc.", + "Political news and media, including discussions of social, governmental, and public policy.", + "Content related to religious thought or beliefs.", + "Content related to death, disasters, accidents, war, etc.", + "Content related to motor vehicle, aviation or other transportation accidents.", + "Issues that evoke strong, opposing views and spark debate. These include issues that are controversial in most countries and markets (such as abortion), as well as those that are controversial in specific countries and markets (such as immigration reform in the United States).", + "Content which may be considered shocking or disturbing, such as violent news stories, stunts, or toilet humor.", + "YouTube videos embedded on websites outside of YouTube.com. 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" + }, + "SessionPositionAssignedTargetingOptionDetails": { + "description": "Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`.", + "id": "SessionPositionAssignedTargetingOptionDetails", + "properties": { + "sessionPosition": { + "description": "The position where the ad will show in a session.", + "enum": [ + "SESSION_POSITION_UNSPECIFIED", + "SESSION_POSITION_FIRST_IMPRESSION" + ], + "enumDescriptions": [ + "This is a placeholder, does not indicate any positions.", + "The first impression of the session." + ], + "type": "string" + } + }, + "type": "object" + }, + "Site": { + "description": "A single site. Sites are apps or websites belonging to a channel.", + "id": "Site", + "properties": { + "name": { + "description": "Output only. The resource name of the site.", + "readOnly": true, + "type": "string" + }, + "urlOrAppId": { + "description": "Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", + "id": "Status", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + }, + "type": "array" + }, + "message": { + "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" + }, + "SubExchangeAssignedTargetingOptionDetails": { + "description": "Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", + "id": "SubExchangeAssignedTargetingOptionDetails", + "properties": { + "targetingOptionId": { + "description": "Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.", + "type": "string" + } + }, + "type": "object" + }, + "SubExchangeTargetingOptionDetails": { + "description": "Represents a targetable sub-exchange. This will be populated in the sub_exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.", + "id": "SubExchangeTargetingOptionDetails", + "properties": { + "displayName": { + "description": "Output only. The display name of the sub-exchange.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "TargetFrequency": { + "description": "Setting that controls the average number of times the ads will show to the same person over a certain period of time.", + "id": "TargetFrequency", + "properties": { + "targetCount": { + "description": "The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.", + "format": "int64", + "type": "string" + }, + "timeUnit": { + "description": "The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`", + "enum": [ + "TIME_UNIT_UNSPECIFIED", + "TIME_UNIT_LIFETIME", + "TIME_UNIT_MONTHS", + "TIME_UNIT_WEEKS", + "TIME_UNIT_DAYS", + "TIME_UNIT_HOURS", + "TIME_UNIT_MINUTES" + ], + "enumDescriptions": [ + "Time unit value is not specified or is unknown in this version.", + "The frequency cap will be applied to the whole life time of the line item.", + "The frequency cap will be applied to a number of months.", + "The frequency cap will be applied to a number of weeks.", + "The frequency cap will be applied to a number of days.", + "The frequency cap will be applied to a number of hours.", + "The frequency cap will be applied to a number of minutes." + ], + "type": "string" + }, + "timeUnitCount": { + "description": "The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "TargetingExpansionConfig": { + "description": "Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item.", + "id": "TargetingExpansionConfig", + "properties": { + "audienceExpansionLevel": { + "description": "Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.", + "enum": [ + "UNKNOWN", + "NO_REACH", + "LEAST_REACH", + "MID_REACH", + "MOST_REACH" + ], + "enumDescriptions": [ + "Audience expansion level is not specified or is unknown in this version.", + "Audience expansion off.", + "Conservative audience expansion.", + "Moderate audience expansion.", + "Aggressive audience expansion." + ], + "readOnly": true, + "type": "string" + }, + "audienceExpansionSeedListExcluded": { + "description": "Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.", + "readOnly": true, + "type": "boolean" + }, + "enableOptimizedTargeting": { + "description": "Required. Whether to enable Optimized Targeting for the line item.", + "type": "boolean" + } + }, + "type": "object" + }, + "TargetingOption": { + "description": "Represents a single targeting option, which is a targetable concept in DV360.", + "id": "TargetingOption", + "properties": { + "ageRangeDetails": { + "$ref": "AgeRangeTargetingOptionDetails", + "description": "Age range details." + }, + "appCategoryDetails": { + "$ref": "AppCategoryTargetingOptionDetails", + "description": "App category details." + }, + "audioContentTypeDetails": { + "$ref": "AudioContentTypeTargetingOptionDetails", + "description": "Audio content type details." + }, + "authorizedSellerStatusDetails": { + "$ref": "AuthorizedSellerStatusTargetingOptionDetails", + "description": "Authorized seller status resource details." + }, + "browserDetails": { + "$ref": "BrowserTargetingOptionDetails", + "description": "Browser details." + }, + "businessChainDetails": { + "$ref": "BusinessChainTargetingOptionDetails", + "description": "Business chain resource details." + }, + "carrierAndIspDetails": { + "$ref": "CarrierAndIspTargetingOptionDetails", + "description": "Carrier and ISP details." + }, + "categoryDetails": { + "$ref": "CategoryTargetingOptionDetails", + "description": "Category resource details." + }, + "contentDurationDetails": { + "$ref": "ContentDurationTargetingOptionDetails", + "description": "Content duration resource details." + }, + "contentGenreDetails": { + "$ref": "ContentGenreTargetingOptionDetails", + "description": "Content genre resource details." + }, + "contentInstreamPositionDetails": { + "$ref": "ContentInstreamPositionTargetingOptionDetails", + "description": "Content instream position details." + }, + "contentOutstreamPositionDetails": { + "$ref": "ContentOutstreamPositionTargetingOptionDetails", + "description": "Content outstream position details." + }, + "contentStreamTypeDetails": { + "$ref": "ContentStreamTypeTargetingOptionDetails", + "description": "Content stream type resource details." + }, + "deviceMakeModelDetails": { + "$ref": "DeviceMakeModelTargetingOptionDetails", + "description": "Device make and model resource details." + }, + "deviceTypeDetails": { + "$ref": "DeviceTypeTargetingOptionDetails", + "description": "Device type details." + }, + "digitalContentLabelDetails": { + "$ref": "DigitalContentLabelTargetingOptionDetails", + "description": "Digital content label details." + }, + "environmentDetails": { + "$ref": "EnvironmentTargetingOptionDetails", + "description": "Environment details." + }, + "exchangeDetails": { + "$ref": "ExchangeTargetingOptionDetails", + "description": "Exchange details." + }, + "genderDetails": { + "$ref": "GenderTargetingOptionDetails", + "description": "Gender details." + }, + "geoRegionDetails": { + "$ref": "GeoRegionTargetingOptionDetails", + "description": "Geographic region resource details." + }, + "householdIncomeDetails": { + "$ref": "HouseholdIncomeTargetingOptionDetails", + "description": "Household income details." + }, + "languageDetails": { + "$ref": "LanguageTargetingOptionDetails", + "description": "Language resource details." + }, + "name": { + "description": "Output only. The resource name for this targeting option.", + "readOnly": true, + "type": "string" + }, + "nativeContentPositionDetails": { + "$ref": "NativeContentPositionTargetingOptionDetails", + "description": "Native content position details." + }, + "omidDetails": { + "$ref": "OmidTargetingOptionDetails", + "description": "Open Measurement enabled inventory details." + }, + "onScreenPositionDetails": { + "$ref": "OnScreenPositionTargetingOptionDetails", + "description": "On screen position details." + }, + "operatingSystemDetails": { + "$ref": "OperatingSystemTargetingOptionDetails", + "description": "Operating system resources details." + }, + "parentalStatusDetails": { + "$ref": "ParentalStatusTargetingOptionDetails", + "description": "Parental status details." + }, + "poiDetails": { + "$ref": "PoiTargetingOptionDetails", + "description": "POI resource details." + }, + "sensitiveCategoryDetails": { + "$ref": "SensitiveCategoryTargetingOptionDetails", + "description": "Sensitive Category details." + }, + "subExchangeDetails": { + "$ref": "SubExchangeTargetingOptionDetails", + "description": "Sub-exchange details." + }, + "targetingOptionId": { + "description": "Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`} will be unique.", + "readOnly": true, + "type": "string" + }, + "targetingType": { + "description": "Output only. The type of this targeting option.", + "enum": [ + "TARGETING_TYPE_UNSPECIFIED", + "TARGETING_TYPE_CHANNEL", + "TARGETING_TYPE_APP_CATEGORY", + "TARGETING_TYPE_APP", + "TARGETING_TYPE_URL", + "TARGETING_TYPE_DAY_AND_TIME", + "TARGETING_TYPE_AGE_RANGE", + "TARGETING_TYPE_REGIONAL_LOCATION_LIST", + "TARGETING_TYPE_PROXIMITY_LOCATION_LIST", + "TARGETING_TYPE_GENDER", + "TARGETING_TYPE_VIDEO_PLAYER_SIZE", + "TARGETING_TYPE_USER_REWARDED_CONTENT", + "TARGETING_TYPE_PARENTAL_STATUS", + "TARGETING_TYPE_CONTENT_INSTREAM_POSITION", + "TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION", + "TARGETING_TYPE_DEVICE_TYPE", + "TARGETING_TYPE_AUDIENCE_GROUP", + "TARGETING_TYPE_BROWSER", + "TARGETING_TYPE_HOUSEHOLD_INCOME", + "TARGETING_TYPE_ON_SCREEN_POSITION", + "TARGETING_TYPE_THIRD_PARTY_VERIFIER", + "TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION", + "TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION", + "TARGETING_TYPE_ENVIRONMENT", + "TARGETING_TYPE_CARRIER_AND_ISP", + "TARGETING_TYPE_OPERATING_SYSTEM", + "TARGETING_TYPE_DEVICE_MAKE_MODEL", + "TARGETING_TYPE_KEYWORD", + "TARGETING_TYPE_NEGATIVE_KEYWORD_LIST", + "TARGETING_TYPE_VIEWABILITY", + "TARGETING_TYPE_CATEGORY", + "TARGETING_TYPE_INVENTORY_SOURCE", + "TARGETING_TYPE_LANGUAGE", + "TARGETING_TYPE_AUTHORIZED_SELLER_STATUS", + "TARGETING_TYPE_GEO_REGION", + "TARGETING_TYPE_INVENTORY_SOURCE_GROUP", + "TARGETING_TYPE_EXCHANGE", + "TARGETING_TYPE_SUB_EXCHANGE", + "TARGETING_TYPE_POI", + "TARGETING_TYPE_BUSINESS_CHAIN", + "TARGETING_TYPE_CONTENT_DURATION", + "TARGETING_TYPE_CONTENT_STREAM_TYPE", + "TARGETING_TYPE_NATIVE_CONTENT_POSITION", + "TARGETING_TYPE_OMID", + "TARGETING_TYPE_AUDIO_CONTENT_TYPE", + "TARGETING_TYPE_CONTENT_GENRE", + "TARGETING_TYPE_YOUTUBE_VIDEO", + "TARGETING_TYPE_YOUTUBE_CHANNEL", + "TARGETING_TYPE_SESSION_POSITION" + ], + "enumDescriptions": [ + "Default value when type is not specified or is unknown in this version.", + "Target a channel (a custom group of related websites or apps).", + "Target an app category (for example, education or puzzle games).", + "Target a specific app (for example, Angry Birds).", + "Target a specific url (for example, quora.com).", + "Target ads during a chosen time period on a specific day.", + "Target ads to a specific age range (for example, 18-24).", + "Target ads to the specified regions on a regional location list.", + "Target ads to the specified points of interest on a proximity location list.", + "Target ads to a specific gender (for example, female or male).", + "Target a specific video player size for video ads.", + "Target user rewarded content for video ads.", + "Target ads to a specific parental status (for example, parent or not a parent).", + "Target video or audio ads in a specific content instream position (for example, pre-roll, mid-roll, or post-roll).", + "Target ads in a specific content outstream position.", + "Target ads to a specific device type (for example, tablet or connected TV).", + "Target ads to an audience or groups of audiences. Singleton field, at most one can exist on a single Lineitem at a time.", + "Target ads to specific web browsers (for example, Chrome).", + "Target ads to a specific household income range (for example, top 10%).", + "Target ads in a specific on screen position.", + "Filter web sites through third party verification (for example, IAS or DoubleVerify).", + "Filter web sites by specific digital content label ratings (for example, DL-MA: suitable only for mature audiences).", + "Filter website content by sensitive categories (for example, adult).", + "Target ads to a specific environment (for example, web or app).", + "Target ads to a specific network carrier or internet service provider (ISP) (for example, Comcast or Orange).", + "Target ads to a specific operating system (for example, macOS).", + "Target ads to a specific device make or model (for example, Roku or Samsung).", + "Target ads to a specific keyword (for example, dog or retriever).", + "Target ads to a specific negative keyword list.", + "Target ads to a specific viewability (for example, 80% viewable).", + "Target ads to a specific content category (for example, arts & entertainment).", + "Purchase impressions from specific deals and auction packages.", + "Target ads to a specific language (for example, English or Japanese).", + "Target ads to ads.txt authorized sellers. If no targeting option of this type is assigned, the resource uses the \"Authorized Direct Sellers and Resellers\" option by default.", + "Target ads to a specific regional location (for example, a city or state).", + "Purchase impressions from a group of deals and auction packages.", + "Purchase impressions from specific exchanges.", + "Purchase impressions from specific sub-exchanges.", + "Target ads around a specific point of interest, such as a notable building, a street address, or latitude/longitude coordinates.", + "Target ads around locations of a business chain within a specific geo region.", + "Target ads to a specific video content duration.", + "Target ads to a specific video content stream type.", + "Target ads to a specific native content position.", + "Target ads in an Open Measurement enabled inventory.", + "Target ads to a specific audio content type.", + "Target ads to a specific content genre.", + "Target ads to a specific YouTube video. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a specific YouTube channel. Targeting of this type cannot be created or updated using the API. Although this targeting is inherited by child resources, **inherited targeting of this type will not be retrieveable**.", + "Target ads to a serve it in a certain position of a session. Only supported for Ad Group resources under YouTube Programmatic Reservation line items. Targeting of this type cannot be created or updated using the API." + ], + "readOnly": true, + "type": "string" + }, + "userRewardedContentDetails": { + "$ref": "UserRewardedContentTargetingOptionDetails", + "description": "User rewarded content details." + }, + "videoPlayerSizeDetails": { + "$ref": "VideoPlayerSizeTargetingOptionDetails", + "description": "Video player size details." + }, + "viewabilityDetails": { + "$ref": "ViewabilityTargetingOptionDetails", + "description": "Viewability resource details." + } + }, + "type": "object" + }, + "ThirdPartyMeasurementConfigs": { + "description": "Settings that control what third-party vendors are measuring specific line item metrics.", + "id": "ThirdPartyMeasurementConfigs", + "properties": { + "brandLiftVendorConfigs": { + "description": "Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "brandSafetyVendorConfigs": { + "description": "Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "reachVendorConfigs": { + "description": "Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + }, + "viewabilityVendorConfigs": { + "description": "Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS`", + "items": { + "$ref": "ThirdPartyVendorConfig" + }, + "type": "array" + } + }, + "type": "object" + }, + "ThirdPartyOnlyConfig": { + "description": "Settings for advertisers that use third-party ad servers only.", + "id": "ThirdPartyOnlyConfig", + "properties": { + "pixelOrderIdReportingEnabled": { + "description": "Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`.", + "type": "boolean" + } + }, + "type": "object" + }, + "ThirdPartyUrl": { + "description": "Tracking URLs from third parties to track interactions with an audio or a video creative.", + "id": "ThirdPartyUrl", + "properties": { + "type": { + "description": "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" + }, + "VideoAdSequenceSettings": { + "description": "Settings related to VideoAdSequence.", + "id": "VideoAdSequenceSettings", + "properties": { + "minimumDuration": { + "description": "The minimum time interval before the same user sees this sequence again.", + "enum": [ + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_UNSPECIFIED", + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_WEEK", + "VIDEO_AD_SEQUENCE_MINIMUM_DURATION_MONTH" + ], + "enumDescriptions": [ + "Unspecified or unknown.", + "7 days.", + "30 days." + ], + "type": "string" + }, + "steps": { + "description": "The steps of which the sequence consists.", + "items": { + "$ref": "VideoAdSequenceStep" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoAdSequenceStep": { + "description": "The detail of a single step in a VideoAdSequence.", + "id": "VideoAdSequenceStep", + "properties": { + "adGroupId": { + "description": "The ID of the corresponding ad group of the step.", + "format": "int64", + "type": "string" + }, + "interactionType": { + "description": "The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.", + "enum": [ + "INTERACTION_TYPE_UNSPECIFIED", + "INTERACTION_TYPE_PAID_VIEW", + "INTERACTION_TYPE_SKIP", + "INTERACTION_TYPE_IMPRESSION", + "INTERACTION_TYPE_ENGAGED_IMPRESSION" + ], + "enumDescriptions": [ + "Unspecified or unknown", + "A paid view.", + "Skipped by the viewer.", + "A (viewed) ad impression.", + "An ad impression that was not immediately skipped by the viewer, but didn't reach the billable event either." + ], + "type": "string" + }, + "previousStepId": { + "description": "The ID of the previous step. The first step does not have previous step.", + "format": "int64", + "type": "string" + }, + "stepId": { + "description": "The ID of the step.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "VideoDiscoveryAd": { + "description": "Details for a video discovery ad.", + "id": "VideoDiscoveryAd", + "properties": { + "description1": { + "description": "First text line for the ad.", + "type": "string" + }, + "description2": { + "description": "Second text line for the ad.", + "type": "string" + }, + "headline": { + "description": "The headline of ad.", + "type": "string" + }, + "thumbnail": { + "description": "Thumbnail image used in the ad.", + "enum": [ + "THUMBNAIL_UNSPECIFIED", + "THUMBNAIL_DEFAULT", + "THUMBNAIL_1", + "THUMBNAIL_2", + "THUMBNAIL_3" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "The default thumbnail, can be auto-generated or user-uploaded.", + "Thumbnail 1, generated from the video.", + "Thumbnail 2, generated from the video.", + "Thumbnail 3, generated from the video." + ], + "type": "string" + }, + "video": { + "$ref": "YoutubeVideoDetails", + "description": "The YouTube video the ad promotes." + } + }, + "type": "object" + }, + "VideoPerformanceAd": { + "description": "Details for a video performance ad.", + "id": "VideoPerformanceAd", + "properties": { + "actionButtonLabels": { + "description": "The list of text assets shown on the call-to-action button.", + "items": { + "type": "string" + }, + "type": "array" + }, + "companionBanners": { + "description": "The list of companion banners used by this ad.", + "items": { + "$ref": "ImageAsset" + }, + "type": "array" + }, + "customParameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The custom parameters to pass custom values to tracking URL template.", + "type": "object" + }, + "descriptions": { + "description": "The list of descriptions shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayUrlBreadcrumb1": { + "description": "The first piece after the domain in the display URL.", + "type": "string" + }, + "displayUrlBreadcrumb2": { + "description": "The second piece after the domain in the display URL.", + "type": "string" + }, + "domain": { + "description": "The domain of the display URL.", + "type": "string" + }, + "finalUrl": { + "description": "The URL address of the webpage that people reach after they click the ad.", + "type": "string" + }, + "headlines": { + "description": "The list of headlines shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "longHeadlines": { + "description": "The list of lone headlines shown on the call-to-action banner.", + "items": { + "type": "string" + }, + "type": "array" + }, + "trackingUrl": { + "description": "The URL address loaded in the background for tracking purposes.", + "type": "string" + }, + "videos": { + "description": "The list of YouTube video assets used by this ad.", + "items": { + "$ref": "YoutubeVideoDetails" + }, + "type": "array" + } + }, + "type": "object" + }, + "VideoPlayerSizeAssignedTargetingOptionDetails": { + "description": "Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect.", + "id": "VideoPlayerSizeAssignedTargetingOptionDetails", + "properties": { + "videoPlayerSize": { + "description": "Required. The video player size.", + "enum": [ + "VIDEO_PLAYER_SIZE_UNSPECIFIED", + "VIDEO_PLAYER_SIZE_SMALL", + "VIDEO_PLAYER_SIZE_LARGE", + "VIDEO_PLAYER_SIZE_HD", + "VIDEO_PLAYER_SIZE_UNKNOWN" + ], + "enumDescriptions": [ + "Video player size is not specified in this version. This enum is a place holder for a default value and does not represent a real video player size.", + "The dimensions of the video player are less than 400×300 (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×720 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×300 (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×720 or greater (desktop), or over 90% of the screen covered (mobile).", + "The dimensions of the video player are unknown." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ViewabilityAssignedTargetingOptionDetails": { + "description": "Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", + "id": "ViewabilityAssignedTargetingOptionDetails", + "properties": { + "viewability": { + "description": "Required. The predicted viewability percentage.", + "enum": [ + "VIEWABILITY_UNSPECIFIED", + "VIEWABILITY_10_PERCENT_OR_MORE", + "VIEWABILITY_20_PERCENT_OR_MORE", + "VIEWABILITY_30_PERCENT_OR_MORE", + "VIEWABILITY_40_PERCENT_OR_MORE", + "VIEWABILITY_50_PERCENT_OR_MORE", + "VIEWABILITY_60_PERCENT_OR_MORE", + "VIEWABILITY_70_PERCENT_OR_MORE", + "VIEWABILITY_80_PERCENT_OR_MORE", + "VIEWABILITY_90_PERCENT_OR_MORE" + ], + "enumDescriptions": [ + "Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", + "Bid only on impressions that are at least 10% likely to be viewable.", + "Bid only on impressions that are at least 20% likely to be viewable.", + "Bid only on impressions that are at least 30% likely to be viewable.", + "Bid only on impressions that are at least 40% likely to be viewable.", + "Bid only on impressions that are at least 50% likely to be viewable.", + "Bid only on impressions that are at least 60% likely to be viewable.", + "Bid only on impressions that are at least 70% likely to be viewable.", + "Bid only on impressions that are at least 80% likely to be viewable.", + "Bid only on impressions that are at least 90% likely to be viewable." + ], + "type": "string" + } + }, + "type": "object" + }, + "ViewabilityTargetingOptionDetails": { + "description": "Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`.", + "id": "ViewabilityTargetingOptionDetails", + "properties": { + "viewability": { + "description": "Output only. The predicted viewability percentage.", + "enum": [ + "VIEWABILITY_UNSPECIFIED", + "VIEWABILITY_10_PERCENT_OR_MORE", + "VIEWABILITY_20_PERCENT_OR_MORE", + "VIEWABILITY_30_PERCENT_OR_MORE", + "VIEWABILITY_40_PERCENT_OR_MORE", + "VIEWABILITY_50_PERCENT_OR_MORE", + "VIEWABILITY_60_PERCENT_OR_MORE", + "VIEWABILITY_70_PERCENT_OR_MORE", + "VIEWABILITY_80_PERCENT_OR_MORE", + "VIEWABILITY_90_PERCENT_OR_MORE" + ], + "enumDescriptions": [ + "Default value when viewability is not specified in this version. This enum is a placeholder for default value and does not represent a real viewability option.", + "Bid only on impressions that are at least 10% likely to be viewable.", + "Bid only on impressions that are at least 20% likely to be viewable.", + "Bid only on impressions that are at least 30% likely to be viewable.", + "Bid only on impressions that are at least 40% likely to be viewable.", + "Bid only on impressions that are at least 50% likely to be viewable.", + "Bid only on impressions that are at least 60% likely to be viewable.", + "Bid only on impressions that are at least 70% likely to be viewable.", + "Bid only on impressions that are at least 80% likely to be viewable.", + "Bid only on impressions that are at least 90% likely to be viewable." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAndPartnersBiddingStrategy": { + "description": "Settings that control the bid strategy for YouTube and Partners resources.", + "id": "YoutubeAndPartnersBiddingStrategy", + "properties": { + "adGroupEffectiveTargetCpaSource": { + "description": "Output only. Source of the effective target CPA value for ad group.", + "enum": [ + "BIDDING_SOURCE_UNSPECIFIED", + "BIDDING_SOURCE_LINE_ITEM", + "BIDDING_SOURCE_AD_GROUP" + ], + "enumDescriptions": [ + "Bidding source is not specified or unknown.", + "Bidding value is inherited from the line item.", + "Bidding value is defined in the ad group." + ], + "readOnly": true, + "type": "string" + }, + "adGroupEffectiveTargetCpaValue": { + "description": "Output only. The effective target CPA for ad group, in micros of advertiser's currency.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the bidding strategy.", + "enum": [ + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_LIFT", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSIONS", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPV", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS", + "YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MAXIMIZE_CONVERSION_VALUE" + ], + "enumDescriptions": [ + "Type is not specified or unknown.", + "A bidding strategy that pays a configurable amount per video view.", + "A bidding strategy that pays a configurable amount per impression.", + "A bidding strategy that automatically optimizes conversions per dollar.", + "A bidding strategy that pays a configurable amount per impression.", + "An automated bidding strategy that sets bids to achieve maximum lift.", + "A bidding strategy that automatically maximizes number of conversions given a daily budget.", + "A bidding strategy that automatically optimizes cost per video view.", + "A bidding strategy that automatically maximizes revenue while averaging a specific target Return On Ad Spend (ROAS).", + "A bidding strategy that automatically sets bids to maximize revenue while spending your budget." + ], + "type": "string" + }, + "value": { + "description": "The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "YoutubeAndPartnersInventorySourceConfig": { + "description": "Settings that control what YouTube related inventories the YouTube and Partners line item will target.", + "id": "YoutubeAndPartnersInventorySourceConfig", + "properties": { + "includeYoutube": { + "description": "Whether to target inventory on YouTube. This includes both search, channels and videos.", + "type": "boolean" + }, + "includeYoutubeVideoPartners": { + "description": "Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.", + "type": "boolean" + } + }, + "type": "object" + }, + "YoutubeAndPartnersSettings": { + "description": "Settings for YouTube and Partners line items.", + "id": "YoutubeAndPartnersSettings", + "properties": { + "contentCategory": { + "description": "The kind of content on which the YouTube and Partners ads will be shown.", + "enum": [ + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" + ], + "enumDescriptions": [ + "Content category is not specified or is unknown in this version.", + "A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", + "A category including all content across YouTube and video partners that meets standards for monetization.", + "A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." + ], + "type": "string" + }, + "effectiveContentCategory": { + "description": "Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item.", + "enum": [ + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_UNSPECIFIED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_STANDARD", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_EXPANDED", + "YOUTUBE_AND_PARTNERS_CONTENT_CATEGORY_LIMITED" + ], + "enumDescriptions": [ + "Content category is not specified or is unknown in this version.", + "A category consisting of a wide range of content appropriate for most brands. The content is based off of YouTube's [advertiser-friendly content guidelines](https://support.google.com/youtube/answer/6162278).", + "A category including all content across YouTube and video partners that meets standards for monetization.", + "A category consisting of a reduced range of content that meets heightened requirements, especially regarding inappropriate language and sexual suggestiveness." + ], + "readOnly": true, + "type": "string" + }, + "inventorySourceSettings": { + "$ref": "YoutubeAndPartnersInventorySourceConfig", + "description": "Settings that control what YouTube and Partners inventories the line item will target." + }, + "leadFormId": { + "description": "The ID of the form to generate leads.", + "format": "int64", + "type": "string" + }, + "linkedMerchantId": { + "description": "The ID of the merchant which is linked to the line item for product feed.", + "format": "int64", + "type": "string" + }, + "relatedVideoIds": { + "description": "The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.", + "items": { + "type": "string" + }, + "type": "array" + }, + "targetFrequency": { + "$ref": "TargetFrequency", + "description": "The average number of times you want ads from this line item to show to the same person over a certain period of time." + }, + "thirdPartyMeasurementConfigs": { + "$ref": "ThirdPartyMeasurementConfigs", + "description": "Optional. The third-party measurement configs of the line item." + }, + "videoAdSequenceSettings": { + "$ref": "VideoAdSequenceSettings", + "description": "The settings related to VideoAdSequence." + }, + "viewFrequencyCap": { + "$ref": "FrequencyCap", + "description": "The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap." + } + }, + "type": "object" + }, + "YoutubeChannelAssignedTargetingOptionDetails": { + "description": "Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.", + "id": "YoutubeChannelAssignedTargetingOptionDetails", + "properties": { + "channelId": { + "description": "The YouTube uploader channel id or the channel code of a YouTube channel.", + "type": "string" + }, + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + } + }, + "type": "object" + }, + "YoutubeVideoAssignedTargetingOptionDetails": { + "description": "Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.", + "id": "YoutubeVideoAssignedTargetingOptionDetails", + "properties": { + "negative": { + "description": "Indicates if this option is being negatively targeted.", + "type": "boolean" + }, + "videoId": { + "description": "YouTube video id as it appears on the YouTube watch page.", + "type": "string" + } + }, + "type": "object" + }, + "YoutubeVideoDetails": { + "description": "Details of a YouTube video.", + "id": "YoutubeVideoDetails", + "properties": { + "id": { + "description": "The YouTube video ID which can be searched on YouTube webpage.", + "type": "string" + }, + "unavailableReason": { + "description": "The reason why the video data is not available.", + "enum": [ + "VIDEO_UNAVAILABLE_REASON_UNSPECIFIED", + "VIDEO_UNAVAILABLE_REASON_PRIVATE", + "VIDEO_UNAVAILABLE_REASON_DELETED" + ], + "enumDescriptions": [ + "Unknown or unspecified.", + "The video is private.", + "The video is deleted." + ], + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Display & Video 360 API", + "version": "v3", + "version_module": true +} \ No newline at end of file diff --git a/discovery/dlp-v2.json b/discovery/dlp-v2.json index f228622152..9d61821caf 100644 --- a/discovery/dlp-v2.json +++ b/discovery/dlp-v2.json @@ -3412,7 +3412,7 @@ } } }, - "revision": "20230917", + "revision": "20231001", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -5194,6 +5194,11 @@ "description": "If created by a job trigger, the resource name of the trigger that instantiated the job.", "type": "string" }, + "lastModified": { + "description": "Time when the job was last modified by the system.", + "format": "google-datetime", + "type": "string" + }, "name": { "description": "The server-assigned name.", "type": "string" @@ -5852,8 +5857,8 @@ "JAPAN", "KOREA", "MEXICO", - "NEW_ZEALAND", "THE_NETHERLANDS", + "NEW_ZEALAND", "NORWAY", "PARAGUAY", "PERU", @@ -5863,6 +5868,7 @@ "SOUTH_AFRICA", "SPAIN", "SWEDEN", + "SWITZERLAND", "TAIWAN", "THAILAND", "TURKEY", @@ -5897,8 +5903,8 @@ "The infoType is typically used in Japan.", "The infoType is typically used in Korea.", "The infoType is typically used in Mexico.", - "The infoType is typically used in New Zealand.", "The infoType is typically used in the Netherlands.", + "The infoType is typically used in New Zealand.", "The infoType is typically used in Norway.", "The infoType is typically used in Paraguay.", "The infoType is typically used in Peru.", @@ -5908,6 +5914,7 @@ "The infoType is typically used in South Africa.", "The infoType is typically used in Spain.", "The infoType is typically used in Sweden.", + "The infoType is typically used in Switzerland.", "The infoType is typically used in Taiwan.", "The infoType is typically used in Thailand.", "The infoType is typically used in Turkey.", diff --git a/discovery/docs-v1.json b/discovery/docs-v1.json index 66d1eb0248..221324979d 100644 --- a/discovery/docs-v1.json +++ b/discovery/docs-v1.json @@ -216,7 +216,7 @@ } } }, - "revision": "20230227", + "revision": "20230929", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AutoText": { @@ -911,6 +911,10 @@ "description": "The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only.", "type": "string" }, + "flipPageOrientation": { + "description": "Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape.", + "type": "boolean" + }, "marginBottom": { "$ref": "Dimension", "description": "The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles." @@ -991,6 +995,10 @@ "description": "Indicates if there was a suggested change to first_page_header_id.", "type": "boolean" }, + "flipPageOrientationSuggested": { + "description": "Optional. Indicates if there was a suggested change to flip_page_orientation.", + "type": "boolean" + }, "marginBottomSuggested": { "description": "Indicates if there was a suggested change to margin_bottom.", "type": "boolean" @@ -3192,6 +3200,10 @@ "description": "The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only.", "type": "string" }, + "flipPageOrientation": { + "description": "Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error.", + "type": "boolean" + }, "marginBottom": { "$ref": "Dimension", "description": "The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error." diff --git a/discovery/documentai-v1.json b/discovery/documentai-v1.json index e528e8d7ed..4b2e316dc4 100644 --- a/discovery/documentai-v1.json +++ b/discovery/documentai-v1.json @@ -1042,7 +1042,7 @@ } } }, - "revision": "20230914", + "revision": "20231006", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4034,7 +4034,7 @@ "type": "boolean" }, "disableCharacterBoxesDetection": { - "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0+ processors.", + "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.", "type": "boolean" }, "enableImageQualityScores": { @@ -4087,7 +4087,7 @@ "type": "boolean" }, "enableSelectionMarkDetection": { - "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0+ processors.", + "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.", "type": "boolean" } }, @@ -4103,7 +4103,7 @@ "type": "integer" }, "fromStart": { - "description": "Only process certain pages from the start, process all if the document has less pages.", + "description": "Only process certain pages from the start. Process all if the document has fewer pages.", "format": "int32", "type": "integer" }, @@ -7670,7 +7670,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3Dataset": { - "description": "A singleton resource under a Processor which configures a collection of documents. Next Id: 8.", + "description": "A singleton resource under a Processor which configures a collection of documents.", "id": "GoogleCloudDocumentaiV1beta3Dataset", "properties": { "documentWarehouseConfig": { diff --git a/discovery/documentai-v1beta2.json b/discovery/documentai-v1beta2.json index 756711999b..1d12402fc6 100644 --- a/discovery/documentai-v1beta2.json +++ b/discovery/documentai-v1beta2.json @@ -292,7 +292,7 @@ } } }, - "revision": "20230914", + "revision": "20231006", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -4722,7 +4722,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3Dataset": { - "description": "A singleton resource under a Processor which configures a collection of documents. Next Id: 8.", + "description": "A singleton resource under a Processor which configures a collection of documents.", "id": "GoogleCloudDocumentaiV1beta3Dataset", "properties": { "documentWarehouseConfig": { diff --git a/discovery/documentai-v1beta3.json b/discovery/documentai-v1beta3.json index e5ef2112ae..e73b570fcd 100644 --- a/discovery/documentai-v1beta3.json +++ b/discovery/documentai-v1beta3.json @@ -828,6 +828,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "listDocuments": { + "description": "Returns a list of documents present in the dataset.", + "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset:listDocuments", + "httpMethod": "POST", + "id": "documentai.projects.locations.processors.dataset.listDocuments", + "parameterOrder": [ + "dataset" + ], + "parameters": { + "dataset": { + "description": "Required. The resource name of the dataset to be listed. Format: projects/{project}/locations/{location}/processors/{processor}/dataset", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/processors/[^/]+/dataset$", + "required": true, + "type": "string" + } + }, + "path": "v1beta3/{+dataset}:listDocuments", + "request": { + "$ref": "GoogleCloudDocumentaiV1beta3ListDocumentsRequest" + }, + "response": { + "$ref": "GoogleCloudDocumentaiV1beta3ListDocumentsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "updateDatasetSchema": { "description": "Updates a `DatasetSchema`.", "flatPath": "v1beta3/projects/{projectsId}/locations/{locationsId}/processors/{processorsId}/dataset/datasetSchema", @@ -1256,7 +1284,7 @@ } } }, - "revision": "20230914", + "revision": "20231006", "rootUrl": "https://documentai.googleapis.com/", "schemas": { "GoogleCloudDocumentaiUiv1beta3AutoLabelDocumentsMetadata": { @@ -5662,7 +5690,7 @@ "type": "object" }, "GoogleCloudDocumentaiV1beta3Dataset": { - "description": "A singleton resource under a Processor which configures a collection of documents. Next Id: 8.", + "description": "A singleton resource under a Processor which configures a collection of documents.", "id": "GoogleCloudDocumentaiV1beta3Dataset", "properties": { "documentWarehouseConfig": { @@ -6063,6 +6091,58 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3DocumentMetadata": { + "description": "Metadata about a document.", + "id": "GoogleCloudDocumentaiV1beta3DocumentMetadata", + "properties": { + "datasetType": { + "description": "Type of the dataset split to which the document belongs.", + "enum": [ + "DATASET_SPLIT_TYPE_UNSPECIFIED", + "DATASET_SPLIT_TRAIN", + "DATASET_SPLIT_TEST", + "DATASET_SPLIT_UNASSIGNED" + ], + "enumDescriptions": [ + "Default value if the enum is not set.", + "Identifies the train documents.", + "Identifies the test documents.", + "Identifies the unassigned documents." + ], + "type": "string" + }, + "displayName": { + "description": "The display name of the document.", + "type": "string" + }, + "documentId": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentId", + "description": "Document identifier." + }, + "labelingState": { + "description": "Labelling state of the document.", + "enum": [ + "DOCUMENT_LABELING_STATE_UNSPECIFIED", + "DOCUMENT_LABELED", + "DOCUMENT_UNLABELED", + "DOCUMENT_AUTO_LABELED" + ], + "enumDescriptions": [ + "Default value if the enum is not set.", + "Document has been labelled.", + "Document has not been labelled.", + "Document has been auto-labelled." + ], + "type": "string" + }, + "pageCount": { + "description": "Number of pages in the document.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3DocumentOutputConfig": { "description": "Config that controls the output of documents. All documents will be written as a JSON file.", "id": "GoogleCloudDocumentaiV1beta3DocumentOutputConfig", @@ -7807,6 +7887,56 @@ }, "type": "object" }, + "GoogleCloudDocumentaiV1beta3ListDocumentsRequest": { + "id": "GoogleCloudDocumentaiV1beta3ListDocumentsRequest", + "properties": { + "filter": { + "description": "Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\\\"file_name.pdf\\\"` - `EntityType=abc/def` - `TagName=\\\"auto-labeling-running\\\"|\\\"sampled\\\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT supported. - String match is case sensitive (for filter `DisplayName` & `EntityType`).", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100.", + "format": "int32", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token.", + "type": "string" + }, + "returnTotalSize": { + "description": "Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false.", + "type": "boolean" + }, + "skip": { + "description": "Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, `ListDocumentsResponse.document_metadata` and `ListDocumentsResponse.next_page_token` will be empty.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudDocumentaiV1beta3ListDocumentsResponse": { + "id": "GoogleCloudDocumentaiV1beta3ListDocumentsResponse", + "properties": { + "documentMetadata": { + "description": "Document metadata corresponding to the listed documents.", + "items": { + "$ref": "GoogleCloudDocumentaiV1beta3DocumentMetadata" + }, + "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" + }, + "totalSize": { + "description": "Total count of documents queried.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudDocumentaiV1beta3ListEvaluationsResponse": { "description": "The response from `ListEvaluations`.", "id": "GoogleCloudDocumentaiV1beta3ListEvaluationsResponse", @@ -7913,7 +8043,7 @@ "type": "boolean" }, "disableCharacterBoxesDetection": { - "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0+ processors.", + "description": "Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.", "type": "boolean" }, "enableImageQualityScores": { @@ -7966,7 +8096,7 @@ "type": "boolean" }, "enableSelectionMarkDetection": { - "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0+ processors.", + "description": "Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors.", "type": "boolean" } }, @@ -7982,7 +8112,7 @@ "type": "integer" }, "fromStart": { - "description": "Only process certain pages from the start, process all if the document has less pages.", + "description": "Only process certain pages from the start. Process all if the document has fewer pages.", "format": "int32", "type": "integer" }, diff --git a/discovery/eventarc-v1.json b/discovery/eventarc-v1.json index 12a4347721..bb7c47ce5b 100644 --- a/discovery/eventarc-v1.json +++ b/discovery/eventarc-v1.json @@ -1197,7 +1197,7 @@ } } }, - "revision": "20230918", + "revision": "20230929", "rootUrl": "https://eventarc.googleapis.com/", "schemas": { "AuditConfig": { @@ -1662,10 +1662,6 @@ "description": "Represents a HTTP endpoint destination.", "id": "HttpEndpoint", "properties": { - "forwardDnsRequests": { - "description": "Optional. Forwards DNS requests to the VPC specified by network config to resolve the HTTP endpoint. Default to false. If set to true, Eventarc will create a peering zone to the consumer VPC and forward DNS requests. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones Enable this if the URI uses an internal DNS name or a private Cloud DNS zone.", - "type": "boolean" - }, "uri": { "description": "Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS.", "type": "string" diff --git a/discovery/firestore-v1.json b/discovery/firestore-v1.json index e1c26f5dec..9c7c8649a4 100644 --- a/discovery/firestore-v1.json +++ b/discovery/firestore-v1.json @@ -1672,7 +1672,7 @@ } } }, - "revision": "20230918", + "revision": "20231002", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2627,7 +2627,7 @@ "type": "string" }, "snapshotTime": { - "description": "The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 1 hour. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.", + "description": "The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 5 days. Please choose a reasonable timestamp based on prior knowledge on how long exports take as data at provided snapshot timestamp can expire during export. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents.", "format": "google-datetime", "type": "string" } @@ -2728,6 +2728,12 @@ }, "type": "object" }, + "GoogleFirestoreAdminV1FlatIndex": { + "description": "An index that stores vectors in a flat data structure, and supports exhaustive search.", + "id": "GoogleFirestoreAdminV1FlatIndex", + "properties": {}, + "type": "object" + }, "GoogleFirestoreAdminV1ImportDocumentsMetadata": { "description": "Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments.", "id": "GoogleFirestoreAdminV1ImportDocumentsMetadata", @@ -2966,6 +2972,10 @@ "The field is ordered by descending field value." ], "type": "string" + }, + "vectorConfig": { + "$ref": "GoogleFirestoreAdminV1VectorConfig", + "description": "Indicates that this field supports nearest neighbors and distance operations on vector." } }, "type": "object" @@ -3189,7 +3199,7 @@ "id": "GoogleFirestoreAdminV1RestoreDatabaseRequest", "properties": { "backup": { - "description": "Required. Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", + "description": "Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id}/locations/{location}/backups/{backup}`", "type": "string" }, "databaseId": { @@ -3275,6 +3285,22 @@ "properties": {}, "type": "object" }, + "GoogleFirestoreAdminV1VectorConfig": { + "description": "The index configuration to support vector search operations", + "id": "GoogleFirestoreAdminV1VectorConfig", + "properties": { + "dimension": { + "description": "Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension.", + "format": "int32", + "type": "integer" + }, + "flat": { + "$ref": "GoogleFirestoreAdminV1FlatIndex", + "description": "Indicates the vector index is a flat index." + } + }, + "type": "object" + }, "GoogleFirestoreAdminV1WeeklyRecurrence": { "description": "Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC.", "id": "GoogleFirestoreAdminV1WeeklyRecurrence", @@ -3619,7 +3645,7 @@ "type": "string" }, "partitions": { - "description": "Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned.", + "description": "Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned, or that the query is not yet supported for partitioning.", "items": { "$ref": "Cursor" }, diff --git a/discovery/firestore-v1beta1.json b/discovery/firestore-v1beta1.json index 83cce3ddfa..4c6ea1f3f7 100644 --- a/discovery/firestore-v1beta1.json +++ b/discovery/firestore-v1beta1.json @@ -950,7 +950,7 @@ } } }, - "revision": "20230905", + "revision": "20231002", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -2213,7 +2213,7 @@ "type": "string" }, "partitions": { - "description": "Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned.", + "description": "Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned, or that the query is not yet supported for partitioning.", "items": { "$ref": "Cursor" }, diff --git a/discovery/gkebackup-v1.json b/discovery/gkebackup-v1.json index d8459ee9a5..1d9591853e 100644 --- a/discovery/gkebackup-v1.json +++ b/discovery/gkebackup-v1.json @@ -109,31 +109,6 @@ "resources": { "locations": { "methods": { - "deleteOperations": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", - "httpMethod": "DELETE", - "id": "gkebackup.projects.locations.deleteOperations", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}/operations", - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "get": { "description": "Gets information about a location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", @@ -921,6 +896,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "gkebackup.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", @@ -1688,7 +1688,7 @@ } } }, - "revision": "20230816", + "revision": "20230927", "rootUrl": "https://gkebackup.googleapis.com/", "schemas": { "AuditConfig": { @@ -2580,7 +2580,7 @@ "type": "string" }, "namespaces": { - "description": "Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation). To mix cluster-scoped and namespaced resources in the same rule, use an empty string (\"\") as one of the target namespaces.", + "description": "Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation).", "items": { "type": "string" }, diff --git a/discovery/gkehub-v1.json b/discovery/gkehub-v1.json index 8f935ffbeb..eab8119310 100644 --- a/discovery/gkehub-v1.json +++ b/discovery/gkehub-v1.json @@ -1834,7 +1834,7 @@ } } }, - "revision": "20230914", + "revision": "20230929", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -4491,10 +4491,6 @@ "description": "Scope represents a Scope in a Fleet.", "id": "Scope", "properties": { - "allMemberships": { - "description": "If true, all Memberships in the Fleet bind to this Scope.", - "type": "boolean" - }, "createTime": { "description": "Output only. When the scope was created.", "format": "google-datetime", diff --git a/discovery/gkehub-v1alpha.json b/discovery/gkehub-v1alpha.json index 810a1af791..e4685d9ec0 100644 --- a/discovery/gkehub-v1alpha.json +++ b/discovery/gkehub-v1alpha.json @@ -2414,7 +2414,7 @@ } } }, - "revision": "20230914", + "revision": "20230929", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -6096,10 +6096,6 @@ "description": "Scope represents a Scope in a Fleet.", "id": "Scope", "properties": { - "allMemberships": { - "description": "If true, all Memberships in the Fleet bind to this Scope.", - "type": "boolean" - }, "createTime": { "description": "Output only. When the scope was created.", "format": "google-datetime", diff --git a/discovery/gkehub-v1beta.json b/discovery/gkehub-v1beta.json index b6a93eba68..10029448d3 100644 --- a/discovery/gkehub-v1beta.json +++ b/discovery/gkehub-v1beta.json @@ -653,6 +653,161 @@ }, "memberships": { "methods": { + "create": { + "description": "Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships", + "httpMethod": "POST", + "id": "gkehub.projects.locations.memberships.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "membershipId": { + "description": "Required. Client chosen ID for the membership. `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.", + "location": "query", + "type": "string" + }, + "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" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+parent}/memberships", + "request": { + "$ref": "Membership" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}", + "httpMethod": "DELETE", + "id": "gkehub.projects.locations.memberships.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "force": { + "description": "Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateConnectManifest": { + "description": "Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:generateConnectManifest", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.generateConnectManifest", + "parameterOrder": [ + "name" + ], + "parameters": { + "imagePullSecretContent": { + "description": "Optional. The image pull secret content for the registry, if not public.", + "format": "byte", + "location": "query", + "type": "string" + }, + "isUpgrade": { + "description": "Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The Membership resource name the Agent will associate with, in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "namespace": { + "description": "Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`. The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding.", + "location": "query", + "type": "string" + }, + "proxy": { + "description": "Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy.", + "format": "byte", + "location": "query", + "type": "string" + }, + "registry": { + "description": "Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect.", + "location": "query", + "type": "string" + }, + "version": { + "description": "Optional. The Connect agent version to use. Defaults to the most current version.", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}:generateConnectManifest", + "response": { + "$ref": "GenerateConnectManifestResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a Membership.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+name}", + "response": { + "$ref": "Membership" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:getIamPolicy", @@ -684,6 +839,91 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "list": { + "description": "Lists Memberships in a given project and location.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships", + "httpMethod": "GET", + "id": "gkehub.projects.locations.memberships.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = \"projects/foo-proj/locations/global/membership/bar\" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. Token returned by previous call to `ListMemberships` which specifies the position in the list from where to continue listing the resources.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/*/locations/*`. `projects/*/locations/-` list memberships in all the regions.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}/memberships", + "response": { + "$ref": "ListMembershipsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates an existing Membership.", + "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}", + "httpMethod": "PATCH", + "id": "gkehub.projects.locations.memberships.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The Membership resource name in the format `projects/*/locations/*/memberships/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/memberships/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta/{+name}", + "request": { + "$ref": "Membership" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/memberships/{membershipsId}:setIamPolicy", @@ -2100,7 +2340,7 @@ } } }, - "revision": "20230914", + "revision": "20230929", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AnthosObservabilityFeatureSpec": { @@ -2150,6 +2390,17 @@ }, "type": "object" }, + "ApplianceCluster": { + "description": "ApplianceCluster contains information specific to GDC Edge Appliance Clusters.", + "id": "ApplianceCluster", + "properties": { + "resourceLink": { + "description": "Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance", + "type": "string" + } + }, + "type": "object" + }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -2198,6 +2449,32 @@ }, "type": "object" }, + "Authority": { + "description": "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", + "id": "Authority", + "properties": { + "identityProvider": { + "description": "Output only. An identity provider that reflects the `issuer` in the workload identity pool.", + "readOnly": true, + "type": "string" + }, + "issuer": { + "description": "Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start with `https://` and be a valid URL with length <2000 characters, it must use `location` rather than `zone` for GKE clusters. 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).", + "type": "string" + }, + "oidcJwks": { + "description": "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.", + "format": "byte", + "type": "string" + }, + "workloadIdentityPool": { + "description": "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.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Binding": { "description": "Associates `members`, or principals, with a `role`.", "id": "Binding", @@ -3154,6 +3431,32 @@ }, "type": "object" }, + "ConnectAgentResource": { + "description": "ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment.", + "id": "ConnectAgentResource", + "properties": { + "manifest": { + "description": "YAML manifest of the resource.", + "type": "string" + }, + "type": { + "$ref": "TypeMeta", + "description": "Kubernetes type of the resource." + } + }, + "type": "object" + }, + "EdgeCluster": { + "description": "EdgeCluster contains information specific to Google Edge Clusters.", + "id": "EdgeCluster", + "properties": { + "resourceLink": { + "description": "Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster", + "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", @@ -3547,6 +3850,20 @@ }, "type": "object" }, + "GenerateConnectManifestResponse": { + "description": "GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent.", + "id": "GenerateConnectManifestResponse", + "properties": { + "manifest": { + "description": "The ordered list of Kubernetes resources that need to be applied to the cluster for GKE Connect agent installation/upgrade.", + "items": { + "$ref": "ConnectAgentResource" + }, + "type": "array" + } + }, + "type": "object" + }, "GenerateMembershipRBACRoleBindingYAMLResponse": { "description": "Response for GenerateRBACRoleBindingYAML.", "id": "GenerateMembershipRBACRoleBindingYAMLResponse", @@ -3558,6 +3875,22 @@ }, "type": "object" }, + "GkeCluster": { + "description": "GkeCluster contains information specific to GKE clusters.", + "id": "GkeCluster", + "properties": { + "clusterMissing": { + "description": "Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane.", + "readOnly": true, + "type": "boolean" + }, + "resourceLink": { + "description": "Immutable. Self-link of the Google Cloud 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.", + "type": "string" + } + }, + "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", @@ -3764,6 +4097,78 @@ }, "type": "object" }, + "KubernetesMetadata": { + "description": "KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters.", + "id": "KubernetesMetadata", + "properties": { + "kubernetesApiServerVersion": { + "description": "Output only. Kubernetes API server version string as reported by `/version`.", + "readOnly": true, + "type": "string" + }, + "memoryMb": { + "description": "Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "nodeCount": { + "description": "Output only. Node count as reported by Kubernetes nodes resources.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "nodeProviderId": { + "description": "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.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vcpuCount": { + "description": "Output only. vCPU count as reported by Kubernetes nodes resources.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "KubernetesResource": { + "description": "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.", + "id": "KubernetesResource", + "properties": { + "connectResources": { + "description": "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.", + "items": { + "$ref": "ResourceManifest" + }, + "readOnly": true, + "type": "array" + }, + "membershipCrManifest": { + "description": "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.", + "type": "string" + }, + "membershipResources": { + "description": "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.", + "items": { + "$ref": "ResourceManifest" + }, + "readOnly": true, + "type": "array" + }, + "resourceOptions": { + "$ref": "ResourceOptions", + "description": "Optional. Options for Kubernetes resource generation." + } + }, + "type": "object" + }, "ListFeaturesResponse": { "description": "Response message for the `GkeHub.ListFeatures` method.", "id": "ListFeaturesResponse", @@ -3854,6 +4259,31 @@ }, "type": "object" }, + "ListMembershipsResponse": { + "description": "Response message for the `GkeHub.ListMemberships` method.", + "id": "ListMembershipsResponse", + "properties": { + "nextPageToken": { + "description": "A token to request the next page of resources from the `ListMemberships` method. The value of an empty string means that there are no more resources to return.", + "type": "string" + }, + "resources": { + "description": "The list of matching Memberships.", + "items": { + "$ref": "Membership" + }, + "type": "array" + }, + "unreachable": { + "description": "List of locations that could not be reached while fetching this list.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListNamespacesResponse": { "description": "List of fleet namespaces.", "id": "ListNamespacesResponse", @@ -3996,6 +4426,80 @@ }, "type": "object" }, + "Membership": { + "description": "Membership contains information about a member cluster.", + "id": "Membership", + "properties": { + "authority": { + "$ref": "Authority", + "description": "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" + }, + "createTime": { + "description": "Output only. When the Membership was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. When the Membership was deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "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.", + "readOnly": true, + "type": "string" + }, + "endpoint": { + "$ref": "MembershipEndpoint", + "description": "Optional. Endpoint information to reach this member." + }, + "externalId": { + "description": "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.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Labels for this membership.", + "type": "object" + }, + "lastConnectionTime": { + "description": "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.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "monitoringConfig": { + "$ref": "MonitoringConfig", + "description": "Optional. The monitoring config information for this membership." + }, + "name": { + "description": "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.", + "readOnly": true, + "type": "string" + }, + "state": { + "$ref": "MembershipState", + "description": "Output only. State of the Membership resource.", + "readOnly": true + }, + "uniqueId": { + "description": "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.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. When the Membership was last updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MembershipBinding": { "description": "MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to.", "id": "MembershipBinding", @@ -4072,6 +4576,47 @@ }, "type": "object" }, + "MembershipEndpoint": { + "description": "MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata.", + "id": "MembershipEndpoint", + "properties": { + "applianceCluster": { + "$ref": "ApplianceCluster", + "description": "Optional. Specific information for a GDC Edge Appliance cluster." + }, + "edgeCluster": { + "$ref": "EdgeCluster", + "description": "Optional. Specific information for a Google Edge cluster." + }, + "gkeCluster": { + "$ref": "GkeCluster", + "description": "Optional. Specific information for a GKE-on-GCP cluster." + }, + "googleManaged": { + "description": "Output only. Whether the lifecycle of this membership is managed by a google cluster platform service.", + "readOnly": true, + "type": "boolean" + }, + "kubernetesMetadata": { + "$ref": "KubernetesMetadata", + "description": "Output only. Useful Kubernetes-specific metadata.", + "readOnly": true + }, + "kubernetesResource": { + "$ref": "KubernetesResource", + "description": "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." + }, + "multiCloudCluster": { + "$ref": "MultiCloudCluster", + "description": "Optional. Specific information for a GKE Multi-Cloud cluster." + }, + "onPremCluster": { + "$ref": "OnPremCluster", + "description": "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." + } + }, + "type": "object" + }, "MembershipFeatureSpec": { "description": "MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name.", "id": "MembershipFeatureSpec", @@ -4175,6 +4720,34 @@ }, "type": "object" }, + "MembershipState": { + "description": "MembershipState describes the state of a Membership resource.", + "id": "MembershipState", + "properties": { + "code": { + "description": "Output only. The current state of the Membership resource.", + "enum": [ + "CODE_UNSPECIFIED", + "CREATING", + "READY", + "DELETING", + "UPDATING", + "SERVICE_UPDATING" + ], + "enumDescriptions": [ + "The code is not set.", + "The cluster is being registered.", + "The cluster is registered.", + "The cluster is being unregistered.", + "The Membership is being updated.", + "The Membership is being updated by the Hub Service." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "MeteringMembershipState": { "description": "**Metering**: Per-Membership Feature State.", "id": "MeteringMembershipState", @@ -4192,6 +4765,49 @@ }, "type": "object" }, + "MonitoringConfig": { + "description": "This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics.", + "id": "MonitoringConfig", + "properties": { + "cluster": { + "description": "Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format `memberClusters/cluster_name`; And for Anthos on MultiCloud, it would be in format `{azureClusters, awsClusters}/cluster_name`.", + "type": "string" + }, + "clusterHash": { + "description": "Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub.", + "type": "string" + }, + "kubernetesMetricsPrefix": { + "description": "Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos", + "type": "string" + }, + "location": { + "description": "Immutable. Location used to report Metrics", + "type": "string" + }, + "projectId": { + "description": "Immutable. Project used to report Metrics", + "type": "string" + } + }, + "type": "object" + }, + "MultiCloudCluster": { + "description": "MultiCloudCluster contains information specific to GKE Multi-Cloud clusters.", + "id": "MultiCloudCluster", + "properties": { + "clusterMissing": { + "description": "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.", + "readOnly": true, + "type": "boolean" + }, + "resourceLink": { + "description": "Immutable. Self-link of the Google Cloud 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", + "type": "string" + } + }, + "type": "object" + }, "MultiClusterIngressFeatureSpec": { "description": "**Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature.", "id": "MultiClusterIngressFeatureSpec", @@ -4301,6 +4917,44 @@ }, "type": "object" }, + "OnPremCluster": { + "description": "OnPremCluster contains information specific to GKE On-Prem clusters.", + "id": "OnPremCluster", + "properties": { + "adminCluster": { + "description": "Immutable. Whether the cluster is an admin cluster.", + "type": "boolean" + }, + "clusterMissing": { + "description": "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.", + "readOnly": true, + "type": "boolean" + }, + "clusterType": { + "description": "Immutable. The on prem cluster's type.", + "enum": [ + "CLUSTERTYPE_UNSPECIFIED", + "BOOTSTRAP", + "HYBRID", + "STANDALONE", + "USER" + ], + "enumDescriptions": [ + "The ClusterType is not set.", + "The ClusterType is bootstrap cluster.", + "The ClusterType is baremetal hybrid cluster.", + "The ClusterType is baremetal standalone cluster.", + "The ClusterType is user cluster." + ], + "type": "string" + }, + "resourceLink": { + "description": "Immutable. Self-link of the Google Cloud 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", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4880,6 +5534,40 @@ }, "type": "object" }, + "ResourceManifest": { + "description": "ResourceManifest represents a single Kubernetes resource to be applied to the cluster.", + "id": "ResourceManifest", + "properties": { + "clusterScoped": { + "description": "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.", + "type": "boolean" + }, + "manifest": { + "description": "YAML manifest of the resource.", + "type": "string" + } + }, + "type": "object" + }, + "ResourceOptions": { + "description": "ResourceOptions represent options for Kubernetes resource generation.", + "id": "ResourceOptions", + "properties": { + "connectVersion": { + "description": "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.", + "type": "string" + }, + "k8sVersion": { + "description": "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`.", + "type": "string" + }, + "v1beta1Crd": { + "description": "Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16.", + "type": "boolean" + } + }, + "type": "object" + }, "Role": { "description": "Role is the type for Kubernetes roles", "id": "Role", @@ -4909,10 +5597,6 @@ "description": "Scope represents a Scope in a Fleet.", "id": "Scope", "properties": { - "allMemberships": { - "description": "If true, all Memberships in the Fleet bind to this Scope.", - "type": "boolean" - }, "createTime": { "description": "Output only. When the scope was created.", "format": "google-datetime", @@ -5220,6 +5904,21 @@ } }, "type": "object" + }, + "TypeMeta": { + "description": "TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest.", + "id": "TypeMeta", + "properties": { + "apiVersion": { + "description": "APIVersion of the resource (e.g. v1).", + "type": "string" + }, + "kind": { + "description": "Kind of the resource (e.g. Deployment).", + "type": "string" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/gkeonprem-v1.json b/discovery/gkeonprem-v1.json index 63822e03ff..79dd7a4c28 100644 --- a/discovery/gkeonprem-v1.json +++ b/discovery/gkeonprem-v1.json @@ -2996,7 +2996,7 @@ } } }, - "revision": "20230918", + "revision": "20230925", "rootUrl": "https://gkeonprem.googleapis.com/", "schemas": { "Authorization": { @@ -5260,10 +5260,6 @@ "description": "Current version of the dependency e.g. 1.15.0.", "type": "string" }, - "localName": { - "description": "Local name of the dependency.", - "type": "string" - }, "membership": { "description": "Membership names are formatted as `projects//locations//memberships/`.", "type": "string" diff --git a/discovery/gmail-v1.json b/discovery/gmail-v1.json index 47285e49c6..a09e8a2f4a 100644 --- a/discovery/gmail-v1.json +++ b/discovery/gmail-v1.json @@ -3077,7 +3077,7 @@ } } }, - "revision": "20230918", + "revision": "20231002", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -3164,6 +3164,10 @@ "primaryKeyPairId": { "description": "If a key pair is associated, the ID of the key pair, CseKeyPair.", "type": "string" + }, + "signAndEncryptKeyPairs": { + "$ref": "SignAndEncryptKeyPairs", + "description": "The configuration of a CSE identity that uses different key pairs for signing and encryption." } }, "type": "object" @@ -3229,10 +3233,6 @@ "description": "Metadata for a private key instance.", "id": "CsePrivateKeyMetadata", "properties": { - "hardwareKeyMetadata": { - "$ref": "HardwareKeyMetadata", - "description": "Metadata for hardware keys." - }, "kaclsKeyMetadata": { "$ref": "KaclsKeyMetadata", "description": "Metadata for a private key instance managed by an external key access control list service." @@ -3429,17 +3429,6 @@ }, "type": "object" }, - "HardwareKeyMetadata": { - "description": "Metadata for hardware keys.", - "id": "HardwareKeyMetadata", - "properties": { - "description": { - "description": "Description about the hardware key.", - "type": "string" - } - }, - "type": "object" - }, "History": { "description": "A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways.", "id": "History", @@ -4213,6 +4202,21 @@ }, "type": "object" }, + "SignAndEncryptKeyPairs": { + "description": "The configuration of a CSE identity that uses different key pairs for signing and encryption.", + "id": "SignAndEncryptKeyPairs", + "properties": { + "encryptionKeyPairId": { + "description": "The ID of the CseKeyPair that encrypts signed outgoing mail.", + "type": "string" + }, + "signingKeyPairId": { + "description": "The ID of the CseKeyPair that signs outgoing mail.", + "type": "string" + } + }, + "type": "object" + }, "SmimeInfo": { "description": "An S/MIME email config.", "id": "SmimeInfo", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index d7260393e1..b899d80fa5 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-healthcare": { + "description": "Read, write and manage healthcare data" + }, "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." } @@ -131,6 +134,7 @@ "$ref": "Location" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -172,6 +176,7 @@ "$ref": "ListLocationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -209,6 +214,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -237,6 +243,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -262,6 +269,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -287,6 +295,7 @@ "$ref": "Dataset" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -318,6 +327,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -354,6 +364,7 @@ "$ref": "ListDatasetsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -388,6 +399,7 @@ "$ref": "Dataset" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -416,6 +428,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -444,6 +457,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -476,6 +490,7 @@ "$ref": "CheckDataAccessResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -509,6 +524,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -534,6 +550,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -562,6 +579,7 @@ "$ref": "EvaluateUserConsentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -587,6 +605,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -618,6 +637,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -659,6 +679,7 @@ "$ref": "ListConsentStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -693,6 +714,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -721,6 +743,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -749,6 +772,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -777,6 +801,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -814,6 +839,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -839,6 +865,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -864,6 +891,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -905,6 +933,7 @@ "$ref": "ListAttributeDefinitionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -939,6 +968,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -971,6 +1001,7 @@ "$ref": "ConsentArtifact" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -996,6 +1027,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1021,6 +1053,7 @@ "$ref": "ConsentArtifact" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1062,6 +1095,7 @@ "$ref": "ListConsentArtifactsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1094,6 +1128,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1122,6 +1157,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1147,6 +1183,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1172,6 +1209,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1197,6 +1235,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1238,6 +1277,7 @@ "$ref": "ListConsentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1279,6 +1319,7 @@ "$ref": "ListConsentRevisionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1313,6 +1354,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1341,6 +1383,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1369,6 +1412,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1401,6 +1445,7 @@ "$ref": "ArchiveUserDataMappingResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1429,6 +1474,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1454,6 +1500,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1479,6 +1526,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1520,6 +1568,7 @@ "$ref": "ListUserDataMappingsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1554,6 +1603,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1593,6 +1643,7 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1621,6 +1672,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1646,6 +1698,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1674,6 +1727,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1699,6 +1753,33 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getDICOMStoreMetrics": { + "description": "Gets metrics associated with the DICOM store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getDICOMStoreMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the DICOM store to get metrics for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:getDICOMStoreMetrics", + "response": { + "$ref": "DicomStoreMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1730,6 +1811,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1758,6 +1840,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1799,6 +1882,7 @@ "$ref": "ListDicomStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1833,6 +1917,7 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1866,6 +1951,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1899,6 +1985,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1932,6 +2019,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1960,6 +2048,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1996,6 +2085,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2024,11 +2114,78 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { + "dicomWeb": { + "resources": { + "studies": { + "methods": { + "getStudyMetrics": { + "description": "GetStudyMetrics returns metrics for a study.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics", + "parameterOrder": [ + "study" + ], + "parameters": { + "study": { + "description": "The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+study}:getStudyMetrics", + "response": { + "$ref": "StudyMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "series": { + "methods": { + "getSeriesMetrics": { + "description": "GetSeriesMetrics returns metrics for a series.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics", + "parameterOrder": [ + "series" + ], + "parameters": { + "series": { + "description": "The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+series}:getSeriesMetrics", + "response": { + "$ref": "SeriesMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "studies": { "methods": { "delete": { @@ -2060,6 +2217,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2093,6 +2251,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2126,6 +2285,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2159,6 +2319,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2192,6 +2353,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2228,6 +2390,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2265,6 +2428,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2298,6 +2462,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2331,6 +2496,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2364,6 +2530,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2401,6 +2568,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2434,6 +2602,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2467,6 +2636,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2500,6 +2670,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2537,6 +2708,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2570,6 +2742,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2615,6 +2788,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2643,6 +2817,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2668,6 +2843,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2696,6 +2872,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2721,6 +2898,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2746,6 +2924,7 @@ "$ref": "FhirStoreMetrics" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2777,6 +2956,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2805,6 +2985,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2846,6 +3027,7 @@ "$ref": "ListFhirStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2880,6 +3062,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2908,6 +3091,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2936,6 +3120,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2996,6 +3181,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3021,6 +3207,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3062,6 +3249,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3087,6 +3275,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3120,6 +3309,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3156,6 +3346,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3192,6 +3383,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3228,6 +3420,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3253,6 +3446,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3281,6 +3475,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3327,6 +3522,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3355,6 +3551,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3380,6 +3577,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3408,6 +3606,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3443,6 +3642,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3471,6 +3671,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3496,6 +3697,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3535,6 +3737,7 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3560,6 +3763,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3588,6 +3792,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3613,6 +3818,33 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getHL7v2StoreMetrics": { + "description": "Gets metrics asssociated with the HL7v2 store.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:getHL7v2StoreMetrics", + "response": { + "$ref": "Hl7V2StoreMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3644,6 +3876,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3672,6 +3905,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3713,6 +3947,7 @@ "$ref": "ListHl7V2StoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3747,6 +3982,7 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3775,6 +4011,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3803,6 +4040,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3835,6 +4073,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3860,6 +4099,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3906,6 +4146,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3934,6 +4175,7 @@ "$ref": "IngestMessageResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4001,6 +4243,7 @@ "$ref": "ListMessagesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4035,6 +4278,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4069,6 +4313,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4094,6 +4339,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4135,6 +4381,7 @@ "$ref": "ListOperationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4171,6 +4418,7 @@ "$ref": "AnalyzeEntitiesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4183,7 +4431,7 @@ } } }, - "revision": "20230912", + "revision": "20231003", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { @@ -4776,7 +5024,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within `TextConfig`, and must also be excluded within `ImageConfig` if image redaction is required.", + "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -4934,6 +5182,42 @@ }, "type": "object" }, + "DicomStoreMetrics": { + "description": "DicomStoreMetrics contains metrics describing a DICOM store.", + "id": "DicomStoreMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the store.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the store.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", + "type": "string" + }, + "seriesCount": { + "description": "Number of series in the store.", + "format": "int64", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the store.", + "format": "int64", + "type": "string" + }, + "studyCount": { + "description": "Number of studies in the store.", + "format": "int64", + "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", @@ -5774,6 +6058,45 @@ }, "type": "object" }, + "Hl7V2StoreMetric": { + "description": "Count of messages and total storage size by type for a given HL7 store.", + "id": "Hl7V2StoreMetric", + "properties": { + "count": { + "description": "The total count of HL7v2 messages in the store for the given message type.", + "format": "int64", + "type": "string" + }, + "messageType": { + "description": "The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`.", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "The total amount of structured storage used by HL7v2 messages of this message type in the store.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Hl7V2StoreMetrics": { + "description": "List of metrics for a given HL7v2 store.", + "id": "Hl7V2StoreMetrics", + "properties": { + "metrics": { + "description": "List of HL7v2 store metrics by message type.", + "items": { + "$ref": "Hl7V2StoreMetric" + }, + "type": "array" + }, + "name": { + "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "type": "string" + } + }, + "type": "object" + }, "HttpBody": { "description": "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.", "id": "HttpBody", @@ -6822,6 +7145,32 @@ }, "type": "object" }, + "SeriesMetrics": { + "description": "SeriesMetrics contains metrics describing a DICOM series.", + "id": "SeriesMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the series.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the series.", + "format": "int64", + "type": "string" + }, + "series": { + "description": "The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the series.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -6914,6 +7263,37 @@ }, "type": "object" }, + "StudyMetrics": { + "description": "StudyMetrics contains metrics describing a DICOM study.", + "id": "StudyMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the study.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the study.", + "format": "int64", + "type": "string" + }, + "seriesCount": { + "description": "Number of series in the study.", + "format": "int64", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the study.", + "format": "int64", + "type": "string" + }, + "study": { + "description": "The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.", + "type": "string" + } + }, + "type": "object" + }, "TagFilterList": { "description": "List of tags to be filtered.", "id": "TagFilterList", diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index f517033a87..e29cff8015 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -2,6 +2,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-healthcare": { + "description": "Read, write and manage healthcare data" + }, "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." } @@ -131,6 +134,7 @@ "$ref": "Location" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -172,6 +176,7 @@ "$ref": "ListLocationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -209,6 +214,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -237,6 +243,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -262,6 +269,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -287,6 +295,7 @@ "$ref": "Dataset" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -318,6 +327,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -354,6 +364,7 @@ "$ref": "ListDatasetsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -388,6 +399,7 @@ "$ref": "Dataset" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -416,6 +428,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -444,6 +457,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -481,6 +495,7 @@ "$ref": "AnnotationStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -506,6 +521,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -534,6 +550,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -562,6 +579,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -587,6 +605,7 @@ "$ref": "AnnotationStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -618,6 +637,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -646,6 +666,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -687,6 +708,7 @@ "$ref": "ListAnnotationStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -721,6 +743,7 @@ "$ref": "AnnotationStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -749,6 +772,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -777,6 +801,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -809,6 +834,7 @@ "$ref": "Annotation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -834,6 +860,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -859,6 +886,7 @@ "$ref": "Annotation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -915,6 +943,7 @@ "$ref": "ListAnnotationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -949,6 +978,7 @@ "$ref": "Annotation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -983,6 +1013,7 @@ "$ref": "CheckDataAccessResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1016,6 +1047,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1041,6 +1073,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1069,6 +1102,7 @@ "$ref": "EvaluateUserConsentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1094,6 +1128,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1125,6 +1160,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1166,6 +1202,7 @@ "$ref": "ListConsentStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1200,6 +1237,7 @@ "$ref": "ConsentStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1228,6 +1266,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1256,6 +1295,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1284,6 +1324,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1321,6 +1362,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1346,6 +1388,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1371,6 +1414,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1412,6 +1456,7 @@ "$ref": "ListAttributeDefinitionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1446,6 +1491,7 @@ "$ref": "AttributeDefinition" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1478,6 +1524,7 @@ "$ref": "ConsentArtifact" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1503,6 +1550,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1528,6 +1576,7 @@ "$ref": "ConsentArtifact" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1569,6 +1618,7 @@ "$ref": "ListConsentArtifactsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1601,6 +1651,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1629,6 +1680,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1654,6 +1706,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1679,6 +1732,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1704,6 +1758,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1745,6 +1800,7 @@ "$ref": "ListConsentsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1786,6 +1842,7 @@ "$ref": "ListConsentRevisionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1820,6 +1877,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1848,6 +1906,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1876,6 +1935,7 @@ "$ref": "Consent" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -1908,6 +1968,7 @@ "$ref": "ArchiveUserDataMappingResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1936,6 +1997,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1961,6 +2023,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -1986,6 +2049,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2027,6 +2091,7 @@ "$ref": "ListUserDataMappingsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2061,6 +2126,7 @@ "$ref": "UserDataMapping" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2100,6 +2166,7 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2128,6 +2195,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2153,6 +2221,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2181,6 +2250,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2206,6 +2276,33 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getDICOMStoreMetrics": { + "description": "Gets metrics associated with the DICOM store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:getDICOMStoreMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.getDICOMStoreMetrics", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the DICOM store to get metrics for.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:getDICOMStoreMetrics", + "response": { + "$ref": "DicomStoreMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2237,6 +2334,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2265,6 +2363,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2306,6 +2405,7 @@ "$ref": "ListDicomStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2340,6 +2440,7 @@ "$ref": "DicomStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2373,6 +2474,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2406,6 +2508,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2439,6 +2542,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2467,6 +2571,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2503,6 +2608,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2531,11 +2637,78 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } }, "resources": { + "dicomWeb": { + "resources": { + "studies": { + "methods": { + "getStudyMetrics": { + "description": "GetStudyMetrics returns metrics for a study.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:getStudyMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.getStudyMetrics", + "parameterOrder": [ + "study" + ], + "parameters": { + "study": { + "description": "The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+study}:getStudyMetrics", + "response": { + "$ref": "StudyMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "series": { + "methods": { + "getSeriesMetrics": { + "description": "GetSeriesMetrics returns metrics for a series.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}:getSeriesMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics", + "parameterOrder": [ + "series" + ], + "parameters": { + "series": { + "description": "The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+series}:getSeriesMetrics", + "response": { + "$ref": "SeriesMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + }, "studies": { "methods": { "delete": { @@ -2567,6 +2740,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2600,6 +2774,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2633,6 +2808,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2666,6 +2842,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2699,6 +2876,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2735,6 +2913,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2772,6 +2951,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2805,6 +2985,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2838,6 +3019,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2871,6 +3053,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -2908,6 +3091,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2941,6 +3125,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -2974,6 +3159,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3007,6 +3193,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3044,6 +3231,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3077,6 +3265,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3117,6 +3306,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3145,6 +3335,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3173,6 +3364,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3206,6 +3398,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3234,6 +3427,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3259,6 +3453,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3287,6 +3482,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3312,6 +3508,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3337,6 +3534,7 @@ "$ref": "FhirStoreMetrics" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3368,6 +3566,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3396,6 +3595,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3437,6 +3637,7 @@ "$ref": "ListFhirStoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3471,6 +3672,7 @@ "$ref": "FhirStore" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3499,6 +3701,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3527,6 +3730,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -3586,6 +3790,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3626,6 +3831,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3651,6 +3857,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3676,6 +3883,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3712,6 +3920,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3768,6 +3977,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3819,6 +4029,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3844,6 +4055,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3885,6 +4097,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3910,6 +4123,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3943,6 +4157,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -3979,6 +4194,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4015,6 +4231,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4051,6 +4268,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4076,6 +4294,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4104,6 +4323,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4150,6 +4370,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4178,6 +4399,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4203,6 +4425,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4231,6 +4454,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4266,6 +4490,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4294,6 +4519,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4319,6 +4545,7 @@ "$ref": "HttpBody" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4358,6 +4585,7 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4383,6 +4611,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4411,6 +4640,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4436,6 +4666,33 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getHL7v2StoreMetrics": { + "description": "Gets metrics asssociated with the HL7v2 store.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/hl7V2Stores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}:getHL7v2StoreMetrics", + "response": { + "$ref": "Hl7V2StoreMetrics" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4467,6 +4724,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4495,6 +4753,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4536,6 +4795,7 @@ "$ref": "ListHl7V2StoresResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4570,6 +4830,7 @@ "$ref": "Hl7V2Store" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4598,6 +4859,7 @@ "$ref": "Policy" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4626,6 +4888,7 @@ "$ref": "TestIamPermissionsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4682,6 +4945,7 @@ "$ref": "BatchGetMessagesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4710,6 +4974,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4735,6 +5000,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4781,6 +5047,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4809,6 +5076,7 @@ "$ref": "IngestMessageResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4876,6 +5144,7 @@ "$ref": "ListMessagesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4910,6 +5179,7 @@ "$ref": "Message" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -4944,6 +5214,7 @@ "$ref": "Empty" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -4969,6 +5240,7 @@ "$ref": "Operation" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -5010,6 +5282,7 @@ "$ref": "ListOperationsResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5046,6 +5319,7 @@ "$ref": "AnalyzeEntitiesResponse" }, "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] } @@ -5058,7 +5332,7 @@ } } }, - "revision": "20230912", + "revision": "20231003", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5667,7 +5941,7 @@ "type": "object" }, "CleanTextTag": { - "description": "Inspect text and transform sensitive text. Configurable using `TextConfig`. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", + "description": "Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS", "id": "CleanTextTag", "properties": {}, "type": "object" @@ -6076,7 +6350,7 @@ "description": "Configures de-identification of text wherever it is found in the source_dataset." }, "useRegionalDataProcessing": { - "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated `DicomConfig` or `FhirConfig` are used, then `LOCATION` must be excluded within `TextConfig`, and must also be excluded within `ImageConfig` if image redaction is required.", + "description": "Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required.", "type": "boolean" } }, @@ -6264,6 +6538,42 @@ }, "type": "object" }, + "DicomStoreMetrics": { + "description": "DicomStoreMetrics contains metrics describing a DICOM store.", + "id": "DicomStoreMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the store.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the store.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Resource name of the DICOM store, of the form `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}`.", + "type": "string" + }, + "seriesCount": { + "description": "Number of series in the store.", + "format": "int64", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the store.", + "format": "int64", + "type": "string" + }, + "studyCount": { + "description": "Number of studies in the store.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "DicomTagConfig": { "description": "Specifies the parameters needed for the de-identification of DICOM stores.", "id": "DicomTagConfig", @@ -6692,7 +7002,7 @@ "enumDescriptions": [ "No profile provided. Same as `BASIC`.", "Keep all fields.", - "Transforms known [HIPAA 18](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html#standard)", + "Transforms known [HIPAA 18](https://www.hhs.gov/hipaa/for-professionals/privacy/special-topics/de-identification/index.html#standard) fields and cleans known unstructured text fields.", "Cleans all supported tags. Applies to types: Code, Date, DateTime, Decimal, HumanName, Id, LanguageCode, Markdown, Oid, String, Uri, Uuid, Xhtml." ], "type": "string" @@ -6735,7 +7045,7 @@ "id": "FhirOutput", "properties": { "fhirStore": { - "description": "Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set `enable_update_create` to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.", + "description": "Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations.", "type": "string" } }, @@ -7442,6 +7752,45 @@ }, "type": "object" }, + "Hl7V2StoreMetric": { + "description": "Count of messages and total storage size by type for a given HL7 store.", + "id": "Hl7V2StoreMetric", + "properties": { + "count": { + "description": "The total count of HL7v2 messages in the store for the given message type.", + "format": "int64", + "type": "string" + }, + "messageType": { + "description": "The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`.", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "The total amount of structured storage used by HL7v2 messages of this message type in the store.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, + "Hl7V2StoreMetrics": { + "description": "List of metrics for a given HL7v2 store.", + "id": "Hl7V2StoreMetrics", + "properties": { + "metrics": { + "description": "List of HL7v2 store metrics by message type.", + "items": { + "$ref": "Hl7V2StoreMetric" + }, + "type": "array" + }, + "name": { + "description": "The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id}/datasets/{dataset_id}/hl7V2Stores/{hl7v2_store_id}`.", + "type": "string" + } + }, + "type": "object" + }, "HttpBody": { "description": "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.", "id": "HttpBody", @@ -8745,6 +9094,32 @@ }, "type": "object" }, + "SeriesMetrics": { + "description": "SeriesMetrics contains metrics describing a DICOM series.", + "id": "SeriesMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the series.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the series.", + "format": "int64", + "type": "string" + }, + "series": { + "description": "The series resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}/series/{series_uid}`.", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the series.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -8837,6 +9212,37 @@ }, "type": "object" }, + "StudyMetrics": { + "description": "StudyMetrics contains metrics describing a DICOM study.", + "id": "StudyMetrics", + "properties": { + "blobStorageSizeBytes": { + "description": "Total blob storage bytes for all instances in the study.", + "format": "int64", + "type": "string" + }, + "instanceCount": { + "description": "Number of instances in the study.", + "format": "int64", + "type": "string" + }, + "seriesCount": { + "description": "Number of series in the study.", + "format": "int64", + "type": "string" + }, + "structuredStorageSizeBytes": { + "description": "Total structured storage bytes for all instances in the study.", + "format": "int64", + "type": "string" + }, + "study": { + "description": "The study resource path. For example, `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/dicomStores/{dicom_store_id}/dicomWeb/studies/{study_uid}`.", + "type": "string" + } + }, + "type": "object" + }, "TagFilterList": { "description": "List of tags to be filtered.", "id": "TagFilterList", diff --git a/discovery/iap-v1.json b/discovery/iap-v1.json index e6a70e0d16..5e21dd643e 100644 --- a/discovery/iap-v1.json +++ b/discovery/iap-v1.json @@ -682,7 +682,7 @@ } } }, - "revision": "20230915", + "revision": "20231006", "rootUrl": "https://iap.googleapis.com/", "schemas": { "AccessDeniedPageSettings": { @@ -1183,6 +1183,14 @@ "Resource": { "id": "Resource", "properties": { + "expectedNextState": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. When a proto is wrapped, it is generally the One Platform API proto. When a JSON string is wrapped, use `google.protobuf.StringValue` for the inner value. It is sufficient to pass just the max set of attributes that are allowed for use in custom constraints; other attributes can be omitted. See go/custom-constraints-org-policy-integration-guide for additional details.", + "type": "object" + }, "labels": { "additionalProperties": { "type": "string" diff --git a/discovery/index.json b/discovery/index.json index 887021014f..6f9bd8ff10 100644 --- a/discovery/index.json +++ b/discovery/index.json @@ -2447,6 +2447,21 @@ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, "documentationLink": "https://developers.google.com/display-video/", + "preferred": false + }, + { + "kind": "discovery#directoryItem", + "id": "displayvideo:v3", + "name": "displayvideo", + "version": "v3", + "title": "Display & Video 360 API", + "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.", + "discoveryRestUrl": "https://displayvideo.googleapis.com/$discovery/rest?version=v3", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://developers.google.com/display-video/", "preferred": true }, { @@ -3536,8 +3551,8 @@ "id": "indexing:v3", "name": "indexing", "version": "v3", - "title": "Indexing API", - "description": "Notifies Google when your web pages change.", + "title": "Web Search Indexing API", + "description": "Notifies Google Web Search when your web pages change.", "discoveryRestUrl": "https://indexing.googleapis.com/$discovery/rest?version=v3", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -5090,6 +5105,21 @@ "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" }, "documentationLink": "https://developers.google.com/safe-browsing/", + "preferred": false + }, + { + "kind": "discovery#directoryItem", + "id": "safebrowsing:v5", + "name": "safebrowsing", + "version": "v5", + "title": "Safe Browsing API", + "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", + "discoveryRestUrl": "https://safebrowsing.googleapis.com/$discovery/rest?version=v5", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://developers.google.com/safe-browsing/", "preferred": true }, { @@ -6082,6 +6112,21 @@ "documentationLink": "https://cloud.google.com/migrate/virtual-machines", "preferred": true }, + { + "kind": "discovery#directoryItem", + "id": "vmwareengine:v1", + "name": "vmwareengine", + "version": "v1", + "title": "VMware Engine API", + "description": "The Google VMware Engine API lets you programmatically manage VMware environments.", + "discoveryRestUrl": "https://vmwareengine.googleapis.com/$discovery/rest?version=v1", + "icons": { + "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", + "x32": "https://www.gstatic.com/images/branding/product/1x/googleg_32dp.png" + }, + "documentationLink": "https://cloud.google.com/solutions/vmware-as-a-service", + "preferred": true + }, { "kind": "discovery#directoryItem", "id": "vpcaccess:v1beta1", diff --git a/discovery/indexing-v3.json b/discovery/indexing-v3.json index 44e77828a8..61f6c40328 100644 --- a/discovery/indexing-v3.json +++ b/discovery/indexing-v3.json @@ -12,7 +12,7 @@ "baseUrl": "https://indexing.googleapis.com/", "batchPath": "batch", "canonicalName": "Indexing", - "description": "Notifies Google when your web pages change.", + "description": "Notifies Google Web Search when your web pages change.", "discoveryVersion": "v1", "documentationLink": "https://developers.google.com/search/apis/indexing-api/", "fullyEncodeReservedExpansion": true, @@ -149,7 +149,7 @@ } } }, - "revision": "20200804", + "revision": "20231003", "rootUrl": "https://indexing.googleapis.com/", "schemas": { "PublishUrlNotificationResponse": { @@ -214,7 +214,7 @@ } }, "servicePath": "", - "title": "Indexing API", + "title": "Web Search Indexing API", "version": "v3", "version_module": true } \ No newline at end of file diff --git a/discovery/integrations-v1alpha.json b/discovery/integrations-v1alpha.json index 306330ed01..bdb5f3d2cf 100644 --- a/discovery/integrations-v1alpha.json +++ b/discovery/integrations-v1alpha.json @@ -939,7 +939,7 @@ "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.", + "description": "* Lifts suspension for the 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}/integrations/{integrationsId}/executions/{executionsId}/suspensions/{suspensionsId}:lift", "httpMethod": "POST", "id": "integrations.projects.locations.integrations.executions.suspensions.lift", @@ -1372,6 +1372,215 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "testCases": { + "methods": { + "create": { + "description": "Creates a new test case", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "testCaseId": { + "description": "Required. Required", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/testCases", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a test case", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "DELETE", + "id": "integrations.projects.locations.integrations.versions.testCases.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. ID for the test case to be deleted", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "executeTest": { + "description": "Executes functional test", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executeTest", + "httpMethod": "POST", + "id": "integrations.projects.locations.integrations.versions.testCases.executeTest", + "parameterOrder": [ + "testCaseName" + ], + "parameters": { + "testCaseName": { + "description": "Required. Test case resource name", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+testCaseName}:executeTest", + "request": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Get a test case", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The ID of the test case to retrieve", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+name}", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "listExecutions": { + "description": "Lists the results of all functional test executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}:executions", + "httpMethod": "GET", + "id": "integrations.projects.locations.integrations.versions.testCases.listExecutions", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field, we support filtering on following fields: test_case_id: the ID of the test case. CreateTimestamp: the execution created time. event_execution_state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. parameter_type: the type of the parameters involved in the execution. All fields support for EQUALS, in additional: CreateTimestamp support for LESS_THAN, GREATER_THAN ParameterType support for HAS For example: \"parameter_type\" HAS \\\"string\\\" Also supports operators like AND, OR, NOT For example, trigger_id=\\\"id1\\\" AND test_case_id=\\\"testCaseId\\\"", + "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 test case execution.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "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" + }, + "truncateParams": { + "deprecated": true, + "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": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates a test case", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/versions/{versionsId}/testCases/{testCasesId}", + "httpMethod": "PATCH", + "id": "integrations.projects.locations.integrations.versions.testCases.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. Auto-generated primary key.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/versions/[^/]+/testCases/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Optional. 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": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -2055,7 +2264,7 @@ "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.", + "description": "* Lifts suspension for the 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", @@ -2488,6 +2697,64 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "testCases": { + "methods": { + "list": { + "description": "Lists all the test cases that satisfy the filters.", + "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/products/{productsId}/integrations/{integrationsId}/versions/{versionsId}/testCases", + "httpMethod": "GET", + "id": "integrations.projects.locations.products.integrations.versions.testCases.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Standard filter field. Filtering as supported in https://developers.google.com/authorized-buyers/apis/guides/list-filters.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. The results would be returned in order specified here. Currently supported sort keys are: Descending sort order for \"last_modified_time\", \"created_time\". Ascending sort order for \"name\".", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of test cases to return. The service may return fewer than this value. If unspecified, at most 100 test cases will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A page token, received from a previous `ListTestCases` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTestCases` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource where this TestCase was created.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/products/[^/]+/integrations/[^/]+/versions/[^/]+$", + "required": true, + "type": "string" + }, + "readMask": { + "description": "Optional. The mask which specifies fields that need to be returned in the TestCases's response.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1alpha/{+parent}/testCases", + "response": { + "$ref": "GoogleCloudIntegrationsV1alphaListTestCasesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -3257,7 +3524,7 @@ } } }, - "revision": "20230906", + "revision": "20231006", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -8276,6 +8543,12 @@ "description": "This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version", "id": "GoogleCloudConnectorsV1ConnectorVersionInfraConfig", "properties": { + "connectionRatelimitWindowSeconds": { + "description": "Output only. The window used for ratelimiting runtime requests to connections.", + "format": "int64", + "readOnly": true, + "type": "string" + }, "hpaConfig": { "$ref": "GoogleCloudConnectorsV1HPAConfig", "description": "Output only. HPA autoscaling config.", @@ -8324,6 +8597,7 @@ "type": "integer" }, "serviceAttachment": { + "deprecated": true, "description": "PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*", "type": "string" } @@ -8396,14 +8670,14 @@ "description": "Enrichment Enabled.", "type": "boolean" }, + "eventsListenerIngressEndpoint": { + "description": "Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.", + "type": "string" + }, "privateConnectivityEnabled": { "description": "Optional. Private Connectivity Enabled.", "type": "boolean" }, - "publicEventsListenerEndpoint": { - "description": "Optional. Public Events listener endpoint.", - "type": "string" - }, "registrationDestinationConfig": { "$ref": "GoogleCloudConnectorsV1DestinationConfig", "description": "Registration endpoint for auto registration." @@ -8420,6 +8694,11 @@ "readOnly": true, "type": "string" }, + "eventsListenerPscSa": { + "description": "Output only. Events listener PSC Service attachment. The value will be populated after provisioning the events listener with private connectivity enabled.", + "readOnly": true, + "type": "string" + }, "status": { "$ref": "GoogleCloudConnectorsV1EventingStatus", "description": "Output only. Current status of eventing.", @@ -8443,13 +8722,13 @@ "STATE_UNSPECIFIED", "ACTIVE", "ERROR", - "PUBLIC_ENDPOINT_REQUIRED" + "INGRESS_ENDPOINT_REQUIRED" ], "enumDescriptions": [ "Default state.", "Eventing is enabled and ready to receive events.", "Eventing is not active due to an error.", - "Public endpoint required." + "Ingress endpoint required." ], "readOnly": true, "type": "string" @@ -8679,6 +8958,50 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaAssertion": { + "description": "An assertion which will check for a condition over task execution status or an expression for task output variables Next available id: 5", + "id": "GoogleCloudIntegrationsV1alphaAssertion", + "properties": { + "assertionStrategy": { + "description": "The type of assertion to perform.", + "enum": [ + "ASSERTION_STRATEGY_UNSPECIFIED", + "ASSERT_SUCCESSFUL_EXECUTION", + "ASSERT_FAILED_EXECUTION", + "ASSERT_NO_EXECUTION", + "ASSERT_EQUALS", + "ASSERT_NOT_EQUALS", + "ASSERT_CONTAINS", + "ASSERT_CONDITION" + ], + "enumDescriptions": [ + "Unspecified Assertion strategy", + "Test a successful execution", + "Test a failed execution", + "Test that the task was never executed", + "Test the parameter selected is equal to the expected value", + "Test the parameter selected is not equal to the expected value", + "Test the parameter selected contains the configured value", + "Test a specific condition" + ], + "type": "string" + }, + "condition": { + "description": "Optional. Standard filter expression for ASSERT_CONDITION to succeed", + "type": "string" + }, + "parameter": { + "$ref": "GoogleCloudIntegrationsV1alphaEventParameter", + "description": "Optional. Key-value pair for ASSERT_EQUALS, ASSERT_NOT_EQUALS, ASSERT_CONTAINS to succeed" + }, + "retryCount": { + "description": "Number of times given task should be retried in case of ASSERT_FAILED_EXECUTION", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaAttemptStats": { "description": "Status for the execution attempt.", "id": "GoogleCloudIntegrationsV1alphaAttemptStats", @@ -9300,6 +9623,39 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest": { + "description": "The request for executing a functional test.", + "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseRequest", + "properties": { + "inputParameters": { + "additionalProperties": { + "$ref": "GoogleCloudIntegrationsV1alphaValueType" + }, + "description": "Optional. Input parameters used by test case execution.", + "type": "object" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse": { + "description": "The response for executing a functional test.", + "id": "GoogleCloudIntegrationsV1alphaExecuteTestCaseResponse", + "properties": { + "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" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaExecution": { "description": "The Execution resource contains detailed information of an individual integration execution.", "id": "GoogleCloudIntegrationsV1alphaExecution", @@ -9779,11 +10135,13 @@ "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" + "DATABASE_PERSISTENCE_DISABLED", + "DATABASE_PERSISTENCE_ASYNC" ], "enumDescriptions": [ "Enables persistence for all execution data.", - "Disables persistence for all execution data." + "Disables persistence for all execution data.", + "Asynchronously persist all execution data." ], "type": "string" }, @@ -9884,11 +10242,13 @@ "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" + "DATABASE_PERSISTENCE_DISABLED", + "DATABASE_PERSISTENCE_ASYNC" ], "enumDescriptions": [ "Enables persistence for all execution data.", - "Disables persistence for all execution data." + "Disables persistence for all execution data.", + "Asynchronously persist all execution data." ], "type": "string" }, @@ -10349,6 +10709,79 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse": { + "description": "The response for listing the functional test execution data.", + "id": "GoogleCloudIntegrationsV1alphaListTestCaseExecutionsResponse", + "properties": { + "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" + }, + "GoogleCloudIntegrationsV1alphaListTestCasesResponse": { + "description": "Response for ListTestCases", + "id": "GoogleCloudIntegrationsV1alphaListTestCasesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "testCases": { + "description": "The test cases corresponding to the specified filter", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTestCase" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaMockConfig": { + "description": "The configuration for mocking of a task during test execution Next available id: 4", + "id": "GoogleCloudIntegrationsV1alphaMockConfig", + "properties": { + "failedExecutions": { + "description": "Optional. Number of times the given task should fail for failure mock strategy", + "format": "int64", + "type": "string" + }, + "mockStrategy": { + "description": "Mockstrategy defines how the particular task should be mocked during test execution", + "enum": [ + "MOCK_STRATEGY_UNSPECIFIED", + "NO_MOCK_STRATEGY", + "SPECIFIC_MOCK_STRATEGY", + "FAILURE_MOCK_STRATEGY", + "SKIP_MOCK_STRATEGY" + ], + "enumDescriptions": [ + "This should never be used to annotate a field", + "Execute actual task", + "Don't execute actual task, instead use the values specified by user for output of the task", + "Don't execute actual task, instead return task failure", + "Don't execute actual task, instead mark it as successful" + ], + "type": "string" + }, + "parameters": { + "description": "Optional. List of key-value pairs for specific mock strategy", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaEventParameter" + }, + "type": "array" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaNextTask": { "description": "The task that is next in line to be executed, if the condition specified evaluated to true.", "id": "GoogleCloudIntegrationsV1alphaNextTask", @@ -11261,6 +11694,110 @@ }, "type": "object" }, + "GoogleCloudIntegrationsV1alphaTestCase": { + "description": "Defines the functional test case for Application Integration. Next available id: 15", + "id": "GoogleCloudIntegrationsV1alphaTestCase", + "properties": { + "createTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "creatorEmail": { + "description": "Optional. The creator's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "databasePersistencePolicy": { + "description": "Optional. Various policies for how to persist the test execution info including execution info, execution export info, execution metadata index and execution param index..", + "enum": [ + "DATABASE_PERSISTENCE_POLICY_UNSPECIFIED", + "DATABASE_PERSISTENCE_DISABLED", + "DATABASE_PERSISTENCE_ASYNC" + ], + "enumDescriptions": [ + "Enables persistence for all execution data.", + "Disables persistence for all execution data.", + "Asynchronously persist all execution data." + ], + "type": "string" + }, + "description": { + "description": "Optional. Description of the test case.", + "type": "string" + }, + "displayName": { + "description": "Required. The display name of test case.", + "type": "string" + }, + "lastModifierEmail": { + "description": "The last modifer's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", + "type": "string" + }, + "lockHolderEmail": { + "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" + }, + "testInputParameters": { + "description": "Optional. Parameters that are expected to be passed to the test case when the test case is triggered. This gives the user the ability to provide default values. This should include all the output variables of the trigger as input variables.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaIntegrationParameter" + }, + "type": "array" + }, + "testTaskConfigs": { + "description": "Optional. However, the test case doesn't mock or assert anything without test_task_configs.", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaTestTaskConfig" + }, + "type": "array" + }, + "triggerId": { + "description": "Required. This defines the trigger ID in workflow which is considered to be executed as starting point of the test case", + "type": "string" + }, + "updateTime": { + "description": "Auto-generated.", + "format": "google-datetime", + "type": "string" + }, + "workflowId": { + "description": "ID of the workflow with which this test case is associated", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudIntegrationsV1alphaTestTaskConfig": { + "description": "The task mock configuration details and assertions for functional tests. Next available id: 5", + "id": "GoogleCloudIntegrationsV1alphaTestTaskConfig", + "properties": { + "assertions": { + "description": "Optional. List of conditions or expressions which should be evaluated to true unless there is a bug/problem in the integration. These are evaluated one the task execution is completed as per the mock strategy in test case", + "items": { + "$ref": "GoogleCloudIntegrationsV1alphaAssertion" + }, + "type": "array" + }, + "mockConfig": { + "$ref": "GoogleCloudIntegrationsV1alphaMockConfig", + "description": "Optional. Defines how to mock the given task during test execution" + }, + "task": { + "description": "Required. This defines in the test case, the task name in integration which will be mocked by this test task config", + "type": "string" + }, + "taskNumber": { + "description": "Required. This defines in the test case, the task in integration which will be mocked by this test task config", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudIntegrationsV1alphaTriggerConfig": { "description": "Configuration detail of a trigger.", "id": "GoogleCloudIntegrationsV1alphaTriggerConfig", @@ -11462,7 +11999,7 @@ "type": "object" }, "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest": { - "description": "Use this request to post all workflows associated with a given trigger id. Next available id: 11", + "description": "LINT.IfChange Use this request to post all workflows associated with a given trigger id. Next available id: 12", "id": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest", "properties": { "clientId": { @@ -11516,6 +12053,10 @@ "description": "Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.", "type": "string" }, + "userGeneratedExecutionId": { + "description": "This is a unique id provided by the method caller. If provided this will be used as the execution_id when a new execution info is created. This is a string representation of a UUID. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.", + "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" diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index 99b058da59..d8fa3f54b6 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -29,8 +29,8 @@ "documentationLink": "https://cloud.google.com/logging/docs/", "endpoints": [ { - "location": "me-central2", "endpointUrl": "https://logging.me-central2.rep.googleapis.com/", + "location": "me-central2", "description": "Regional Endpoint" } ], @@ -7084,7 +7084,7 @@ } } }, - "revision": "20230924", + "revision": "20230928", "rootUrl": "https://logging.googleapis.com/", "schemas": { "BigQueryDataset": { diff --git a/discovery/metastore-v1.json b/discovery/metastore-v1.json index a6c0bc3767..237889ed7e 100644 --- a/discovery/metastore-v1.json +++ b/discovery/metastore-v1.json @@ -1339,7 +1339,7 @@ } } }, - "revision": "20230905", + "revision": "20230926", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2023,6 +2023,10 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "multiRegionMetadata": { + "$ref": "MultiRegionMetadata", + "description": "The multi-region metadata if the current region is a multi-region." + }, "supportedHiveMetastoreVersions": { "description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.", "items": { @@ -2231,6 +2235,20 @@ "properties": {}, "type": "object" }, + "MultiRegionMetadata": { + "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty.", + "id": "MultiRegionMetadata", + "properties": { + "constituentRegions": { + "description": "The regions constituting the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the Dataproc Metastore service.Next available ID: 4", "id": "NetworkConfig", diff --git a/discovery/metastore-v1alpha.json b/discovery/metastore-v1alpha.json index c1702f57bb..b364d3fc6e 100644 --- a/discovery/metastore-v1alpha.json +++ b/discovery/metastore-v1alpha.json @@ -1579,7 +1579,7 @@ } } }, - "revision": "20230905", + "revision": "20230926", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2301,6 +2301,10 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "multiRegionMetadata": { + "$ref": "MultiRegionMetadata", + "description": "The multi-region metadata if the current region is a multi-region." + }, "supportedHiveMetastoreVersions": { "description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.", "items": { @@ -2524,6 +2528,20 @@ "properties": {}, "type": "object" }, + "MultiRegionMetadata": { + "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty.", + "id": "MultiRegionMetadata", + "properties": { + "constituentRegions": { + "description": "The regions constituting the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the Dataproc Metastore service.Next available ID: 4", "id": "NetworkConfig", diff --git a/discovery/metastore-v1beta.json b/discovery/metastore-v1beta.json index 5f4e4b5d6f..e6753284f0 100644 --- a/discovery/metastore-v1beta.json +++ b/discovery/metastore-v1beta.json @@ -1579,7 +1579,7 @@ } } }, - "revision": "20230905", + "revision": "20230926", "rootUrl": "https://metastore.googleapis.com/", "schemas": { "AlterMetadataResourceLocationRequest": { @@ -2301,6 +2301,10 @@ "description": "Metadata about the service in a location.", "id": "LocationMetadata", "properties": { + "multiRegionMetadata": { + "$ref": "MultiRegionMetadata", + "description": "The multi-region metadata if the current region is a multi-region." + }, "supportedHiveMetastoreVersions": { "description": "The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default.", "items": { @@ -2524,6 +2528,20 @@ "properties": {}, "type": "object" }, + "MultiRegionMetadata": { + "description": "The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty.", + "id": "MultiRegionMetadata", + "properties": { + "constituentRegions": { + "description": "The regions constituting the multi-region.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for the Dataproc Metastore service.Next available ID: 4", "id": "NetworkConfig", diff --git a/discovery/migrationcenter-v1.json b/discovery/migrationcenter-v1.json index ee4de55cda..dfd4043d10 100644 --- a/discovery/migrationcenter-v1.json +++ b/discovery/migrationcenter-v1.json @@ -2099,7 +2099,7 @@ } } }, - "revision": "20230908", + "revision": "20230928", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3126,11 +3126,11 @@ "type": "object" }, "GenericInsight": { - "description": "An insight about an asset (experimental insight)", + "description": "A generic insight about an asset.", "id": "GenericInsight", "properties": { "additionalInformation": { - "description": "Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links", + "description": "Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links.", "items": { "type": "string" }, @@ -3502,7 +3502,7 @@ "type": "string" }, "displayName": { - "description": "User-friendly display name. Maximum length is 63 characters.", + "description": "Optional. User-friendly display name. Maximum length is 256 characters.", "type": "string" }, "executionReport": { @@ -4515,7 +4515,7 @@ "description": "Network usage sample." }, "sampleTime": { - "description": "Time the sample was If omitted, the frame report time will be used.", + "description": "Time the sample was collected. If omitted, the frame report time will be used.", "format": "google-datetime", "type": "string" } diff --git a/discovery/migrationcenter-v1alpha1.json b/discovery/migrationcenter-v1alpha1.json index 5f757cdbf1..fcb1c8fdc2 100644 --- a/discovery/migrationcenter-v1alpha1.json +++ b/discovery/migrationcenter-v1alpha1.json @@ -2102,7 +2102,7 @@ } } }, - "revision": "20230908", + "revision": "20230928", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -3224,11 +3224,11 @@ "type": "object" }, "GenericInsight": { - "description": "An insight about an asset (experimental insight)", + "description": "A generic insight about an asset.", "id": "GenericInsight", "properties": { "additionalInformation": { - "description": "Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links", + "description": "Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links.", "items": { "type": "string" }, @@ -3470,7 +3470,7 @@ "type": "string" }, "displayName": { - "description": "User-friendly display name. Maximum length is 63 characters.", + "description": "Optional. User-friendly display name. Maximum length is 256 characters.", "type": "string" }, "format": { @@ -5781,7 +5781,7 @@ "type": "object" }, "VirtualMachinePreferences": { - "description": "VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets.", + "description": "VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets.", "id": "VirtualMachinePreferences", "properties": { "commitmentPlan": { @@ -5804,23 +5804,33 @@ "$ref": "ComputeEnginePreferences", "description": "Compute Engine preferences concern insights and recommendations for Compute Engine target." }, + "networkCostParameters": { + "$ref": "VirtualMachinePreferencesNetworkCostParameters", + "description": "Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters." + }, "regionPreferences": { "$ref": "RegionPreferences", "description": "Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with." }, + "sizingOptimizationCustomParameters": { + "$ref": "VirtualMachinePreferencesSizingOptimizationCustomParameters", + "description": "Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to \"custom\"." + }, "sizingOptimizationStrategy": { "description": "Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with.", "enum": [ "SIZING_OPTIMIZATION_STRATEGY_UNSPECIFIED", "SIZING_OPTIMIZATION_STRATEGY_SAME_AS_SOURCE", "SIZING_OPTIMIZATION_STRATEGY_MODERATE", - "SIZING_OPTIMIZATION_STRATEGY_AGGRESSIVE" + "SIZING_OPTIMIZATION_STRATEGY_AGGRESSIVE", + "SIZING_OPTIMIZATION_STRATEGY_CUSTOM" ], "enumDescriptions": [ "Unspecified (default value).", "No optimization applied. Virtual machine sizing matches as closely as possible the machine shape on the source site, not considering any actual performance data.", "Virtual machine sizing will match the reported usage and shape, with some slack. This a good value to start with.", - "Virtual machine sizing will match the reported usage, with little slack. Using this option can help reduce costs." + "Virtual machine sizing will match the reported usage, with little slack. Using this option can help reduce costs.", + "Virtual machine sizing will be determined by custom parameters. While not supported in the v1 API, this value is converted to UNSPECIFIED in conversions to the v1 API." ], "type": "string" }, @@ -5851,6 +5861,58 @@ }, "type": "object" }, + "VirtualMachinePreferencesNetworkCostParameters": { + "description": "Parameters that affect network cost estimations.", + "id": "VirtualMachinePreferencesNetworkCostParameters", + "properties": { + "estimatedEgressTrafficPercentage": { + "description": "Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100].", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "VirtualMachinePreferencesSizingOptimizationCustomParameters": { + "description": "Custom data to use for sizing optimizations.", + "id": "VirtualMachinePreferencesSizingOptimizationCustomParameters", + "properties": { + "aggregationMethod": { + "description": "Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics.", + "enum": [ + "AGGREGATION_METHOD_UNSPECIFIED", + "AGGREGATION_METHOD_AVERAGE", + "AGGREGATION_METHOD_MEDIAN", + "AGGREGATION_METHOD_NINETY_FIFTH_PERCENTILE", + "AGGREGATION_METHOD_PEAK" + ], + "enumDescriptions": [ + "Unspecified aggregation method. Can be used for default value.", + "Average of utilization data.", + "Median of utilization data.", + "95th percentile of utilization data.", + "Peak of utilization data." + ], + "type": "string" + }, + "cpuUsagePercentage": { + "description": "Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value).", + "format": "int32", + "type": "integer" + }, + "memoryUsagePercentage": { + "description": "Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value).", + "format": "int32", + "type": "integer" + }, + "storageMultiplier": { + "description": "Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value).", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, "VmwareDiskConfig": { "description": "VMware disk config details.", "id": "VmwareDiskConfig", diff --git a/discovery/monitoring-v1.json b/discovery/monitoring-v1.json index a153438d62..65121a22c2 100644 --- a/discovery/monitoring-v1.json +++ b/discovery/monitoring-v1.json @@ -753,7 +753,7 @@ } } }, - "revision": "20230918", + "revision": "20231001", "rootUrl": "https://monitoring.googleapis.com/", "schemas": { "Aggregation": { @@ -2241,6 +2241,40 @@ ], "type": "string" }, + "pointerLocation": { + "description": "The pointer location for this widget (also sometimes called a \"tail\")", + "enum": [ + "POINTER_LOCATION_UNSPECIFIED", + "PL_TOP", + "PL_RIGHT", + "PL_BOTTOM", + "PL_LEFT", + "PL_TOP_LEFT", + "PL_TOP_RIGHT", + "PL_RIGHT_TOP", + "PL_RIGHT_BOTTOM", + "PL_BOTTOM_RIGHT", + "PL_BOTTOM_LEFT", + "PL_LEFT_BOTTOM", + "PL_LEFT_TOP" + ], + "enumDescriptions": [ + "No visual pointer", + "Placed in the middle of the top of the widget", + "Placed in the middle of the right side of the widget", + "Placed in the middle of the bottom of the widget", + "Placed in the middle of the left side of the widget", + "Placed on the left side of the top of the widget", + "Placed on the right side of the top of the widget", + "Placed on the top of the right side of the widget", + "Placed on the bottom of the right side of the widget", + "Placed on the right side of the bottom of the widget", + "Placed on the left side of the bottom of the widget", + "Placed on the bottom of the left side of the widget", + "Placed on the top of the left side of the widget" + ], + "type": "string" + }, "textColor": { "description": "The text color as a hex string. \"#RRGGBB\" or \"#RGB\"", "type": "string" diff --git a/discovery/networkconnectivity-v1.json b/discovery/networkconnectivity-v1.json index b9a6ee212c..29d86c582e 100644 --- a/discovery/networkconnectivity-v1.json +++ b/discovery/networkconnectivity-v1.json @@ -182,7 +182,7 @@ "hubs": { "methods": { "acceptSpoke": { - "description": "Accepts a proposal to attach a Network Connectivity Center spoke to the hub.", + "description": "Accepts a proposal to attach a Network Connectivity Center spoke to a hub.", "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:acceptSpoke", "httpMethod": "POST", "id": "networkconnectivity.projects.locations.global.hubs.acceptSpoke", @@ -191,7 +191,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the hub.", + "description": "Required. The name of the hub into which to accept the spoke.", "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "required": true, @@ -231,7 +231,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -264,7 +264,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -463,7 +463,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -486,7 +486,7 @@ ] }, "rejectSpoke": { - "description": "Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub.", + "description": "Rejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub.", "flatPath": "v1/projects/{projectsId}/locations/global/hubs/{hubsId}:rejectSpoke", "httpMethod": "POST", "id": "networkconnectivity.projects.locations.global.hubs.rejectSpoke", @@ -495,7 +495,7 @@ ], "parameters": { "name": { - "description": "Required. The name of the hub.", + "description": "Required. The name of the hub from which to reject the spoke.", "location": "path", "pattern": "^projects/[^/]+/locations/global/hubs/[^/]+$", "required": true, @@ -890,7 +890,7 @@ "policyBasedRoutes": { "methods": { "create": { - "description": "Creates a new PolicyBasedRoute in a given project and location.", + "description": "Creates a new policy-based route in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes", "httpMethod": "POST", "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.create", @@ -906,7 +906,7 @@ "type": "string" }, "policyBasedRouteId": { - "description": "Required. Unique id for the Policy Based Route to create.", + "description": "Required. Unique id for the policy-based route to create.", "location": "query", "type": "string" }, @@ -928,7 +928,7 @@ ] }, "delete": { - "description": "Deletes a single PolicyBasedRoute.", + "description": "Deletes a single policy-based route.", "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}", "httpMethod": "DELETE", "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.delete", @@ -937,7 +937,7 @@ ], "parameters": { "name": { - "description": "Required. Name of the PolicyBasedRoute resource to delete.", + "description": "Required. Name of the policy-based route resource to delete.", "location": "path", "pattern": "^projects/[^/]+/locations/global/policyBasedRoutes/[^/]+$", "required": true, @@ -958,7 +958,7 @@ ] }, "get": { - "description": "Gets details of a single PolicyBasedRoute.", + "description": "Gets details of a single policy-based route.", "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes/{policyBasedRoutesId}", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.get", @@ -1014,7 +1014,7 @@ ] }, "list": { - "description": "Lists PolicyBasedRoutes in a given project and location.", + "description": "Lists policy-based routes in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/global/policyBasedRoutes", "httpMethod": "GET", "id": "networkconnectivity.projects.locations.global.policyBasedRoutes.list", @@ -2403,7 +2403,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -2441,7 +2441,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" } @@ -2573,7 +2573,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "location": "query", "type": "string" }, @@ -2686,7 +2686,7 @@ } } }, - "revision": "20230906", + "revision": "20230921", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2694,7 +2694,7 @@ "id": "AcceptHubSpokeRequest", "properties": { "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "spokeUri": { @@ -2720,7 +2720,7 @@ "id": "AcceptSpokeRequest", "properties": { "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } }, @@ -2945,15 +2945,15 @@ "id": "Filter", "properties": { "destRange": { - "description": "Optional. The destination IP range of outgoing packets that this policy based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", + "description": "Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", "type": "string" }, "ipProtocol": { - "description": "Optional. The IP protocol that this policy based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.", + "description": "Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'.", "type": "string" }, "protocolVersion": { - "description": "Required. Internet protocol versions this policy based route applies to. For this version, only IPV4 is supported.", + "description": "Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported.", "enum": [ "PROTOCOL_VERSION_UNSPECIFIED", "IPV4" @@ -2965,7 +2965,7 @@ "type": "string" }, "srcRange": { - "description": "Optional. The source IP range of outgoing packets that this policy based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", + "description": "Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is \"0.0.0.0/0\" if protocol version is IPv4.", "type": "string" } }, @@ -3232,11 +3232,11 @@ "type": "object" }, "InterconnectAttachment": { - "description": "InterconnectAttachment to which this route applies to.", + "description": "InterconnectAttachment that this route applies to.", "id": "InterconnectAttachment", "properties": { "region": { - "description": "Optional. Cloud region to install this policy based route on interconnect attachment. Use `all` to install it on all interconnect attachments.", + "description": "Optional. Cloud region to install this policy-based route on interconnect attachment. Use `all` to install it on all interconnect attachments.", "type": "string" } }, @@ -3563,7 +3563,7 @@ "type": "string" }, "policyBasedRoutes": { - "description": "Policy based routes to be returned.", + "description": "Policy-based routes to be returned.", "items": { "$ref": "PolicyBasedRoute" }, @@ -3898,11 +3898,11 @@ "type": "object" }, "PolicyBasedRoute": { - "description": "Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22", + "description": "Policy-based routes route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the policy-based route always take precedence.", "id": "PolicyBasedRoute", "properties": { "createTime": { - "description": "Output only. Time when the PolicyBasedRoute was created.", + "description": "Output only. Time when the policy-based route was created.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -3917,10 +3917,10 @@ }, "interconnectAttachment": { "$ref": "InterconnectAttachment", - "description": "Optional. The interconnect attachments to which this route applies to." + "description": "Optional. The interconnect attachments that this policy-based route applies to." }, "kind": { - "description": "Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources.", + "description": "Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources.", "readOnly": true, "type": "string" }, @@ -3936,11 +3936,11 @@ "type": "string" }, "network": { - "description": "Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network.", + "description": "Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network.", "type": "string" }, "nextHopIlbIp": { - "description": "Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported.", + "description": "Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported.", "type": "string" }, "nextHopOtherRoutes": { @@ -3956,7 +3956,7 @@ "type": "string" }, "priority": { - "description": "Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.", + "description": "Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive.", "format": "int32", "type": "integer" }, @@ -3966,14 +3966,14 @@ "type": "string" }, "updateTime": { - "description": "Output only. Time when the PolicyBasedRoute was updated.", + "description": "Output only. Time when the policy-based route was updated.", "format": "google-datetime", "readOnly": true, "type": "string" }, "virtualMachine": { "$ref": "VirtualMachine", - "description": "Optional. VM instances to which this policy based route applies to." + "description": "Optional. VM instances to which this policy-based route applies to." }, "warnings": { "description": "Output only. If potential misconfigurations are detected for this route, this field will be populated with warning messages.", @@ -4096,7 +4096,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" }, "spokeUri": { @@ -4126,7 +4126,7 @@ "type": "string" }, "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", "type": "string" } }, @@ -4909,11 +4909,11 @@ "type": "object" }, "VirtualMachine": { - "description": "VM instances to which this policy based route applies to.", + "description": "VM instances to which this policy-based route applies to.", "id": "VirtualMachine", "properties": { "tags": { - "description": "Optional. A list of VM instance tags to which this policy based route applies to. VM instances that have ANY of tags specified here will install this PBR.", + "description": "Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR.", "items": { "type": "string" }, @@ -4935,8 +4935,8 @@ ], "enumDescriptions": [ "Default value.", - "The policy based route is not active and functioning. Common causes are the dependent network was deleted or the resource project was turned off.", - "The policy based route is being modified (e.g. created/deleted) at this time." + "The policy-based route is not active and functioning. Common causes are the dependent network was deleted or the resource project was turned off.", + "The policy-based route is being modified (e.g. created/deleted) at this time." ], "readOnly": true, "type": "string" diff --git a/discovery/networksecurity-v1beta1.json b/discovery/networksecurity-v1beta1.json index 2f2be5eff6..b02b3bd9e1 100644 --- a/discovery/networksecurity-v1beta1.json +++ b/discovery/networksecurity-v1beta1.json @@ -842,7 +842,7 @@ ], "parameters": { "name": { - "description": "Immutable. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "description": "Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfileGroups/[^/]+$", "required": true, @@ -1004,7 +1004,7 @@ ], "parameters": { "name": { - "description": "Immutable. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", + "description": "Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", "location": "path", "pattern": "^organizations/[^/]+/locations/[^/]+/securityProfiles/[^/]+$", "required": true, @@ -3162,7 +3162,7 @@ } } }, - "revision": "20230918", + "revision": "20231003", "rootUrl": "https://networksecurity.googleapis.com/", "schemas": { "AddAddressGroupItemsRequest": { @@ -3468,6 +3468,10 @@ "readOnly": true, "type": "string" }, + "description": { + "description": "Optional. Description of the firewall endpoint. Max length 2048 characters.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -4398,7 +4402,7 @@ "type": "object" }, "name": { - "description": "Immutable. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", + "description": "Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfiles/{security_profile}`.", "type": "string" }, "threatPreventionProfile": { @@ -4453,7 +4457,7 @@ "type": "object" }, "name": { - "description": "Immutable. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", + "description": "Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/*/locations/{location}/securityProfileGroups/{security_profile_group}`.", "type": "string" }, "threatPreventionProfile": { diff --git a/discovery/networkservices-v1.json b/discovery/networkservices-v1.json index 0113563694..b28583cf02 100644 --- a/discovery/networkservices-v1.json +++ b/discovery/networkservices-v1.json @@ -2148,7 +2148,7 @@ } } }, - "revision": "20230910", + "revision": "20230927", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2705,6 +2705,10 @@ "$ref": "GrpcRouteRetryPolicy", "description": "Optional. Specifies the retry policy associated with this route." }, + "statefulSessionAffinity": { + "$ref": "GrpcRouteStatefulSessionAffinityPolicy", + "description": "Optional. Specifies cookie-based stateful session affinity." + }, "timeout": { "description": "Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.", "format": "google-duration", @@ -2749,6 +2753,18 @@ }, "type": "object" }, + "GrpcRouteStatefulSessionAffinityPolicy": { + "description": "The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name \"GSSA\" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.", + "id": "GrpcRouteStatefulSessionAffinityPolicy", + "properties": { + "cookieTtl": { + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "HttpRoute": { "description": "HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.", "id": "HttpRoute", @@ -3168,6 +3184,10 @@ "$ref": "HttpRouteRetryPolicy", "description": "Specifies the retry policy associated with this route." }, + "statefulSessionAffinity": { + "$ref": "HttpRouteStatefulSessionAffinityPolicy", + "description": "Optional. Specifies cookie-based stateful session affinity." + }, "timeout": { "description": "Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.", "format": "google-duration", @@ -3235,6 +3255,18 @@ }, "type": "object" }, + "HttpRouteStatefulSessionAffinityPolicy": { + "description": "The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name \"GSSA\" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.", + "id": "HttpRouteStatefulSessionAffinityPolicy", + "properties": { + "cookieTtl": { + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "HttpRouteURLRewrite": { "description": "The specification for modifying the URL of the request, prior to forwarding the request to the destination.", "id": "HttpRouteURLRewrite", diff --git a/discovery/networkservices-v1beta1.json b/discovery/networkservices-v1beta1.json index 21f7267682..717c2d936b 100644 --- a/discovery/networkservices-v1beta1.json +++ b/discovery/networkservices-v1beta1.json @@ -979,6 +979,370 @@ } } }, + "lbRouteExtensions": { + "methods": { + "create": { + "description": "Creates a new `LbRouteExtension` resource in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions", + "httpMethod": "POST", + "id": "networkservices.projects.locations.lbRouteExtensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "lbRouteExtensionId": { + "description": "Required. User-provided ID of the `LbRouteExtension` resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/lbRouteExtensions", + "request": { + "$ref": "LbRouteExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified `LbRouteExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.lbRouteExtensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbRouteExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specified `LbRouteExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbRouteExtensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbRouteExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "LbRouteExtension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `LbRouteExtension` resources in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbRouteExtensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/lbRouteExtensions", + "response": { + "$ref": "ListLbRouteExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of the specified `LbRouteExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbRouteExtensions/{lbRouteExtensionsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.lbRouteExtensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbRouteExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "LbRouteExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "lbTrafficExtensions": { + "methods": { + "create": { + "description": "Creates a new `LbTrafficExtension` resource in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions", + "httpMethod": "POST", + "id": "networkservices.projects.locations.lbTrafficExtensions.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "lbTrafficExtensionId": { + "description": "Required. User-provided ID of the `LbTrafficExtension` resource to be created.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+parent}/lbTrafficExtensions", + "request": { + "$ref": "LbTrafficExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes the specified `LbTrafficExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}", + "httpMethod": "DELETE", + "id": "networkservices.projects.locations.lbTrafficExtensions.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbTrafficExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets details of the specified `LbTrafficExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbTrafficExtensions.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbTrafficExtensions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "response": { + "$ref": "LbTrafficExtension" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `LbTrafficExtension` resources in a given project and location.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions", + "httpMethod": "GET", + "id": "networkservices.projects.locations.lbTrafficExtensions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "Optional. Filtering results.", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Optional. Hint for how to order the results.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "Optional. A token identifying a page of results that the server returns.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project}/locations/{location}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+parent}/lbTrafficExtensions", + "response": { + "$ref": "ListLbTrafficExtensionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of the specified `LbTrafficExtension` resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/lbTrafficExtensions/{lbTrafficExtensionsId}", + "httpMethod": "PATCH", + "id": "networkservices.projects.locations.lbTrafficExtensions.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/lbTrafficExtensions/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1beta1/{+name}", + "request": { + "$ref": "LbTrafficExtension" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "meshes": { "methods": { "create": { @@ -2119,7 +2483,7 @@ } } }, - "revision": "20230910", + "revision": "20230927", "rootUrl": "https://networkservices.googleapis.com/", "schemas": { "AuditConfig": { @@ -2306,6 +2670,95 @@ }, "type": "object" }, + "ExtensionChain": { + "description": "A single extension chain wrapper that contains the match conditions and extensions to execute.", + "id": "ExtensionChain", + "properties": { + "extensions": { + "description": "Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain.", + "items": { + "$ref": "ExtensionChainExtension" + }, + "type": "array" + }, + "matchCondition": { + "$ref": "ExtensionChainMatchCondition", + "description": "Required. Conditions under which this chain is invoked for a request." + }, + "name": { + "description": "Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "type": "string" + } + }, + "type": "object" + }, + "ExtensionChainExtension": { + "description": "A single extension in the chain to execute for the matching request.", + "id": "ExtensionChainExtension", + "properties": { + "authority": { + "description": "Required. The `:authority` header in the gRPC request sent from Envoy to the extension service.", + "type": "string" + }, + "failOpen": { + "description": "Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE`: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is `FALSE`.", + "type": "boolean" + }, + "forwardHeaders": { + "description": "Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name.", + "items": { + "type": "string" + }, + "type": "array" + }, + "name": { + "description": "Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number.", + "type": "string" + }, + "service": { + "description": "Required. The reference to the service that runs the extension. Must be a reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices).", + "type": "string" + }, + "supportedEvents": { + "description": "Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It's not relevant for the `LbRouteExtension` resource.", + "items": { + "enum": [ + "EVENT_TYPE_UNSPECIFIED", + "REQUEST_HEADERS", + "REQUEST_BODY", + "RESPONSE_HEADERS", + "RESPONSE_BODY" + ], + "enumDescriptions": [ + "Unspecified value. Do not use.", + "If included in `supported_events`, the extension is called when the HTTP request headers arrive.", + "If included in `supported_events`, the extension is called when the HTTP request body arrives.", + "If included in `supported_events`, the extension is called when the HTTP response headers arrive.", + "If included in `supported_events`, the extension is called when the HTTP response body arrives." + ], + "type": "string" + }, + "type": "array" + }, + "timeout": { + "description": "Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, + "ExtensionChainMatchCondition": { + "description": "Conditions under which this chain is invoked for a request.", + "id": "ExtensionChainMatchCondition", + "properties": { + "celExpression": { + "description": "Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed.", + "type": "string" + } + }, + "type": "object" + }, "Gateway": { "description": "Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway.", "id": "Gateway", @@ -2633,6 +3086,10 @@ "$ref": "GrpcRouteRetryPolicy", "description": "Optional. Specifies the retry policy associated with this route." }, + "statefulSessionAffinity": { + "$ref": "GrpcRouteStatefulSessionAffinityPolicy", + "description": "Optional. Specifies cookie-based stateful session affinity." + }, "timeout": { "description": "Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.", "format": "google-duration", @@ -2677,6 +3134,18 @@ }, "type": "object" }, + "GrpcRouteStatefulSessionAffinityPolicy": { + "description": "The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name \"GSSA\" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.", + "id": "GrpcRouteStatefulSessionAffinityPolicy", + "properties": { + "cookieTtl": { + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "HttpRoute": { "description": "HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource.", "id": "HttpRoute", @@ -3096,6 +3565,10 @@ "$ref": "HttpRouteRetryPolicy", "description": "Specifies the retry policy associated with this route." }, + "statefulSessionAffinity": { + "$ref": "HttpRouteStatefulSessionAffinityPolicy", + "description": "Optional. Specifies cookie-based stateful session affinity." + }, "timeout": { "description": "Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries.", "format": "google-duration", @@ -3163,6 +3636,18 @@ }, "type": "object" }, + "HttpRouteStatefulSessionAffinityPolicy": { + "description": "The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name \"GSSA\" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next.", + "id": "HttpRouteStatefulSessionAffinityPolicy", + "properties": { + "cookieTtl": { + "description": "Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "HttpRouteURLRewrite": { "description": "The specification for modifying the URL of the request, prior to forwarding the request to the destination.", "id": "HttpRouteURLRewrite", @@ -3178,6 +3663,130 @@ }, "type": "object" }, + "LbRouteExtension": { + "description": "`LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request.", + "id": "LbRouteExtension", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "extensionChains": { + "description": "Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.", + "items": { + "$ref": "ExtensionChain" + }, + "type": "array" + }, + "forwardingRules": { + "description": "Required. A list of references to the forwarding rules to which this service extension is attach to. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "type": "object" + }, + "loadBalancingScheme": { + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`.", + "enum": [ + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Internal HTTP(S) Load Balancing.", + "Signifies that this is used for External Managed HTTP(S) Load Balancing." + ], + "type": "string" + }, + "name": { + "description": "Required. Name of the `LbRouteExtension` resource in the following format: `projects/{project}/locations/{location}/lbRouteExtensions/{lb_route_extension}`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "LbTrafficExtension": { + "description": "`LbTrafficExtension` is a resource that lets the extension service modify the headers and payloads of both requests and responses without impacting the choice of backend services or any other security policies associated with the backend service.", + "id": "LbTrafficExtension", + "properties": { + "createTime": { + "description": "Output only. The timestamp when the resource was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. A human-readable description of the resource.", + "type": "string" + }, + "extensionChains": { + "description": "Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource.", + "items": { + "$ref": "ExtensionChain" + }, + "type": "array" + }, + "forwardingRules": { + "description": "Required. A list of references to the forwarding rules to which this service extension is attach to. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule.", + "items": { + "type": "string" + }, + "type": "array" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements).", + "type": "object" + }, + "loadBalancingScheme": { + "description": "Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service).", + "enum": [ + "LOAD_BALANCING_SCHEME_UNSPECIFIED", + "INTERNAL_MANAGED", + "EXTERNAL_MANAGED" + ], + "enumDescriptions": [ + "Default value. Do not use.", + "Signifies that this is used for Internal HTTP(S) Load Balancing.", + "Signifies that this is used for External Managed HTTP(S) Load Balancing." + ], + "type": "string" + }, + "name": { + "description": "Required. Name of the `LbTrafficExtension` resource in the following format: `projects/{project}/locations/{location}/lbTrafficExtensions/{lb_traffic_extension}`.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The timestamp when the resource was updated.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ListEndpointPoliciesResponse": { "description": "Response returned by the ListEndpointPolicies method.", "id": "ListEndpointPoliciesResponse", @@ -3257,6 +3866,56 @@ }, "type": "object" }, + "ListLbRouteExtensionsResponse": { + "description": "Message for response to listing `LbRouteExtension` resources.", + "id": "ListLbRouteExtensionsResponse", + "properties": { + "lbRouteExtensions": { + "description": "The list of `LbRouteExtension` resources.", + "items": { + "$ref": "LbRouteExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListLbTrafficExtensionsResponse": { + "description": "Message for response to listing `LbTrafficExtension` resources.", + "id": "ListLbTrafficExtensionsResponse", + "properties": { + "lbTrafficExtensions": { + "description": "The list of `LbTrafficExtension` resources.", + "items": { + "$ref": "LbTrafficExtension" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token identifying a page of results that the server returns.", + "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", diff --git a/discovery/notebooks-v1.json b/discovery/notebooks-v1.json index 34d56583d8..5ad58301a1 100644 --- a/discovery/notebooks-v1.json +++ b/discovery/notebooks-v1.json @@ -692,6 +692,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "migrate": { + "description": "Migrates an existing User-Managed Notebook to Workbench Instances.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances/{instancesId}:migrate", + "httpMethod": "POST", + "id": "notebooks.projects.locations.instances.migrate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/instances/{instance_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:migrate", + "request": { + "$ref": "MigrateInstanceRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "register": { "description": "Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/instances:register", @@ -1493,6 +1521,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "migrate": { + "description": "Migrate an existing Runtime to a new Workbench Instance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimes/{runtimesId}:migrate", + "httpMethod": "POST", + "id": "notebooks.projects.locations.runtimes.migrate", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Format: `projects/{project_id}/locations/{location}/runtimes/{runtime_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/runtimes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:migrate", + "request": { + "$ref": "MigrateRuntimeRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "patch": { "description": "Update Notebook Runtime configuration.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/runtimes/{runtimesId}", @@ -1952,7 +2008,7 @@ } } }, - "revision": "20230906", + "revision": "20231003", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -2835,7 +2891,7 @@ ], "enumDescriptions": [ "Default type.", - "The UmN uses an machine type that's unsupported in WbI. It will be migrated with the default machine type n2-standard-4. Users can change the machine type after the migration.", + "The UmN uses an machine type that's unsupported in WbI. It will be migrated with the default machine type e2-standard-4. Users can change the machine type after the migration.", "The UmN uses an accelerator type that's unsupported in WbI. It will be migrated without an accelerator. User can attach an accelerator after the migration.", "The UmN uses an operating system that's unsupported in WbI (e.g. Debian 10, Ubuntu). It will be replaced with Debian 11 in WbI.", "This UmN is configured with no_remove_data_disk, which is no longer available in WbI.", @@ -3182,6 +3238,64 @@ }, "type": "object" }, + "MigrateInstanceRequest": { + "description": "Request for migrating a User-Managed Notebook to Workbench Instances.", + "id": "MigrateInstanceRequest", + "properties": { + "postStartupScriptOption": { + "description": "Optional. Specifies the behavior of post startup script during migration.", + "enum": [ + "POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED", + "POST_STARTUP_SCRIPT_OPTION_SKIP", + "POST_STARTUP_SCRIPT_OPTION_RERUN" + ], + "enumDescriptions": [ + "Post startup script option is not specified. Default is POST_STARTUP_SCRIPT_OPTION_SKIP.", + "Not migrate the post startup script to the new Workbench Instance.", + "Redownload and rerun the same post startup script as the User-Managed Notebook." + ], + "type": "string" + } + }, + "type": "object" + }, + "MigrateRuntimeRequest": { + "description": "Request for migrating a Runtime to a Workbench Instance.", + "id": "MigrateRuntimeRequest", + "properties": { + "network": { + "description": "Optional. Name of the VPC that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same VPC, and this field must be empty. Format: `projects/{project_id}/global/networks/{network_id}`", + "type": "string" + }, + "postStartupScriptOption": { + "description": "Optional. Specifies the behavior of post startup script during migration.", + "enum": [ + "POST_STARTUP_SCRIPT_OPTION_UNSPECIFIED", + "POST_STARTUP_SCRIPT_OPTION_SKIP", + "POST_STARTUP_SCRIPT_OPTION_RERUN" + ], + "enumDescriptions": [ + "Post startup script option is not specified. Default is POST_STARTUP_SCRIPT_OPTION_SKIP.", + "Not migrate the post startup script to the new Workbench Instance.", + "Redownload and rerun the same post startup script as the Google-Managed Notebook." + ], + "type": "string" + }, + "requestId": { + "description": "Optional. Idempotent request UUID.", + "type": "string" + }, + "serviceAccount": { + "description": "Optional. The service account to be included in the Compute Engine instance of the new Workbench Instance when the Runtime uses \"single user only\" mode for permission. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. When the Runtime uses service account mode for permission, it will reuse the same service account, and this field must be empty.", + "type": "string" + }, + "subnet": { + "description": "Optional. Name of the subnet that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same subnet, and this field must be empty. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", diff --git a/discovery/ondemandscanning-v1.json b/discovery/ondemandscanning-v1.json index 3eb7329651..83182133af 100644 --- a/discovery/ondemandscanning-v1.json +++ b/discovery/ondemandscanning-v1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20230807", + "revision": "20231009", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -2842,6 +2842,10 @@ ], "type": "string" }, + "extraDetails": { + "description": "Occurrence-specific extra details about the vulnerability.", + "type": "string" + }, "fixAvailable": { "description": "Output only. Whether at least one of the affected packages has a fix available.", "type": "boolean" diff --git a/discovery/ondemandscanning-v1beta1.json b/discovery/ondemandscanning-v1beta1.json index d4cb31fa0e..c0b67331ea 100644 --- a/discovery/ondemandscanning-v1beta1.json +++ b/discovery/ondemandscanning-v1beta1.json @@ -339,7 +339,7 @@ } } }, - "revision": "20230807", + "revision": "20231009", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AliasContext": { @@ -2837,6 +2837,10 @@ ], "type": "string" }, + "extraDetails": { + "description": "Occurrence-specific extra details about the vulnerability.", + "type": "string" + }, "fixAvailable": { "description": "Output only. Whether at least one of the affected packages has a fix available.", "type": "boolean" diff --git a/discovery/oslogin-v1alpha.json b/discovery/oslogin-v1alpha.json index 413771e4eb..4cee68b5eb 100644 --- a/discovery/oslogin-v1alpha.json +++ b/discovery/oslogin-v1alpha.json @@ -280,6 +280,39 @@ } }, "resources": { + "locations": { + "methods": { + "signSshPublicKey": { + "description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.", + "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", + "httpMethod": "POST", + "id": "oslogin.users.projects.locations.signSshPublicKey", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process.", + "location": "path", + "pattern": "^users/[^/]+/projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha/{+parent}:signSshPublicKey", + "request": { + "$ref": "SignSshPublicKeyRequest" + }, + "response": { + "$ref": "SignSshPublicKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "zones": { "methods": { "signSshPublicKey": { @@ -438,7 +471,7 @@ } } }, - "revision": "20230917", + "revision": "20231001", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/oslogin-v1beta.json b/discovery/oslogin-v1beta.json index a369e89715..7f57127ae5 100644 --- a/discovery/oslogin-v1beta.json +++ b/discovery/oslogin-v1beta.json @@ -250,6 +250,39 @@ } }, "resources": { + "locations": { + "methods": { + "signSshPublicKey": { + "description": "Signs an SSH public key for a user to authenticate to an instance.", + "flatPath": "v1beta/users/{usersId}/projects/{projectsId}/locations/{locationsId}:signSshPublicKey", + "httpMethod": "POST", + "id": "oslogin.users.projects.locations.signSshPublicKey", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process.", + "location": "path", + "pattern": "^users/[^/]+/projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta/{+parent}:signSshPublicKey", + "request": { + "$ref": "SignSshPublicKeyRequest" + }, + "response": { + "$ref": "SignSshPublicKeyResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ] + } + } + }, "zones": { "methods": { "signSshPublicKey": { @@ -408,7 +441,7 @@ } } }, - "revision": "20230917", + "revision": "20231001", "rootUrl": "https://oslogin.googleapis.com/", "schemas": { "Empty": { diff --git a/discovery/places-v1.json b/discovery/places-v1.json index 9a10a4516f..1ad46aa68b 100644 --- a/discovery/places-v1.json +++ b/discovery/places-v1.json @@ -136,7 +136,7 @@ } } }, - "revision": "20230918", + "revision": "20231009", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -196,6 +196,11 @@ "description": "All the information representing a Place.", "id": "GoogleMapsPlacesV1Place", "properties": { + "accessibilityOptions": { + "$ref": "GoogleMapsPlacesV1PlaceAccessibilityOptions", + "description": "Output only. Information about the accessibility options a place offers.", + "readOnly": true + }, "addressComponents": { "description": "Output only. Repeated components for each locality level.", "items": { @@ -317,11 +322,6 @@ "readOnly": true, "type": "string" }, - "openingHours": { - "$ref": "GoogleMapsPlacesV1PlaceOpeningHours", - "description": "Output only. The regular hours of operation.", - "readOnly": true - }, "plusCode": { "$ref": "GoogleMapsPlacesV1PlacePlusCode", "description": "Output only. Plus code of the place location lat/long.", @@ -354,6 +354,19 @@ "readOnly": true, "type": "number" }, + "regularOpeningHours": { + "$ref": "GoogleMapsPlacesV1PlaceOpeningHours", + "description": "Output only. The regular hours of operation.", + "readOnly": true + }, + "regularSecondaryOpeningHours": { + "description": "Output only. Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.", + "items": { + "$ref": "GoogleMapsPlacesV1PlaceOpeningHours" + }, + "readOnly": true, + "type": "array" + }, "reservable": { "description": "Output only. Specifies if the place supports reservations.", "readOnly": true, @@ -367,14 +380,6 @@ "readOnly": true, "type": "array" }, - "secondaryOpeningHours": { - "description": "Output only. Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.", - "items": { - "$ref": "GoogleMapsPlacesV1PlaceOpeningHours" - }, - "readOnly": true, - "type": "array" - }, "servesBeer": { "description": "Output only. Specifies if the place serves beer.", "readOnly": true, @@ -444,11 +449,16 @@ "description": "Output only. The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain.", "readOnly": true, "type": "string" - }, + } + }, + "type": "object" + }, + "GoogleMapsPlacesV1PlaceAccessibilityOptions": { + "description": "Information about the accessibility options a place offers.", + "id": "GoogleMapsPlacesV1PlaceAccessibilityOptions", + "properties": { "wheelchairAccessibleEntrance": { - "deprecated": true, - "description": "Output only. [Deprecated!] Specifies if the place has an entrance that is wheelchair-accessible.", - "readOnly": true, + "description": "Places has wheelchair accessible entrance.", "type": "boolean" } }, diff --git a/discovery/playintegrity-v1.json b/discovery/playintegrity-v1.json index a982512dbb..dd7a521b99 100644 --- a/discovery/playintegrity-v1.json +++ b/discovery/playintegrity-v1.json @@ -138,11 +138,11 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://playintegrity.googleapis.com/", "schemas": { "AccountActivity": { - "description": "Contains a signal helping apps differentiating between likely genuine users and likely non-genuine traffic (such as accounts being used for fraud, accounts used by automated traffic, or accounts used in device farms) based on the presence and volume of Play store activity.", + "description": "(Restricted Access) Contains a signal helping apps differentiating between likely genuine and likely non-genuine user traffic.", "id": "AccountActivity", "properties": { "activityLevel": { @@ -157,11 +157,11 @@ ], "enumDescriptions": [ "Activity level has not been set.", - "Account activity level is not evaluated because one of the prerequisite conditions is not met (e.g., device is not trusted, the user does not have Play app license)", - "Google Play store activity is unusual for at least one of the user accounts on the device. Google Play recommends checking that this is a real user.", - "Google Play does not have sufficient activity for the user account on the device. The account may be new, or it may lack activity on Google Play.", - "Google Play store activity is typical for the user account or accounts on the device.", - "Google Play store activity is typical for the user account or accounts on the device, with harder to replicate signals." + "Account activity level is not evaluated.", + "Unusual activity for at least one of the user accounts on the device.", + "Insufficient activity to verify the user account on the device.", + "Typical activity for the user account or accounts on the device.", + "Typical for the user account or accounts on the device, with harder to replicate signals." ], "type": "string" } @@ -174,7 +174,7 @@ "properties": { "accountActivity": { "$ref": "AccountActivity", - "description": "Details about the account activity for the user in the scope." + "description": "(Restricted Access) Details about the account activity for the user in the scope." }, "appLicensingVerdict": { "description": "Required. Details about the licensing status of the user for the app in the scope.", @@ -277,7 +277,7 @@ "App is running on GMS Android device with Google Play services.", "App is running on GMS Android device with Google Play services and has a strong guarantee of system integrity such as a hardware-backed keystore.", "App is running on an Android emulator with Google Play services which meets core Android compatibility requirements.", - "App is running on a device that passes only weak integrity checks (is a physical device). See go/pcm-physical-device-detection for more details. Note that this label won't be served for PIA heavyweight and express for now, only for the crystal mode." + "App is running on a device that passes only weak integrity checks (is a physical device)." ], "type": "string" }, @@ -367,7 +367,7 @@ "type": "object" }, "UserRemediationDetails": { - "description": "Contains details of remediation guidance that the user can perform. See go/pia-interstitials-dd", + "description": "Contains details of remediation guidance that the user can perform.", "id": "UserRemediationDetails", "properties": { "remediation": { @@ -381,7 +381,7 @@ "INSTALL_APP_FROM_PLAY" ], "enumDescriptions": [ - "Catch-all for unrecognized enum values. See go/protodosdonts.", + "User remediation is unknown.", "The user has installed a custom ROM, and should restore the device to a clean factory ROM.", "The device bootloader has been unlocked, the user should lock the bootloader.", "The app is unrecognized. The user should get an unmodified version of the app.", diff --git a/discovery/pubsub-v1.json b/discovery/pubsub-v1.json index 4d38540a16..f53009f018 100644 --- a/discovery/pubsub-v1.json +++ b/discovery/pubsub-v1.json @@ -20,9 +20,9 @@ "documentationLink": "https://cloud.google.com/pubsub/docs", "endpoints": [ { + "location": "me-central2", "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", - "description": "Regional Endpoint", - "location": "me-central2" + "description": "Regional Endpoint" } ], "icons": { @@ -1573,7 +1573,7 @@ } } }, - "revision": "20230921", + "revision": "20230928", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta1a.json b/discovery/pubsub-v1beta1a.json index 7f1f278d0a..2973822c7a 100644 --- a/discovery/pubsub-v1beta1a.json +++ b/discovery/pubsub-v1beta1a.json @@ -21,8 +21,8 @@ "endpoints": [ { "description": "Regional Endpoint", - "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", - "location": "me-central2" + "location": "me-central2", + "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/" } ], "icons": { @@ -464,7 +464,7 @@ } } }, - "revision": "20230921", + "revision": "20230928", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/pubsub-v1beta2.json b/discovery/pubsub-v1beta2.json index 34023b6864..438241e090 100644 --- a/discovery/pubsub-v1beta2.json +++ b/discovery/pubsub-v1beta2.json @@ -20,9 +20,9 @@ "documentationLink": "https://cloud.google.com/pubsub/docs", "endpoints": [ { - "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/", "location": "me-central2", - "description": "Regional Endpoint" + "description": "Regional Endpoint", + "endpointUrl": "https://pubsub.me-central2.rep.googleapis.com/" } ], "icons": { @@ -731,7 +731,7 @@ } } }, - "revision": "20230830", + "revision": "20230928", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AcknowledgeRequest": { diff --git a/discovery/redis-v1.json b/discovery/redis-v1.json index 0f4b1343bf..210cd0b30a 100644 --- a/discovery/redis-v1.json +++ b/discovery/redis-v1.json @@ -177,6 +177,203 @@ } }, "resources": { + "clusters": { + "methods": { + "create": { + "description": "Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", + "httpMethod": "POST", + "id": "redis.projects.locations.clusters.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "clusterId": { + "description": "Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Idempotent request UUID.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/clusters", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a specific Redis cluster. Cluster stops serving and data is deleted.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "DELETE", + "id": "redis.projects.locations.clusters.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Idempotent request UUID.", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Gets the details of a specific Redis cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "GET", + "id": "redis.projects.locations.clusters.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Redis cluster resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Cluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getCertificateAuthority": { + "description": "Gets the details of certificate authority information for Redis cluster.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/certificateAuthority", + "httpMethod": "GET", + "id": "redis.projects.locations.clusters.getCertificateAuthority", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Redis cluster certificate authority resource name using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}/certificateAuthority` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}/certificateAuthority", + "response": { + "$ref": "CertificateAuthority" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id}/locations/{location_id}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters", + "httpMethod": "GET", + "id": "redis.projects.locations.clusters.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The `next_page_token` value returned from a previous ListClusters request, if any.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the cluster location using the form: `projects/{project_id}/locations/{location_id}` where `location_id` refers to a GCP region.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clusters", + "response": { + "$ref": "ListClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "httpMethod": "PATCH", + "id": "redis.projects.locations.clusters.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Idempotent request UUID.", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count`", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, "instances": { "methods": { "create": { @@ -624,9 +821,168 @@ } } }, - "revision": "20230804", + "revision": "20231002", "rootUrl": "https://redis.googleapis.com/", "schemas": { + "CertChain": { + "id": "CertChain", + "properties": { + "certificates": { + "description": "The certificates that form the CA chain, from leaf to root order.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "CertificateAuthority": { + "description": "Redis cluster certificate authority", + "id": "CertificateAuthority", + "properties": { + "managedServerCa": { + "$ref": "ManagedCertificateAuthority" + } + }, + "type": "object" + }, + "Cluster": { + "description": "A cluster instance.", + "id": "Cluster", + "properties": { + "authorizationMode": { + "description": "Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster.", + "enum": [ + "AUTH_MODE_UNSPECIFIED", + "AUTH_MODE_IAM_AUTH", + "AUTH_MODE_DISABLED" + ], + "enumDescriptions": [ + "Not set.", + "IAM basic authorization mode", + "Authorization disabled mode" + ], + "type": "string" + }, + "createTime": { + "description": "Output only. The timestamp associated with the cluster creation request.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "discoveryEndpoints": { + "description": "Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported.", + "items": { + "$ref": "DiscoveryEndpoint" + }, + "readOnly": true, + "type": "array" + }, + "name": { + "description": "Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id}/locations/{location_id}/clusters/{cluster_id}`", + "type": "string" + }, + "pscConfigs": { + "description": "Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported.", + "items": { + "$ref": "PscConfig" + }, + "type": "array" + }, + "pscConnections": { + "description": "Output only. PSC connections for discovery of the cluster topology and accessing the cluster.", + "items": { + "$ref": "PscConnection" + }, + "readOnly": true, + "type": "array" + }, + "replicaCount": { + "description": "Optional. The number of replica nodes per shard.", + "format": "int32", + "type": "integer" + }, + "shardCount": { + "description": "Required. Number of shards for the Redis cluster.", + "format": "int32", + "type": "integer" + }, + "sizeGb": { + "description": "Output only. Redis memory size in GB for the entire cluster.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "state": { + "description": "Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING" + ], + "enumDescriptions": [ + "Not set.", + "Redis cluster is being created.", + "Redis cluster has been created and is fully usable.", + "Redis cluster configuration is being updated.", + "Redis cluster is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "stateInfo": { + "$ref": "StateInfo", + "description": "Output only. Additional information about the current state of the cluster.", + "readOnly": true + }, + "transitEncryptionMode": { + "description": "Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster.", + "enum": [ + "TRANSIT_ENCRYPTION_MODE_UNSPECIFIED", + "TRANSIT_ENCRYPTION_MODE_DISABLED", + "TRANSIT_ENCRYPTION_MODE_SERVER_AUTHENTICATION" + ], + "enumDescriptions": [ + "In-transit encryption not set.", + "In-transit encryption disabled.", + "Use server managed encryption for in-transit encryption." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System assigned, unique identifier for the cluster.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "DiscoveryEndpoint": { + "description": "Endpoints on each network, for Redis clients to connect to the cluster.", + "id": "DiscoveryEndpoint", + "properties": { + "address": { + "description": "Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname.", + "readOnly": true, + "type": "string" + }, + "port": { + "description": "Output only. The port number of the exposed Redis endpoint.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "pscConfig": { + "$ref": "PscConfig", + "description": "Output only. Customer configuration for where the endpoint is created and accessed from.", + "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", @@ -1030,6 +1386,31 @@ }, "type": "object" }, + "ListClustersResponse": { + "description": "Response for ListClusters.", + "id": "ListClustersResponse", + "properties": { + "clusters": { + "description": "A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is \"-\", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id}/locations/{location_id}/clusters/`- and the `status` field set to ERROR and `status_message` field set to \"location not available for ListClusters\".", + "items": { + "$ref": "Cluster" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", + "type": "string" + }, + "unreachable": { + "description": "Locations that could not be reached.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ListInstancesResponse": { "description": "Response for ListInstances.", "id": "ListInstancesResponse", @@ -1185,6 +1566,19 @@ }, "type": "object" }, + "ManagedCertificateAuthority": { + "id": "ManagedCertificateAuthority", + "properties": { + "caCerts": { + "description": "The PEM encoded CA certificate chains for redis managed server authentication", + "items": { + "$ref": "CertChain" + }, + "type": "array" + } + }, + "type": "object" + }, "NodeInfo": { "description": "Node specific properties.", "id": "NodeInfo", @@ -1237,6 +1631,50 @@ }, "type": "object" }, + "OperationMetadata": { + "description": "Pre-defined metadata fields.", + "id": "OperationMetadata", + "properties": { + "apiVersion": { + "description": "Output only. API version used to start the operation.", + "readOnly": true, + "type": "string" + }, + "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" + }, + "requestedCancellation": { + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "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" + }, "OutputConfig": { "description": "The output content", "id": "OutputConfig", @@ -1298,6 +1736,47 @@ }, "type": "object" }, + "PscConfig": { + "id": "PscConfig", + "properties": { + "network": { + "description": "Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project}/global/networks/{network_id}.", + "type": "string" + } + }, + "type": "object" + }, + "PscConnection": { + "description": "Details of consumer resources in a PSC connection.", + "id": "PscConnection", + "properties": { + "address": { + "description": "Output only. The IP allocated on the consumer network for the PSC forwarding rule.", + "readOnly": true, + "type": "string" + }, + "forwardingRule": { + "description": "Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId}/regions/us-east1/forwardingRules/{resourceId}.", + "readOnly": true, + "type": "string" + }, + "network": { + "description": "The consumer network where the IP address resides, in the form of projects/{project_id}/global/networks/{network_id}.", + "type": "string" + }, + "projectId": { + "description": "Output only. The consumer project_id where the forwarding rule is created from.", + "readOnly": true, + "type": "string" + }, + "pscConnectionId": { + "description": "Output only. The PSC connection id of the forwarding rule connected to the service attachment.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "ReconciliationOperationMetadata": { "description": "Operation metadata returned by the CLH during resource state reconciliation.", "id": "ReconciliationOperationMetadata", @@ -1357,6 +1836,17 @@ }, "type": "object" }, + "StateInfo": { + "description": "Represents additional information about the state of the cluster.", + "id": "StateInfo", + "properties": { + "updateInfo": { + "$ref": "UpdateInfo", + "description": "Describes ongoing update on the cluster when cluster state is UPDATING." + } + }, + "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", @@ -1442,6 +1932,23 @@ }, "type": "object" }, + "UpdateInfo": { + "description": "Represents information about an updating cluster.", + "id": "UpdateInfo", + "properties": { + "targetReplicaCount": { + "description": "Target number of replica nodes per shard.", + "format": "int32", + "type": "integer" + }, + "targetShardCount": { + "description": "Target number of shards for redis cluster", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "UpgradeInstanceRequest": { "description": "Request for UpgradeInstance.", "id": "UpgradeInstanceRequest", diff --git a/discovery/retail-v2alpha.json b/discovery/retail-v2alpha.json index cf26058569..27980dc714 100644 --- a/discovery/retail-v2alpha.json +++ b/discovery/retail-v2alpha.json @@ -135,6 +135,31 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "getLoggingConfig": { + "description": "Gets the LoggingConfig of the requested project.", + "flatPath": "v2alpha/projects/{projectsId}/loggingConfig", + "httpMethod": "GET", + "id": "retail.projects.getLoggingConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Full LoggingConfig resource name. Format: projects/{project_number}/loggingConfig", + "location": "path", + "pattern": "^projects/[^/]+/loggingConfig$", + "required": true, + "type": "string" + } + }, + "path": "v2alpha/{+name}", + "response": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "getRetailProject": { "description": "Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.", "flatPath": "v2alpha/projects/{projectsId}/retailProject", @@ -184,6 +209,40 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "updateLoggingConfig": { + "description": "Updates the LoggingConfig of the requested project.", + "flatPath": "v2alpha/projects/{projectsId}/loggingConfig", + "httpMethod": "PATCH", + "id": "retail.projects.updateLoggingConfig", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig", + "location": "path", + "pattern": "^projects/[^/]+/loggingConfig$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * default_log_generation_rule * per_service_log_generation_rules If not set, all supported fields are updated.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v2alpha/{+name}", + "request": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfig" + }, + "response": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfig" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2329,7 +2388,7 @@ } } }, - "revision": "20230914", + "revision": "20231005", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4399,6 +4458,73 @@ }, "type": "object" }, + "GoogleCloudRetailV2alphaLoggingConfig": { + "description": "Project level logging config to control what level of log will be generated and written to Cloud Logging.", + "id": "GoogleCloudRetailV2alphaLoggingConfig", + "properties": { + "defaultLogGenerationRule": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule", + "description": "The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control." + }, + "name": { + "description": "Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig", + "type": "string" + }, + "serviceLogGenerationRules": { + "description": "Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.", + "items": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule": { + "description": "The logging configurations for services supporting log generation.", + "id": "GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule", + "properties": { + "infoLogSampleRate": { + "description": "The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.", + "format": "float", + "type": "number" + }, + "loggingLevel": { + "description": "The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.", + "enum": [ + "LOGGING_LEVEL_UNSPECIFIED", + "LOGGING_DISABLED", + "LOG_ERRORS_AND_ABOVE", + "LOG_WARNINGS_AND_ABOVE", + "LOG_ALL" + ], + "enumDescriptions": [ + "Default value. Defaults to `LOG_FOR_WARNINGS_AND_ABOVE` if unset.", + "No log will be generated and sent to Cloud Logging.", + "Log for operations resulted in fatal error.", + "In addition to `LOG_ERRORS_AND_ABOVE`, also log for operations that have soft errors, quality suggestions.", + "Log all operations, including successful ones." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule": { + "description": "The granular logging configurations for supported services.", + "id": "GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule", + "properties": { + "logGenerationRule": { + "$ref": "GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule", + "description": "The log generation rule that applies to this service." + }, + "serviceName": { + "description": "Required. Supported service names: \"CatalogService\", \"CompletionService\", \"ControlService\", \"MerchantCenterStreaming\", \"ModelService\", \"PredictionService\", \"ProductService\", \"ServingConfigService\", \"UserEventService\",", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudRetailV2alphaMerchantCenterAccountLink": { "description": "Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch.", "id": "GoogleCloudRetailV2alphaMerchantCenterAccountLink", diff --git a/discovery/run-v1.json b/discovery/run-v1.json index 17cd7ba688..5b5e0cc221 100644 --- a/discovery/run-v1.json +++ b/discovery/run-v1.json @@ -2289,7 +2289,7 @@ } } }, - "revision": "20230917", + "revision": "20231001", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -2801,7 +2801,7 @@ "id": "EnvVar", "properties": { "name": { - "description": "Required. Name of the environment variable. Must be a C_IDENTIFIER.", + "description": "Required. Name of the environment variable.", "type": "string" }, "value": { @@ -3590,7 +3590,7 @@ "additionalProperties": { "type": "string" }, - "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/disable-default-uri`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", + "description": "Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/disable-default-url`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution.", "type": "object" }, "clusterName": { @@ -4152,7 +4152,7 @@ }, "metadata": { "$ref": "ObjectMeta", - "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/disable-default-uri` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." + "description": "Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/disable-default-url` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal." }, "spec": { "$ref": "ServiceSpec", @@ -4207,7 +4207,7 @@ "type": "string" }, "observedGeneration": { - "description": "Returns the generation last fully processed by the system. This will only match metadata.generation when reconciliation is complete. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.", + "description": "Returns the generation last seen by the system. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False.", "format": "int32", "type": "integer" }, diff --git a/discovery/run-v2.json b/discovery/run-v2.json index cbaf66cbd4..0d5e30850e 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1115,7 +1115,7 @@ } } }, - "revision": "20230924", + "revision": "20231001", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -1454,7 +1454,7 @@ "id": "GoogleCloudRunV2EnvVar", "properties": { "name": { - "description": "Required. Name of the environment variable. Must be a C_IDENTIFIER, and must not exceed 32768 characters.", + "description": "Required. Name of the environment variable. Must not exceed 32768 characters.", "type": "string" }, "value": { @@ -2668,11 +2668,6 @@ "readOnly": true, "type": "array" }, - "trafficTagsCleanupThreshold": { - "description": "Optional. Override the traffic tag threshold limit. Garbage collection will start cleaning up non-serving tagged traffic targets based on creation item. The default value is 2000.", - "format": "int64", - "type": "string" - }, "uid": { "description": "Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted.", "readOnly": true, diff --git a/discovery/safebrowsing-v5.json b/discovery/safebrowsing-v5.json new file mode 100644 index 0000000000..45ed3b2e3f --- /dev/null +++ b/discovery/safebrowsing-v5.json @@ -0,0 +1,212 @@ +{ + "basePath": "", + "baseUrl": "https://safebrowsing.googleapis.com/", + "batchPath": "batch", + "canonicalName": "Safebrowsing", + "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.", + "discoveryVersion": "v1", + "documentationLink": "https://developers.google.com/safe-browsing/", + "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": "safebrowsing:v5", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://safebrowsing.mtls.googleapis.com/", + "name": "safebrowsing", + "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": { + "hashes": { + "methods": { + "search": { + "description": "Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136", + "flatPath": "v5/hashes:search", + "httpMethod": "GET", + "id": "safebrowsing.hashes.search", + "parameterOrder": [], + "parameters": { + "hashPrefixes": { + "description": "Required. The hash prefixes to be looked up.", + "format": "byte", + "location": "query", + "repeated": true, + "type": "string" + } + }, + "path": "v5/hashes:search", + "response": { + "$ref": "GoogleSecuritySafebrowsingV5SearchHashesResponse" + } + } + } + } + }, + "revision": "20231001", + "rootUrl": "https://safebrowsing.googleapis.com/", + "schemas": { + "GoogleSecuritySafebrowsingV5FullHash": { + "description": "The full hash identified with one or more matches.", + "id": "GoogleSecuritySafebrowsingV5FullHash", + "properties": { + "fullHash": { + "description": "The matching full hash. This is the SHA256 hash. The length will be exactly 32 bytes.", + "format": "byte", + "type": "string" + }, + "fullHashDetails": { + "description": "Unordered list. A repeated field identifying the details relevant to this full hash.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV5FullHashFullHashDetail" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV5FullHashFullHashDetail": { + "description": "Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning), so clients MUST be prepared to receive FullHashDetail messages containing ThreatType enum values or ThreatAttribute enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all ThreatType and ThreatAttribute enum values; if any value is considered invalid, the client MUST disregard the entire FullHashDetail message.", + "id": "GoogleSecuritySafebrowsingV5FullHashFullHashDetail", + "properties": { + "attributes": { + "description": "Unordered list. Additional attributes about those full hashes. This may be empty.", + "items": { + "enum": [ + "THREAT_ATTRIBUTE_UNSPECIFIED", + "CANARY", + "FRAME_ONLY" + ], + "enumDescriptions": [ + "Unknown.", + "Indicates that the threat_type should not be used for enforcement.", + "Indicates that the threat_type should only be used for enforcement on frames." + ], + "type": "string" + }, + "type": "array" + }, + "threatType": { + "description": "The type of threat. This field will never be empty.", + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "MALWARE", + "SOCIAL_ENGINEERING", + "UNWANTED_SOFTWARE", + "POTENTIALLY_HARMFUL_APPLICATION" + ], + "enumDescriptions": [ + "Unknown.", + "Malware threat type.", + "Social engineering threat type.", + "Unwanted software threat type.", + "Potentially harmful application threat type." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleSecuritySafebrowsingV5SearchHashesResponse": { + "description": "The response returned after searching threat hashes. Note that if nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404).", + "id": "GoogleSecuritySafebrowsingV5SearchHashesResponse", + "properties": { + "cacheDuration": { + "description": "The client-side cache duration. The client shall add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact should also be cached by the client. Important: the client must not assume that the server will return the same cache duration for all responses. The server may choose different cache durations for different responses depending on the situation.", + "format": "google-duration", + "type": "string" + }, + "fullHashes": { + "description": "Unordered list. The unordered list of full hashes found.", + "items": { + "$ref": "GoogleSecuritySafebrowsingV5FullHash" + }, + "type": "array" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "Safe Browsing API", + "version": "v5", + "version_module": true +} \ No newline at end of file diff --git a/discovery/sasportal-v1alpha1.json b/discovery/sasportal-v1alpha1.json index 84969e0703..e0d0a09cf0 100644 --- a/discovery/sasportal-v1alpha1.json +++ b/discovery/sasportal-v1alpha1.json @@ -2636,7 +2636,7 @@ } } }, - "revision": "20230917", + "revision": "20231006", "rootUrl": "https://sasportal.googleapis.com/", "schemas": { "SasPortalAssignment": { @@ -3584,7 +3584,12 @@ "SasPortalSetupSasAnalyticsRequest": { "description": "Request for the SetupSasAnalytics rpc.", "id": "SasPortalSetupSasAnalyticsRequest", - "properties": {}, + "properties": { + "userId": { + "description": "Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional", + "type": "string" + } + }, "type": "object" }, "SasPortalSetupSasAnalyticsResponse": { diff --git a/discovery/securitycenter-v1.json b/discovery/securitycenter-v1.json index a6de81dd5c..353ef0057b 100644 --- a/discovery/securitycenter-v1.json +++ b/discovery/securitycenter-v1.json @@ -4750,7 +4750,7 @@ } } }, - "revision": "20230914", + "revision": "20231005", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -5957,6 +5957,13 @@ "$ref": "Kubernetes", "description": "Kubernetes resources associated with the finding." }, + "loadBalancers": { + "description": "The load balancers associated with the finding.", + "items": { + "$ref": "LoadBalancer" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -6024,6 +6031,10 @@ "description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, + "securityPosture": { + "$ref": "SecurityPosture", + "description": "The security posture associated with the finding." + }, "severity": { "description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ @@ -6456,7 +6467,7 @@ "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.", + "description": "A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "createTime": { @@ -7126,6 +7137,13 @@ }, "type": "array" }, + "objects": { + "description": "Kubernetes objects related to the finding.", + "items": { + "$ref": "Object" + }, + "type": "array" + }, "pods": { "description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { @@ -7496,6 +7514,17 @@ }, "type": "object" }, + "LoadBalancer": { + "description": "Contains information related to the load balancer associated with the finding.", + "id": "LoadBalancer", + "properties": { + "name": { + "description": "The name of the load balancer associated with the finding.", + "type": "string" + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -7831,6 +7860,29 @@ }, "type": "object" }, + "Object": { + "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", + "id": "Object", + "properties": { + "group": { + "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", + "type": "string" + }, + "kind": { + "description": "Kubernetes object kind, such as “Namespace”.", + "type": "string" + }, + "name": { + "description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", + "type": "string" + }, + "ns": { + "description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -8226,6 +8278,33 @@ }, "type": "object" }, + "SecurityPosture": { + "description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", + "id": "SecurityPosture", + "properties": { + "changedPolicy": { + "description": "The name of the policy that has been updated, for example, `projects/{project_id}/policies/{constraint_name}`.", + "type": "string" + }, + "name": { + "description": "Name of the posture, for example, `organizations/{org_id}/locations/{location}/postures/{posture_name}`.", + "type": "string" + }, + "postureDeployment": { + "description": "The name of the posture deployment, for example, `projects/{project_id}/posturedeployments/{posture_deployment_id}`.", + "type": "string" + }, + "postureDeploymentResource": { + "description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id}`.", + "type": "string" + }, + "revisionId": { + "description": "The version of the posture, for example, `c7cfa2a8`.", + "type": "string" + } + }, + "type": "object" + }, "ServiceAccountDelegationInfo": { "description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", @@ -8335,7 +8414,7 @@ "id": "Source", "properties": { "canonicalName": { - "description": "The canonical name of the finding. It's either \"organizations/{organization_id}/sources/{source_id}\", \"folders/{folder_id}/sources/{source_id}\" or \"projects/{project_number}/sources/{source_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", + "description": "The canonical name of the finding source. It's either \"organizations/{organization_id}/sources/{source_id}\", \"folders/{folder_id}/sources/{source_id}\", or \"projects/{project_number}/sources/{source_id}\", depending on the closest CRM ancestor of the resource associated with the finding.", "type": "string" }, "description": { diff --git a/discovery/securitycenter-v1beta1.json b/discovery/securitycenter-v1beta1.json index 8856979ae4..ea963c03cb 100644 --- a/discovery/securitycenter-v1beta1.json +++ b/discovery/securitycenter-v1beta1.json @@ -896,7 +896,7 @@ } } }, - "revision": "20230914", + "revision": "20231005", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1822,6 +1822,13 @@ "$ref": "Kubernetes", "description": "Kubernetes resources associated with the finding." }, + "loadBalancers": { + "description": "The load balancers associated with the finding.", + "items": { + "$ref": "LoadBalancer" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -1889,6 +1896,10 @@ "description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, + "securityPosture": { + "$ref": "SecurityPosture", + "description": "The security posture associated with the finding." + }, "severity": { "description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ @@ -2321,7 +2332,7 @@ "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.", + "description": "A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "createTime": { @@ -3046,6 +3057,13 @@ }, "type": "array" }, + "objects": { + "description": "Kubernetes objects related to the finding.", + "items": { + "$ref": "Object" + }, + "type": "array" + }, "pods": { "description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { @@ -3199,6 +3217,17 @@ }, "type": "object" }, + "LoadBalancer": { + "description": "Contains information related to the load balancer associated with the finding.", + "id": "LoadBalancer", + "properties": { + "name": { + "description": "The name of the load balancer associated with the finding.", + "type": "string" + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -3506,6 +3535,29 @@ }, "type": "object" }, + "Object": { + "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", + "id": "Object", + "properties": { + "group": { + "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", + "type": "string" + }, + "kind": { + "description": "Kubernetes object kind, such as “Namespace”.", + "type": "string" + }, + "name": { + "description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", + "type": "string" + }, + "ns": { + "description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", + "type": "string" + } + }, + "type": "object" + }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -3795,6 +3847,33 @@ }, "type": "object" }, + "SecurityPosture": { + "description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", + "id": "SecurityPosture", + "properties": { + "changedPolicy": { + "description": "The name of the policy that has been updated, for example, `projects/{project_id}/policies/{constraint_name}`.", + "type": "string" + }, + "name": { + "description": "Name of the posture, for example, `organizations/{org_id}/locations/{location}/postures/{posture_name}`.", + "type": "string" + }, + "postureDeployment": { + "description": "The name of the posture deployment, for example, `projects/{project_id}/posturedeployments/{posture_deployment_id}`.", + "type": "string" + }, + "postureDeploymentResource": { + "description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id}`.", + "type": "string" + }, + "revisionId": { + "description": "The version of the posture, for example, `c7cfa2a8`.", + "type": "string" + } + }, + "type": "object" + }, "ServiceAccountDelegationInfo": { "description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", diff --git a/discovery/securitycenter-v1beta2.json b/discovery/securitycenter-v1beta2.json index d4f4b30dbf..f583eded31 100644 --- a/discovery/securitycenter-v1beta2.json +++ b/discovery/securitycenter-v1beta2.json @@ -157,31 +157,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getOnboardingState": { - "description": "Retrieve the OnboardingState of a resource.", - "flatPath": "v1beta2/folders/{foldersId}/onboardingState", - "httpMethod": "GET", - "id": "securitycenter.folders.getOnboardingState", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization}/onboardingState * folders/{folder}/onboardingState * projects/{project}/onboardingState", - "location": "path", - "pattern": "^folders/[^/]+/onboardingState$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "OnboardingState" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getRapidVulnerabilityDetectionSettings": { "description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", "flatPath": "v1beta2/folders/{foldersId}/rapidVulnerabilityDetectionSettings", @@ -741,31 +716,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getOnboardingState": { - "description": "Retrieve the OnboardingState of a resource.", - "flatPath": "v1beta2/organizations/{organizationsId}/onboardingState", - "httpMethod": "GET", - "id": "securitycenter.organizations.getOnboardingState", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization}/onboardingState * folders/{folder}/onboardingState * projects/{project}/onboardingState", - "location": "path", - "pattern": "^organizations/[^/]+/onboardingState$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "OnboardingState" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getRapidVulnerabilityDetectionSettings": { "description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", "flatPath": "v1beta2/organizations/{organizationsId}/rapidVulnerabilityDetectionSettings", @@ -1350,31 +1300,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "getOnboardingState": { - "description": "Retrieve the OnboardingState of a resource.", - "flatPath": "v1beta2/projects/{projectsId}/onboardingState", - "httpMethod": "GET", - "id": "securitycenter.projects.getOnboardingState", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization}/onboardingState * folders/{folder}/onboardingState * projects/{project}/onboardingState", - "location": "path", - "pattern": "^projects/[^/]+/onboardingState$", - "required": true, - "type": "string" - } - }, - "path": "v1beta2/{+name}", - "response": { - "$ref": "OnboardingState" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getRapidVulnerabilityDetectionSettings": { "description": "Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose.", "flatPath": "v1beta2/projects/{projectsId}/rapidVulnerabilityDetectionSettings", @@ -1981,7 +1906,7 @@ } } }, - "revision": "20230914", + "revision": "20231005", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2914,6 +2839,13 @@ "$ref": "Kubernetes", "description": "Kubernetes resources associated with the finding." }, + "loadBalancers": { + "description": "The load balancers associated with the finding.", + "items": { + "$ref": "LoadBalancer" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -2981,6 +2913,10 @@ "description": "Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding.", "readOnly": true }, + "securityPosture": { + "$ref": "SecurityPosture", + "description": "The security posture associated with the finding." + }, "severity": { "description": "The severity of the finding. This field is managed by the source that writes the finding.", "enum": [ @@ -3390,7 +3326,7 @@ "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.", + "description": "A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations.", "id": "GoogleCloudSecuritycenterV1ResourceValueConfig", "properties": { "createTime": { @@ -3906,6 +3842,13 @@ }, "type": "array" }, + "objects": { + "description": "Kubernetes objects related to the finding.", + "items": { + "$ref": "Object" + }, + "type": "array" + }, "pods": { "description": "Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod.", "items": { @@ -3938,6 +3881,17 @@ }, "type": "object" }, + "LoadBalancer": { + "description": "Contains information related to the load balancer associated with the finding.", + "id": "LoadBalancer", + "properties": { + "name": { + "description": "The name of the load balancer associated with the finding.", + "type": "string" + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -4245,26 +4199,24 @@ }, "type": "object" }, - "OnboardingState": { - "description": "Resource capturing onboarding information for a given CRM resource.", - "id": "OnboardingState", + "Object": { + "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", + "id": "Object", "properties": { + "group": { + "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", + "type": "string" + }, + "kind": { + "description": "Kubernetes object kind, such as “Namespace”.", + "type": "string" + }, "name": { - "description": "The resource name of the OnboardingState. Format: organizations/{organization}/onboardingState Format: folders/{folder}/onboardingState Format: projects/{project}/onboardingState", + "description": "Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/.", "type": "string" }, - "onboardingLevel": { - "description": "Describes the level a given organization, folder, or project is onboarded with SCC. If the resource wasn't onboarded, NOT_FOUND would have been thrown.", - "enum": [ - "ONBOARDING_LEVEL_UNSPECIFIED", - "ONBOARDING_LEVEL_PROJECT", - "ONBOARDING_LEVEL_ORGANIZATION" - ], - "enumDescriptions": [ - "Unused.", - "This resource is onboarded at the project level. Only possible for projects.", - "This resource is onboarded at the organization level. Possible for organizations, folders, and projects." - ], + "ns": { + "description": "Kubernetes object namespace. Must be a valid DNS label. Named \"ns\" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/.", "type": "string" } }, @@ -4549,6 +4501,33 @@ }, "type": "object" }, + "SecurityPosture": { + "description": "Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud.", + "id": "SecurityPosture", + "properties": { + "changedPolicy": { + "description": "The name of the policy that has been updated, for example, `projects/{project_id}/policies/{constraint_name}`.", + "type": "string" + }, + "name": { + "description": "Name of the posture, for example, `organizations/{org_id}/locations/{location}/postures/{posture_name}`.", + "type": "string" + }, + "postureDeployment": { + "description": "The name of the posture deployment, for example, `projects/{project_id}/posturedeployments/{posture_deployment_id}`.", + "type": "string" + }, + "postureDeploymentResource": { + "description": "The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id}`.", + "type": "string" + }, + "revisionId": { + "description": "The version of the posture, for example, `c7cfa2a8`.", + "type": "string" + } + }, + "type": "object" + }, "ServiceAccountDelegationInfo": { "description": "Identity delegation history of an authenticated service account.", "id": "ServiceAccountDelegationInfo", diff --git a/discovery/spanner-v1.json b/discovery/spanner-v1.json index 0e621acbf2..e8f5f96b23 100644 --- a/discovery/spanner-v1.json +++ b/discovery/spanner-v1.json @@ -1831,7 +1831,7 @@ ] }, "batchWrite": { - "description": "Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or result in additional rows if using generated or commit timestamp-based keys. We recommend structuring your mutation groups to be idempotent to avoid this issue.", + "description": "Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue.", "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:batchWrite", "httpMethod": "POST", "id": "spanner.projects.instances.databases.sessions.batchWrite", @@ -2594,7 +2594,7 @@ } } }, - "revision": "20230920", + "revision": "20231005", "rootUrl": "https://spanner.googleapis.com/", "schemas": { "Backup": { @@ -4561,7 +4561,7 @@ "description": "Additional options that affect how many partitions are created." }, "sql": { - "description": "Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.", + "description": "Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, the first operator in the query execution plan must be a distributed union operator. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations.", "type": "string" }, "transaction": { diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index 23ad0e267f..8c4dee38d2 100644 --- a/discovery/storage-v1.json +++ b/discovery/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": "\"3132363038323634353839373135393539313634\"", + "etag": "\"36303132323234343933343236353136323232\"", "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" @@ -2373,6 +2373,11 @@ "required": true, "type": "string" }, + "copySourceAcl": { + "description": "If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false.", + "location": "query", + "type": "boolean" + }, "generation": { "description": "Selects a specific revision of this object.", "format": "int64", @@ -3258,7 +3263,7 @@ } } }, - "revision": "20230914", + "revision": "20231004", "rootUrl": "https://storage.googleapis.com/", "schemas": { "Bucket": { @@ -4305,6 +4310,11 @@ "format": "int64", "type": "string" }, + "hardDeleteTime": { + "description": "This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket.", + "format": "date-time", + "type": "string" + }, "id": { "description": "The ID of the object, including the bucket name, object name, and generation number.", "type": "string" @@ -4386,6 +4396,11 @@ "format": "uint64", "type": "string" }, + "softDeleteTime": { + "description": "The time at which the object became soft-deleted in RFC 3339 format.", + "format": "date-time", + "type": "string" + }, "storageClass": { "description": "Storage class of the object.", "type": "string" @@ -4400,7 +4415,7 @@ "type": "string" }, "timeDeleted": { - "description": "The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.", + "description": "The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted.", "format": "date-time", "type": "string" }, diff --git a/discovery/tagmanager-v2.json b/discovery/tagmanager-v2.json index ad817ece82..767776e2ec 100644 --- a/discovery/tagmanager-v2.json +++ b/discovery/tagmanager-v2.json @@ -3890,7 +3890,7 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://tagmanager.googleapis.com/", "schemas": { "Account": { @@ -4887,6 +4887,10 @@ "description": "A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace.", "id": "Entity", "properties": { + "builtInVariable": { + "$ref": "BuiltInVariable", + "description": "The built in variable being represented by the entity." + }, "changeStatus": { "description": "Represents how the entity has been changed in the workspace.", "enum": [ @@ -4909,10 +4913,18 @@ "$ref": "Client", "description": "The client being represented by the entity." }, + "customTemplate": { + "$ref": "CustomTemplate", + "description": "The custom template being represented by the entity." + }, "folder": { "$ref": "Folder", "description": "The folder being represented by the entity." }, + "gtagConfig": { + "$ref": "GtagConfig", + "description": "The gtag config being represented by the entity." + }, "tag": { "$ref": "Tag", "description": "The tag being represented by the entity." @@ -4928,6 +4940,10 @@ "variable": { "$ref": "Variable", "description": "The variable being represented by the entity." + }, + "zone": { + "$ref": "Zone", + "description": "The zone being represented by the entity." } }, "type": "object" diff --git a/discovery/translate-v3.json b/discovery/translate-v3.json index dad18c426a..1197b723e4 100644 --- a/discovery/translate-v3.json +++ b/discovery/translate-v3.json @@ -171,8 +171,7 @@ "$ref": "SupportedLanguages" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "romanizeText": { @@ -380,8 +379,7 @@ "$ref": "SupportedLanguages" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -795,8 +793,7 @@ "$ref": "Operation" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { @@ -821,8 +818,7 @@ "$ref": "Glossary" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -863,8 +859,7 @@ "$ref": "ListGlossariesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -982,8 +977,7 @@ "$ref": "GlossaryEntry" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { @@ -1019,8 +1013,7 @@ "$ref": "ListGlossaryEntriesResponse" }, "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-translation" + "https://www.googleapis.com/auth/cloud-platform" ] }, "patch": { @@ -1344,7 +1337,7 @@ } } }, - "revision": "20230808", + "revision": "20230922", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { @@ -1389,7 +1382,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional.", + "description": "Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map value is the target mime_type of translated documents. Supported file format conversion includes: - `application/pdf` to `application/vnd.openxmlformats-officedocument.wordprocessingml.document` If nothing specified, output files will be in the same format as the original file.", "type": "object" }, "glossaries": { diff --git a/discovery/translate-v3beta1.json b/discovery/translate-v3beta1.json index 204e6a8204..a19c87e780 100644 --- a/discovery/translate-v3beta1.json +++ b/discovery/translate-v3beta1.json @@ -744,7 +744,7 @@ } } }, - "revision": "20230808", + "revision": "20230922", "rootUrl": "https://translation.googleapis.com/", "schemas": { "BatchDocumentInputConfig": { @@ -789,7 +789,7 @@ "additionalProperties": { "type": "string" }, - "description": "Optional.", + "description": "Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes: - `application/pdf` to `application/vnd.openxmlformats-officedocument.wordprocessingml.document` If nothing specified, output files will be in the same format as the original file.", "type": "object" }, "glossaries": { diff --git a/discovery/vmmigration-v1.json b/discovery/vmmigration-v1.json index 7d7f0aa4f7..d76c92bf62 100644 --- a/discovery/vmmigration-v1.json +++ b/discovery/vmmigration-v1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230914", + "revision": "20230927", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4143,15 +4143,15 @@ ], "enumDescriptions": [ "Default value. This value is not used.", - "Migrate for Compute encountered an unknown error.", - "Migrate for Compute encountered an error while validating replication source health.", - "Migrate for Compute encountered an error during source data operation.", - "Migrate for Compute encountered an error during target data operation.", - "Migrate for Compute encountered an error during OS adaptation.", - "Migrate for Compute encountered an error in clone operation.", - "Migrate for Compute encountered an error in cutover operation.", - "Migrate for Compute encountered an error during utilization report creation.", - "Migrate for Compute encountered an error during appliance upgrade." + "Migrate to Virtual Machines encountered an unknown error.", + "Migrate to Virtual Machines encountered an error while validating replication source health.", + "Migrate to Virtual Machines encountered an error during source data operation.", + "Migrate to Virtual Machines encountered an error during target data operation.", + "Migrate to Virtual Machines encountered an error during OS adaptation.", + "Migrate to Virtual Machines encountered an error in clone operation.", + "Migrate to Virtual Machines encountered an error in cutover operation.", + "Migrate to Virtual Machines encountered an error during utilization report creation.", + "Migrate to Virtual Machines encountered an error during appliance upgrade." ], "readOnly": true, "type": "string" diff --git a/discovery/vmmigration-v1alpha1.json b/discovery/vmmigration-v1alpha1.json index e567267034..ed4605b8f7 100644 --- a/discovery/vmmigration-v1alpha1.json +++ b/discovery/vmmigration-v1alpha1.json @@ -1972,7 +1972,7 @@ } } }, - "revision": "20230914", + "revision": "20231008", "rootUrl": "https://vmmigration.googleapis.com/", "schemas": { "AccessKeyCredentials": { @@ -4188,15 +4188,15 @@ ], "enumDescriptions": [ "Default value. This value is not used.", - "Migrate for Compute encountered an unknown error.", - "Migrate for Compute encountered an error while validating replication source health.", - "Migrate for Compute encountered an error during source data operation.", - "Migrate for Compute encountered an error during target data operation.", - "Migrate for Compute encountered an error during OS adaptation.", - "Migrate for Compute encountered an error in clone operation.", - "Migrate for Compute encountered an error in cutover operation.", - "Migrate for Compute encountered an error during utilization report creation.", - "Migrate for Compute encountered an error during appliance upgrade." + "Migrate to Virtual Machines encountered an unknown error.", + "Migrate to Virtual Machines encountered an error while validating replication source health.", + "Migrate to Virtual Machines encountered an error during source data operation.", + "Migrate to Virtual Machines encountered an error during target data operation.", + "Migrate to Virtual Machines encountered an error during OS adaptation.", + "Migrate to Virtual Machines encountered an error in clone operation.", + "Migrate to Virtual Machines encountered an error in cutover operation.", + "Migrate to Virtual Machines encountered an error during utilization report creation.", + "Migrate to Virtual Machines encountered an error during appliance upgrade." ], "readOnly": true, "type": "string" diff --git a/discovery/vmwareengine-v1.json b/discovery/vmwareengine-v1.json new file mode 100644 index 0000000000..0c9b6a00dd --- /dev/null +++ b/discovery/vmwareengine-v1.json @@ -0,0 +1,3400 @@ +{ + "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://vmwareengine.googleapis.com/", + "batchPath": "batch", + "canonicalName": "VMware Engine", + "description": "The Google VMware Engine API lets you programmatically manage VMware environments.", + "discoveryVersion": "v1", + "documentationLink": "https://cloud.google.com/solutions/vmware-as-a-service", + "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": "vmwareengine:v1", + "kind": "discovery#restDescription", + "mtlsRootUrl": "https://vmwareengine.mtls.googleapis.com/", + "name": "vmwareengine", + "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": { + "projects": { + "resources": { + "locations": { + "methods": { + "get": { + "description": "Gets information about a location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Location" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", + "httpMethod": "GET", + "id": "vmwareengine.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": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "networkPolicies": { + "methods": { + "create": { + "description": "Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkPolicies", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.networkPolicies.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "networkPolicyId": { + "description": "Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent `projects/{my-project}/locations/{us-central1}/networkPolicies` and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/networkPolicies", + "request": { + "$ref": "NetworkPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a `NetworkPolicy` resource. A network policy cannot be deleted when `NetworkService.state` is set to `RECONCILING` for either its external IP or internet access service.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.networkPolicies.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the network policy to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `NetworkPolicy` resource by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.networkPolicies.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the network policy to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "NetworkPolicy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `NetworkPolicy` resources in a specified project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkPolicies", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.networkPolicies.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network policies, you can exclude the ones named `example-policy` by specifying `name != \"example-policy\"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-policy\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"example-policy-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"example-policy-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of network policies to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListNetworkPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPolicies` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location (region) to query for network policies. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/networkPolicies", + "response": { + "$ref": "ListNetworkPoliciesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Modifies a `NetworkPolicy` resource. Only the following fields can be updated: `internet_access`, `external_ip`, `edge_services_cidr`. Only fields specified in `updateMask` are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a `NetworkService` cannot be updated when `NetworkService.state` is set to `RECONCILING`. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/networkPolicies/{networkPoliciesId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.networkPolicies.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/networkPolicies/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the `NetworkPolicy` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "NetworkPolicy" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "nodeTypes": { + "methods": { + "get": { + "description": "Gets details of a single `NodeType`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodeTypes/{nodeTypesId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.nodeTypes.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the node type to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/nodeTypes/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "NodeType" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists node types", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodeTypes", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.nodeTypes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of node types, you can exclude the ones named `standard-72` by specifying `name != \"standard-72\"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"standard-72\") (virtual_cpu_count > 2) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"standard-96\") AND (virtual_cpu_count > 2) OR (name = \"standard-72\") ```", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of node types to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListNodeTypes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNodeTypes` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to be queried for node types. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/nodeTypes", + "response": { + "$ref": "ListNodeTypesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "operations": { + "methods": { + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.operations.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "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": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.operations.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "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`.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", + "httpMethod": "GET", + "id": "vmwareengine.projects.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": "^projects/[^/]+/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": "v1/{+name}/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "privateClouds": { + "methods": { + "create": { + "description": "Creates a new `PrivateCloud` resource in a given project and location. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional. Creating a private cloud also creates a [management cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) for that private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "privateCloudId": { + "description": "Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each `PrivateCloud` within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. True if you want the request to be validated and not executed; false otherwise.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/privateClouds", + "request": { + "$ref": "PrivateCloud" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Schedules a `PrivateCloud` resource for deletion. A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` set to `DELETED` and `expireTime` set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the `PrivateCloud` is successfully scheduled for deletion (this also applies when `delayHours` is set to zero), and the operation is not kept in pending state until `PrivateCloud` is purged. `PrivateCloud` can be restored using `UndeletePrivateCloud` method before the `expireTime` elapses. When `expireTime` is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, `PrivateCloud.state` is set to `PURGING`. `PrivateCloud` can be polled using standard `GET` method for the whole period of deletion and purging. It will not be returned only when it is completely purged.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.privateClouds.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "delayHours": { + "description": "Optional. Time delay of the deletion specified in hours. The default value is `3`. Specifying a non-zero value for this field changes the value of `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned deletion time. Deletion can be cancelled before `expire_time` elapses using VmwareEngine.UndeletePrivateCloud. Specifying a value of `0` for this field instead begins the deletion process and ceases billing immediately. During the final deletion process, the value of `PrivateCloud.state` becomes `PURGING`.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "force": { + "description": "Optional. If set to true, cascade delete is enabled and all children of this private cloud resource are also deleted. When this flag is set to false, the private cloud will not be deleted if there are any children other than the management cluster. The management cluster is always deleted.", + "location": "query", + "type": "boolean" + }, + "name": { + "description": "Required. The resource name of the private cloud to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `PrivateCloud` resource by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the private cloud to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PrivateCloud" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:getIamPolicy", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `PrivateCloud` resources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of private clouds, you can exclude the ones named `example-pc` by specifying `name != \"example-pc\"`. You can also filter nested fields. For example, you could specify `networkConfig.managementCidr = \"192.168.0.0/24\"` to include private clouds only if they have a matching address in their network configuration. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-pc\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"private-cloud-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"private-cloud-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of private clouds to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListPrivateClouds` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateClouds` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/privateClouds", + "response": { + "$ref": "ListPrivateCloudsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.privateClouds.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "PrivateCloud" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resetNsxCredentials": { + "description": "Resets credentials of the NSX appliance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetNsxCredentials", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.resetNsxCredentials", + "parameterOrder": [ + "privateCloud" + ], + "parameters": { + "privateCloud": { + "description": "Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+privateCloud}:resetNsxCredentials", + "request": { + "$ref": "ResetNsxCredentialsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "resetVcenterCredentials": { + "description": "Resets credentials of the Vcenter appliance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:resetVcenterCredentials", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.resetVcenterCredentials", + "parameterOrder": [ + "privateCloud" + ], + "parameters": { + "privateCloud": { + "description": "Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+privateCloud}:resetVcenterCredentials", + "request": { + "$ref": "ResetVcenterCredentialsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:setIamPolicy", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.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/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showNsxCredentials": { + "description": "Gets details of credentials for NSX appliance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showNsxCredentials", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.showNsxCredentials", + "parameterOrder": [ + "privateCloud" + ], + "parameters": { + "privateCloud": { + "description": "Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+privateCloud}:showNsxCredentials", + "response": { + "$ref": "Credentials" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "showVcenterCredentials": { + "description": "Gets details of credentials for Vcenter appliance.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:showVcenterCredentials", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.showVcenterCredentials", + "parameterOrder": [ + "privateCloud" + ], + "parameters": { + "privateCloud": { + "description": "Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+privateCloud}:showVcenterCredentials", + "response": { + "$ref": "Credentials" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:testIamPermissions", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.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/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "undelete": { + "description": "Restores a private cloud that was previously scheduled for deletion by `DeletePrivateCloud`. A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` set to `DELETED` and `PrivateCloud.expireTime` set to the time when deletion can no longer be reversed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}:undelete", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.undelete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the private cloud scheduled for deletion. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:undelete", + "request": { + "$ref": "UndeletePrivateCloudRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "clusters": { + "methods": { + "create": { + "description": "Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient [node quota](https://cloud.google.com/vmware-engine/quotas).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.clusters.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "clusterId": { + "description": "Required. The user-provided identifier of the new `Cluster`. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. True if you want the request to be validated and not executed; false otherwise.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+parent}/clusters", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a `Cluster` resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.privateClouds.clusters.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the cluster to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `Cluster` resource by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.clusters.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The cluster resource name to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Cluster" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:getIamPolicy", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.clusters.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `Cluster` resources in a given private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.clusters.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": " To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-cluster\") (nodeCount = \"3\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"example-cluster-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"example-cluster-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/clusters", + "response": { + "$ref": "ListClustersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Modifies a `Cluster` resource. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.privateClouds.clusters.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the `Cluster` resource by the update. The fields specified in the `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + }, + "validateOnly": { + "description": "Optional. True if you want the request to be validated and not executed; false otherwise.", + "location": "query", + "type": "boolean" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:setIamPolicy", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.clusters.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/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/clusters/{clustersId}:testIamPermissions", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.clusters.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/[^/]+/privateClouds/[^/]+/clusters/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "hcxActivationKeys": { + "methods": { + "create": { + "description": "Creates a new HCX activation key in a given private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "hcxActivationKeyId": { + "description": "Required. The user-provided identifier of the `HcxActivationKey` to be created. This identifier must be unique among `HcxActivationKey` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/hcxActivationKeys", + "request": { + "$ref": "HcxActivationKey" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `HcxActivationKey` resource by its resource name.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the HCX activation key to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "HcxActivationKey" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:getIamPolicy", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.getIamPolicy", + "parameterOrder": [ + "resource" + ], + "parameters": { + "options.requestedPolicyVersion": { + "description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", + "format": "int32", + "location": "query", + "type": "integer" + }, + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:getIamPolicy", + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `HcxActivationKey` resources in a given private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of HCX activation keys to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListHcxActivationKeys` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListHcxActivationKeys` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to be queried for HCX activation keys. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/hcxActivationKeys", + "response": { + "$ref": "ListHcxActivationKeysResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:setIamPolicy", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.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/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "testIamPermissions": { + "description": "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.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/hcxActivationKeys/{hcxActivationKeysId}:testIamPermissions", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateClouds.hcxActivationKeys.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/[^/]+/privateClouds/[^/]+/hcxActivationKeys/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "subnets": { + "methods": { + "get": { + "description": "Gets details of a single subnet.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets/{subnetsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.subnets.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the subnet to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/subnets/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Subnet" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists subnets in a given private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateClouds.subnets.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of subnets to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListSubnetsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubnetsRequest` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private cloud to be queried for subnets. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/subnets", + "response": { + "$ref": "ListSubnetsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates the parameters of a single subnet. Only fields specified in `update_mask` are applied. *Note*: This API is synchronous and always returns a successful `google.longrunning.Operation` (LRO). The returned LRO will only have `done` and `response` fields.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}/subnets/{subnetsId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.privateClouds.subnets.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateClouds/[^/]+/subnets/[^/]+$", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the `Subnet` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "Subnet" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "privateConnections": { + "methods": { + "create": { + "description": "Creates a new private connection that can be used for accessing private Clouds.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.privateConnections.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the new private connection in. Private connection is a regional resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "privateConnectionId": { + "description": "Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/privateConnections", + "request": { + "$ref": "PrivateConnection" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a `PrivateConnection` resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.privateConnections.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the private connection to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `PrivateConnection` resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateConnections.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the private connection to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "PrivateConnection" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `PrivateConnection` resources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateConnections.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of private connections, you can exclude the ones named `example-connection` by specifying `name != \"example-connection\"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-connection\") (createTime > \"2022-09-22T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"example-connection-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"example-connection-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of private connections to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to query for private connections. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/privateConnections", + "response": { + "$ref": "ListPrivateConnectionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Modifies a `PrivateConnection` resource. Only `description` and `routing_mode` fields can be updated. Only fields specified in `updateMask` are applied.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.privateConnections.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the `PrivateConnection` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "PrivateConnection" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "peeringRoutes": { + "methods": { + "list": { + "description": "Lists the private connection routes exchanged over a peering connection.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateConnections/{privateConnectionsId}/peeringRoutes", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.privateConnections.peeringRoutes.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListPrivateConnectionPeeringRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnectionPeeringRoutes` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the private connection to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1/privateConnections/my-connection`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/privateConnections/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/peeringRoutes", + "response": { + "$ref": "ListPrivateConnectionPeeringRoutesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + }, + "vmwareEngineNetworks": { + "methods": { + "create": { + "description": "Creates a new VMware Engine network that can be used by a private cloud.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks", + "httpMethod": "POST", + "id": "vmwareengine.projects.locations.vmwareEngineNetworks.create", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type `LEGACY` is a regional resource, and a VMware Engine network of type `STANDARD` is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "vmwareEngineNetworkId": { + "description": "Required. The user-provided identifier of the new VMware Engine network. This identifier must be unique among VMware Engine network resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * For networks of type LEGACY, adheres to the format: `{region-id}-default`. Replace `{region-id}` with the region where you want to create the VMware Engine network. For example, \"us-central1-default\". * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+parent}/vmwareEngineNetworks", + "request": { + "$ref": "VmwareEngineNetwork" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes a `VmwareEngineNetwork` resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}", + "httpMethod": "DELETE", + "id": "vmwareengine.projects.locations.vmwareEngineNetworks.delete", + "parameterOrder": [ + "name" + ], + "parameters": { + "etag": { + "description": "Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an `ABORTED` error.", + "location": "query", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the VMware Engine network to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "description": "Retrieves a `VmwareEngineNetwork` resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, `CREATING`, `ACTIVE`, `DELETING`).", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.vmwareEngineNetworks.get", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the VMware Engine network to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "VmwareEngineNetwork" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists `VmwareEngineNetwork` resources in a given project and location.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks", + "httpMethod": "GET", + "id": "vmwareengine.projects.locations.vmwareEngineNetworks.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "filter": { + "description": "A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `>`, or `<`. For example, if you are filtering a list of network peerings, you can exclude the ones named `example-network` by specifying `name != \"example-network\"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = \"example-network\") (createTime > \"2021-04-12T08:15:10.40Z\") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = \"example-network-1\") AND (createTime > \"2021-04-12T08:15:10.40Z\") OR (name = \"example-network-2\") ```", + "location": "query", + "type": "string" + }, + "orderBy": { + "description": "Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy=\"name desc\"`. Currently, only ordering by `name` is supported.", + "location": "query", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "A page token, received from a previous `ListVmwareEngineNetworks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVmwareEngineNetworks` must match the call that provided the page token.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/vmwareEngineNetworks", + "response": { + "$ref": "ListVmwareEngineNetworksResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Modifies a VMware Engine network resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/vmwareEngineNetworks/{vmwareEngineNetworksId}", + "httpMethod": "PATCH", + "id": "vmwareengine.projects.locations.vmwareEngineNetworks.patch", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/vmwareEngineNetworks/[^/]+$", + "required": true, + "type": "string" + }, + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "location": "query", + "type": "string" + }, + "updateMask": { + "description": "Required. Field mask is used to specify the fields to be overwritten in the VMware Engine network resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Only the following fields can be updated: `description`.", + "format": "google-fieldmask", + "location": "query", + "type": "string" + } + }, + "path": "v1/{+name}", + "request": { + "$ref": "VmwareEngineNetwork" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + } + } + } + } + }, + "revision": "20230922", + "rootUrl": "https://vmwareengine.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" + }, + "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`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `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.", + "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" + }, + "Cluster": { + "description": "A cluster in a private cloud.", + "id": "Cluster", + "properties": { + "createTime": { + "description": "Output only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "management": { + "description": "Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one.", + "readOnly": true, + "type": "boolean" + }, + "name": { + "description": "Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster`", + "readOnly": true, + "type": "string" + }, + "nodeTypeConfigs": { + "additionalProperties": { + "$ref": "NodeTypeConfig" + }, + "description": "Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).", + "type": "object" + }, + "state": { + "description": "Output only. State of the resource.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "REPAIRING" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "The Cluster is operational and can be used by the user.", + "The Cluster is being deployed.", + "Adding or removing of a node to the cluster, any other cluster specific updates.", + "The Cluster is being deleted.", + "The Cluster is undergoing maintenance, for example: a failed node is getting replaced." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "Credentials": { + "description": "Credentials for a private cloud.", + "id": "Credentials", + "properties": { + "password": { + "description": "Initial password.", + "type": "string" + }, + "username": { + "description": "Initial username.", + "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" + }, + "Hcx": { + "description": "Details about a HCX Cloud Manager appliance.", + "id": "Hcx", + "properties": { + "fqdn": { + "description": "Fully qualified domain name of the appliance.", + "type": "string" + }, + "internalIp": { + "description": "Internal IP address of the appliance.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the appliance.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING" + ], + "enumDescriptions": [ + "Unspecified appliance state. This is the default value.", + "The appliance is operational and can be used.", + "The appliance is being deployed." + ], + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Version of the appliance.", + "type": "string" + } + }, + "type": "object" + }, + "HcxActivationKey": { + "description": "HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones.", + "id": "HcxActivationKey", + "properties": { + "activationKey": { + "description": "Output only. HCX activation key.", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. Creation time of HCX activation key.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The resource name of this HcxActivationKey. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key`", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of HCX activation key.", + "enum": [ + "STATE_UNSPECIFIED", + "AVAILABLE", + "CONSUMED", + "CREATING" + ], + "enumDescriptions": [ + "Unspecified state.", + "State of a newly generated activation key.", + "State of key when it has been used to activate HCX appliance.", + "State of key when it is being created." + ], + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ListClustersResponse": { + "description": "Response message for VmwareEngine.ListClusters", + "id": "ListClustersResponse", + "properties": { + "clusters": { + "description": "A list of private cloud clusters.", + "items": { + "$ref": "Cluster" + }, + "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 when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListHcxActivationKeysResponse": { + "description": "Response message for VmwareEngine.ListHcxActivationKeys", + "id": "ListHcxActivationKeysResponse", + "properties": { + "hcxActivationKeys": { + "description": "List of HCX activation keys.", + "items": { + "$ref": "HcxActivationKey" + }, + "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 when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "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" + }, + "ListNetworkPoliciesResponse": { + "description": "Response message for VmwareEngine.ListNetworkPolicies", + "id": "ListNetworkPoliciesResponse", + "properties": { + "networkPolicies": { + "description": "A list of network policies.", + "items": { + "$ref": "NetworkPolicy" + }, + "type": "array" + }, + "nextPageToken": { + "description": "A token, which can be send 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 when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListNodeTypesResponse": { + "description": "Response message for VmwareEngine.ListNodeTypes", + "id": "ListNodeTypesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "nodeTypes": { + "description": "A list of Node Types.", + "items": { + "$ref": "NodeType" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "id": "ListOperationsResponse", + "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": "Operation" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPrivateCloudsResponse": { + "description": "Response message for VmwareEngine.ListPrivateClouds", + "id": "ListPrivateCloudsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "privateClouds": { + "description": "A list of private clouds.", + "items": { + "$ref": "PrivateCloud" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPrivateConnectionPeeringRoutesResponse": { + "description": "Response message for VmwareEngine.ListPrivateConnectionPeeringRoutes", + "id": "ListPrivateConnectionPeeringRoutesResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "peeringRoutes": { + "description": "A list of peering routes.", + "items": { + "$ref": "PeeringRoute" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListPrivateConnectionsResponse": { + "description": "Response message for VmwareEngine.ListPrivateConnections", + "id": "ListPrivateConnectionsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "privateConnections": { + "description": "A list of private connections.", + "items": { + "$ref": "PrivateConnection" + }, + "type": "array" + }, + "unreachable": { + "description": "Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListSubnetsResponse": { + "description": "Response message for VmwareEngine.ListSubnets", + "id": "ListSubnetsResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "subnets": { + "description": "A list of subnets.", + "items": { + "$ref": "Subnet" + }, + "type": "array" + }, + "unreachable": { + "description": "Locations that could not be reached when making an aggregated query using wildcards.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "ListVmwareEngineNetworksResponse": { + "description": "Response message for VmwareEngine.ListVmwareEngineNetworks", + "id": "ListVmwareEngineNetworksResponse", + "properties": { + "nextPageToken": { + "description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", + "type": "string" + }, + "unreachable": { + "description": "Unreachable resources.", + "items": { + "type": "string" + }, + "type": "array" + }, + "vmwareEngineNetworks": { + "description": "A list of VMware Engine networks.", + "items": { + "$ref": "VmwareEngineNetwork" + }, + "type": "array" + } + }, + "type": "object" + }, + "Location": { + "description": "A resource that represents a Google Cloud 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" + }, + "ManagementCluster": { + "description": "Management cluster configuration.", + "id": "ManagementCluster", + "properties": { + "clusterId": { + "description": "Required. The user-provided identifier of the new `Cluster`. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5)", + "type": "string" + }, + "nodeTypeConfigs": { + "additionalProperties": { + "$ref": "NodeTypeConfig" + }, + "description": "Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`).", + "type": "object" + } + }, + "type": "object" + }, + "NetworkConfig": { + "description": "Network configuration in the consumer project with which the peering has to be done.", + "id": "NetworkConfig", + "properties": { + "managementCidr": { + "description": "Required. Management CIDR used by VMware management appliances.", + "type": "string" + }, + "managementIpAddressLayoutVersion": { + "description": "Output only. The IP address layout version of the management IP address range. Possible versions include: * `managementIpAddressLayoutVersion=1`: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features. * `managementIpAddressLayoutVersion=2`: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "vmwareEngineNetwork": { + "description": "Optional. The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.", + "type": "string" + }, + "vmwareEngineNetworkCanonical": { + "description": "Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NetworkPolicy": { + "description": "Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy.", + "id": "NetworkPolicy", + "properties": { + "createTime": { + "description": "Output only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User-provided description for this network policy.", + "type": "string" + }, + "edgeServicesCidr": { + "description": "Required. IP address range in CIDR notation used to create internet access and external IP access. An RFC 1918 CIDR block, with a \"/26\" prefix, is required. The range cannot overlap with any prefixes either in the consumer VPC network or in use by the private clouds attached to that VPC network.", + "type": "string" + }, + "externalIp": { + "$ref": "NetworkService", + "description": "Network service that allows External IP addresses to be assigned to VMware workloads. This service can only be enabled when `internet_access` is also enabled." + }, + "internetAccess": { + "$ref": "NetworkService", + "description": "Network service that allows VMware workloads to access the internet." + }, + "name": { + "description": "Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy`", + "readOnly": true, + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vmwareEngineNetwork": { + "description": "Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}` can either be a project number or a project ID.", + "type": "string" + }, + "vmwareEngineNetworkCanonical": { + "description": "Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NetworkService": { + "description": "Represents a network service that is managed by a `NetworkPolicy` resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet.", + "id": "NetworkService", + "properties": { + "enabled": { + "description": "True if the service is enabled; false otherwise.", + "type": "boolean" + }, + "state": { + "description": "Output only. State of the service. New values may be added to this enum when appropriate.", + "enum": [ + "STATE_UNSPECIFIED", + "UNPROVISIONED", + "RECONCILING", + "ACTIVE" + ], + "enumDescriptions": [ + "Unspecified service state. This is the default value.", + "Service is not provisioned.", + "Service is in the process of being provisioned/deprovisioned.", + "Service is active." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "NodeType": { + "description": "Describes node type.", + "id": "NodeType", + "properties": { + "availableCustomCoreCounts": { + "description": "Output only. List of possible values of custom core count.", + "items": { + "format": "int32", + "type": "integer" + }, + "readOnly": true, + "type": "array" + }, + "diskSizeGb": { + "description": "Output only. The amount of storage available, defined in GB.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "displayName": { + "description": "Output only. The friendly name for this node type. For example: ve1-standard-72", + "readOnly": true, + "type": "string" + }, + "memoryGb": { + "description": "Output only. The amount of physical memory available, defined in GB.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "name": { + "description": "Output only. The resource name of this node type. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72`", + "readOnly": true, + "type": "string" + }, + "nodeTypeId": { + "description": "Output only. The canonical identifier of the node type (corresponds to the `NodeType`). For example: standard-72.", + "readOnly": true, + "type": "string" + }, + "totalCoreCount": { + "description": "Output only. The total number of CPU cores in a single node.", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "virtualCpuCount": { + "description": "Output only. The total number of virtual CPUs in a single node.", + "format": "int32", + "readOnly": true, + "type": "integer" + } + }, + "type": "object" + }, + "NodeTypeConfig": { + "description": "Information about the type and number of nodes associated with the cluster.", + "id": "NodeTypeConfig", + "properties": { + "customCoreCount": { + "description": "Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used.", + "format": "int32", + "type": "integer" + }, + "nodeCount": { + "description": "Required. The number of nodes of this type in the cluster", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "Nsx": { + "description": "Details about a NSX Manager appliance.", + "id": "Nsx", + "properties": { + "fqdn": { + "description": "Fully qualified domain name of the appliance.", + "type": "string" + }, + "internalIp": { + "description": "Internal IP address of the appliance.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the appliance.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING" + ], + "enumDescriptions": [ + "Unspecified appliance state. This is the default value.", + "The appliance is operational and can be used.", + "The appliance is being deployed." + ], + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Version of the appliance.", + "type": "string" + } + }, + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "id": "Operation", + "properties": { + "done": { + "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.", + "type": "boolean" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.", + "type": "string" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.", + "type": "object" + } + }, + "type": "object" + }, + "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" + }, + "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" + }, + "requestedCancellation": { + "description": "Output only. True if the user has requested cancellation of the operation; false otherwise. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "readOnly": true, + "type": "boolean" + }, + "statusMessage": { + "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" + }, + "PeeringRoute": { + "description": "Exchanged network peering route.", + "id": "PeeringRoute", + "properties": { + "destRange": { + "description": "Output only. Destination range of the peering route in CIDR notation.", + "readOnly": true, + "type": "string" + }, + "direction": { + "description": "Output only. Direction of the routes exchanged with the peer network, from the VMware Engine network perspective: * Routes of direction `INCOMING` are imported from the peer network. * Routes of direction `OUTGOING` are exported from the intranet VPC network of the VMware Engine network.", + "enum": [ + "DIRECTION_UNSPECIFIED", + "INCOMING", + "OUTGOING" + ], + "enumDescriptions": [ + "Unspecified exchanged routes direction. This is default.", + "Routes imported from the peer network.", + "Routes exported to the peer network." + ], + "readOnly": true, + "type": "string" + }, + "imported": { + "description": "Output only. True if the peering route has been imported from a peered VPC network; false otherwise. The import happens if the field `NetworkPeering.importCustomRoutes` is true for this network, `NetworkPeering.exportCustomRoutes` is true for the peer VPC network, and the import does not result in a route conflict.", + "readOnly": true, + "type": "boolean" + }, + "nextHopRegion": { + "description": "Output only. Region containing the next hop of the peering route. This field only applies to dynamic routes in the peer VPC network.", + "readOnly": true, + "type": "string" + }, + "priority": { + "description": "Output only. The priority of the peering route.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. Type of the route in the peer VPC network.", + "enum": [ + "TYPE_UNSPECIFIED", + "DYNAMIC_PEERING_ROUTE", + "STATIC_PEERING_ROUTE", + "SUBNET_PEERING_ROUTE" + ], + "enumDescriptions": [ + "Unspecified peering route type. This is the default value.", + "Dynamic routes in the peer network.", + "Static routes in the peer network.", + "Created, updated, and removed automatically by Google Cloud when subnets are created, modified, or deleted in the peer network." + ], + "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" + }, + "PrivateCloud": { + "description": "Represents a private cloud resource. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional.", + "id": "PrivateCloud", + "properties": { + "createTime": { + "description": "Output only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "deleteTime": { + "description": "Output only. Time when the resource was scheduled for deletion.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "User-provided description for this private cloud.", + "type": "string" + }, + "expireTime": { + "description": "Output only. Time when the resource will be irreversibly deleted.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "hcx": { + "$ref": "Hcx", + "description": "Output only. HCX appliance.", + "readOnly": true + }, + "managementCluster": { + "$ref": "ManagementCluster", + "description": "Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: `ManagementCluster.clusterId`, `ManagementCluster.nodeTypeId`." + }, + "name": { + "description": "Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud`", + "readOnly": true, + "type": "string" + }, + "networkConfig": { + "$ref": "NetworkConfig", + "description": "Required. Network configuration of the private cloud." + }, + "nsx": { + "$ref": "Nsx", + "description": "Output only. NSX appliance.", + "readOnly": true + }, + "state": { + "description": "Output only. State of the resource. New values may be added to this enum when appropriate.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "UPDATING", + "FAILED", + "DELETED", + "PURGING" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "The private cloud is ready.", + "The private cloud is being created.", + "The private cloud is being updated.", + "The private cloud is in failed state.", + "The private cloud is scheduled for deletion. The deletion process can be cancelled by using the corresponding undelete method.", + "The private cloud is irreversibly deleted and is being removed from the system." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Optional. Type of the private cloud. Defaults to STANDARD.", + "enum": [ + "STANDARD", + "TIME_LIMITED" + ], + "enumDescriptions": [ + "Standard private is a zonal resource, with 3+ nodes. Default type.", + "Time limited private cloud is a zonal resource, can have only 1 node and has limited life span. Will be deleted after defined period of time, can be converted into standard private cloud by expanding it up to 3 or more nodes." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vcenter": { + "$ref": "Vcenter", + "description": "Output only. Vcenter appliance.", + "readOnly": true + } + }, + "type": "object" + }, + "PrivateConnection": { + "description": "Private connection resource that provides connectivity for VMware Engine private clouds.", + "id": "PrivateConnection", + "properties": { + "createTime": { + "description": "Output only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Optional. User-provided description for this private connection.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection`", + "readOnly": true, + "type": "string" + }, + "peeringId": { + "description": "Output only. VPC network peering id between given network VPC and VMwareEngineNetwork.", + "readOnly": true, + "type": "string" + }, + "peeringState": { + "description": "Output only. Peering state between service network and VMware Engine network.", + "enum": [ + "PEERING_STATE_UNSPECIFIED", + "PEERING_ACTIVE", + "PEERING_INACTIVE" + ], + "enumDescriptions": [ + "The default value. This value is used if the peering state is omitted or unknown.", + "The peering is in active state.", + "The peering is in inactive state." + ], + "readOnly": true, + "type": "string" + }, + "routingMode": { + "description": "Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported.", + "enum": [ + "ROUTING_MODE_UNSPECIFIED", + "GLOBAL", + "REGIONAL" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Global Routing Mode", + "Regional Routing Mode" + ], + "type": "string" + }, + "serviceNetwork": { + "description": "Required. Service network to create private connection. Specify the name in the following form: `projects/{project}/global/networks/{network_id}` For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc.", + "type": "string" + }, + "state": { + "description": "Output only. State of the private connection.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING", + "UNPROVISIONED", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The private connection is being created.", + "The private connection is ready.", + "The private connection is being updated.", + "The private connection is being deleted.", + "The private connection is not provisioned, since no private cloud is present for which this private connection is needed.", + "The private connection is in failed state." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Required. Private connection type.", + "enum": [ + "TYPE_UNSPECIFIED", + "PRIVATE_SERVICE_ACCESS", + "NETAPP_CLOUD_VOLUMES", + "DELL_POWERSCALE", + "THIRD_PARTY_SERVICE" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Connection used for establishing [private services access](https://cloud.google.com/vpc/docs/private-services-access).", + "Connection used for connecting to NetApp Cloud Volumes.", + "Connection used for connecting to Dell PowerScale.", + "Connection used for connecting to third-party services." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vmwareEngineNetwork": { + "description": "Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: `projects/{project}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}` where `{project}`, `{location}` will be same as specified in private connection resource name and `{vmware_engine_network_id}` will be in the form of `{location}`-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default.", + "type": "string" + }, + "vmwareEngineNetworkCanonical": { + "description": "Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number}/locations/{location}/vmwareEngineNetworks/{vmware_engine_network_id}`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "ResetNsxCredentialsRequest": { + "description": "Request message for VmwareEngine.ResetNsxCredentials", + "id": "ResetNsxCredentialsRequest", + "properties": { + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "ResetVcenterCredentialsRequest": { + "description": "Request message for VmwareEngine.ResetVcenterCredentials", + "id": "ResetVcenterCredentialsRequest", + "properties": { + "requestId": { + "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "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" + }, + "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" + }, + "Subnet": { + "description": "Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated.", + "id": "Subnet", + "properties": { + "gatewayIp": { + "description": "The IP address of the gateway of this subnet. Must fall within the IP prefix defined above.", + "type": "string" + }, + "ipCidrRange": { + "description": "The IP address range of the subnet in CIDR format '10.0.0.0/24'.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet`", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. The state of the resource.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING", + "UPDATING", + "DELETING", + "RECONCILING", + "FAILED" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "The subnet is ready.", + "The subnet is being created.", + "The subnet is being updated.", + "The subnet is being deleted.", + "Changes requested in the last operation are being propagated.", + "Last operation on the subnet did not succeed. Subnet's payload is reverted back to its most recent working state." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. The type of the subnet. For example \"management\" or \"userDefined\".", + "readOnly": true, + "type": "string" + } + }, + "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" + }, + "UndeletePrivateCloudRequest": { + "description": "Request message for VmwareEngine.UndeletePrivateCloud", + "id": "UndeletePrivateCloudRequest", + "properties": { + "requestId": { + "description": "Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", + "type": "string" + } + }, + "type": "object" + }, + "Vcenter": { + "description": "Details about a vCenter Server management appliance.", + "id": "Vcenter", + "properties": { + "fqdn": { + "description": "Fully qualified domain name of the appliance.", + "type": "string" + }, + "internalIp": { + "description": "Internal IP address of the appliance.", + "type": "string" + }, + "state": { + "description": "Output only. The state of the appliance.", + "enum": [ + "STATE_UNSPECIFIED", + "ACTIVE", + "CREATING" + ], + "enumDescriptions": [ + "Unspecified appliance state. This is the default value.", + "The appliance is operational and can be used.", + "The appliance is being deployed." + ], + "readOnly": true, + "type": "string" + }, + "version": { + "description": "Version of the appliance.", + "type": "string" + } + }, + "type": "object" + }, + "VmwareEngineNetwork": { + "description": "VMware Engine network resource that provides connectivity for VMware Engine private clouds.", + "id": "VmwareEngineNetwork", + "properties": { + "createTime": { + "description": "Output only. Creation time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "User-provided description for this VMware Engine network.", + "type": "string" + }, + "etag": { + "description": "Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network`", + "readOnly": true, + "type": "string" + }, + "state": { + "description": "Output only. State of the VMware Engine network.", + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "ACTIVE", + "UPDATING", + "DELETING" + ], + "enumDescriptions": [ + "The default value. This value is used if the state is omitted.", + "The VMware Engine network is being created.", + "The VMware Engine network is ready.", + "The VMware Engine network is being updated.", + "The VMware Engine network is being deleted." + ], + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Required. VMware Engine network type.", + "enum": [ + "TYPE_UNSPECIFIED", + "LEGACY" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "Network type used by private clouds created in projects without a network of type `STANDARD`. This network type is no longer used for new VMware Engine private cloud deployments." + ], + "type": "string" + }, + "uid": { + "description": "Output only. System-generated unique identifier for the resource.", + "readOnly": true, + "type": "string" + }, + "updateTime": { + "description": "Output only. Last update time of this resource.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "vpcNetworks": { + "description": "Output only. VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects, the internet, and other Google Cloud services.", + "items": { + "$ref": "VpcNetwork" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "VpcNetwork": { + "description": "Represents a VMware Engine VPC network that is managed by a VMware Engine network resource.", + "id": "VpcNetwork", + "properties": { + "network": { + "description": "Output only. The relative resource name of the service VPC network this VMware Engine network is attached to. For example: `projects/123123/global/networks/my-network`", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Output only. Type of VPC network (INTRANET, INTERNET, or GOOGLE_CLOUD)", + "enum": [ + "TYPE_UNSPECIFIED", + "INTRANET", + "INTERNET", + "GOOGLE_CLOUD" + ], + "enumDescriptions": [ + "The default value. This value should never be used.", + "VPC network that will be peered with a consumer VPC network or the intranet VPC of another VMware Engine network. Access a private cloud through Compute Engine VMs on a peered VPC network or an on-premises resource connected to a peered consumer VPC network.", + "VPC network used for internet access to and from a private cloud.", + "VPC network used for access to Google Cloud services like Cloud Storage." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + } + }, + "servicePath": "", + "title": "VMware Engine API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/discovery/youtube-v3.json b/discovery/youtube-v3.json index f5eb1affbc..fa47ca4f76 100644 --- a/discovery/youtube-v3.json +++ b/discovery/youtube-v3.json @@ -717,6 +717,11 @@ "location": "query", "type": "string" }, + "forHandle": { + "description": "Return the channel associated with a YouTube handle. UNIMPLEMENTED.", + "location": "query", + "type": "string" + }, "forUsername": { "description": "Return the channel associated with a YouTube username.", "location": "query", @@ -3847,7 +3852,7 @@ } } }, - "revision": "20230920", + "revision": "20231009", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { diff --git a/release-please-config.json b/release-please-config.json index ec648e1dea..486626d089 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -279,6 +279,8 @@ "src/apis/metastore": {}, "src/apis/rapidmigrationassessment": {}, "src/apis/playgrouping": {}, - "src/apis/alloydb": {} + "src/apis/alloydb": {}, + "src/apis/backupdr": {}, + "src/apis/vmwareengine": {} } } \ No newline at end of file diff --git a/src/apis/admin/directory_v1.ts b/src/apis/admin/directory_v1.ts index 2ee4d10cbf..58f734ab13 100644 --- a/src/apis/admin/directory_v1.ts +++ b/src/apis/admin/directory_v1.ts @@ -1550,7 +1550,7 @@ export namespace admin_directory_v1 { */ export interface Schema$OrgUnit { /** - * Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. We recommend using the default value because setting `block_inheritance` to `true` can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075). + * Determines if a sub-organizational unit can inherit the settings of the parent organization. The default value is `false`, meaning a sub-organizational unit inherits the settings of the nearest parent organizational unit. This field is deprecated. Setting it to `true` is no longer supported and can have _unintended consequences_. For more information about inheritance and users in an organization structure, see the [administration help center](https://support.google.com/a/answer/4352075). */ blockInheritance?: boolean | null; /** diff --git a/src/apis/aiplatform/v1.ts b/src/apis/aiplatform/v1.ts index c92b5e1f48..c14f02d975 100644 --- a/src/apis/aiplatform/v1.ts +++ b/src/apis/aiplatform/v1.ts @@ -1159,7 +1159,7 @@ export namespace aiplatform_v1 { genericMetadata?: Schema$GoogleCloudAiplatformV1GenericOperationMetadata; } /** - * Request message for FeaturestoreService.CreateFeature. + * Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature. */ export interface Schema$GoogleCloudAiplatformV1CreateFeatureRequest { /** @@ -1167,12 +1167,9 @@ export namespace aiplatform_v1 { */ feature?: Schema$GoogleCloudAiplatformV1Feature; /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType . + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. */ featureId?: string | null; - /** - * Required. The resource name of the EntityType to create a Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ parent?: string | null; } /** @@ -1593,6 +1590,31 @@ export namespace aiplatform_v1 { */ updateTime?: string | null; } + /** + * Describes the dataset version. + */ + export interface Schema$GoogleCloudAiplatformV1DatasetVersion { + /** + * Output only. Name of the associated BigQuery dataset. + */ + bigQueryDatasetName?: string | null; + /** + * Output only. Timestamp when this DatasetVersion was created. + */ + createTime?: string | null; + /** + * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Output only. The resource name of the DatasetVersion. + */ + name?: string | null; + /** + * Output only. Timestamp when this DatasetVersion was last updated. + */ + updateTime?: string | null; + } /** * A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. */ @@ -3942,6 +3964,19 @@ export namespace aiplatform_v1 { */ nextPageToken?: string | null; } + /** + * Response message for DatasetService.ListDatasetVersions. + */ + export interface Schema$GoogleCloudAiplatformV1ListDatasetVersionsResponse { + /** + * A list of DatasetVersions that matches the specified filter in the request. + */ + datasetVersions?: Schema$GoogleCloudAiplatformV1DatasetVersion[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } /** * Response message for EndpointService.ListEndpoints. */ @@ -3982,7 +4017,7 @@ export namespace aiplatform_v1 { nextPageToken?: string | null; } /** - * Response message for FeaturestoreService.ListFeatures. + * Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures. */ export interface Schema$GoogleCloudAiplatformV1ListFeaturesResponse { /** @@ -4370,6 +4405,10 @@ export namespace aiplatform_v1 { * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */ machineType?: string | null; + /** + * Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). + */ + tpuTopology?: string | null; } /** * Manual batch tuning parameters. @@ -5190,6 +5229,10 @@ export namespace aiplatform_v1 { * Dump the anomalies to Cloud Logging. The anomalies will be put to json payload encoded from proto google.cloud.aiplatform.logging.ModelMonitoringAnomaliesLogEntry. This can be further sinked to Pub/Sub or any other services supported by Cloud Logging. */ enableLogging?: boolean | null; + /** + * Resource names of the NotificationChannels to send alert. Must be of the format `projects//notificationChannels/` + */ + notificationChannels?: string[] | null; } /** * The config for email alert. @@ -5804,7 +5847,7 @@ export namespace aiplatform_v1 { */ healthState?: string | null; /** - * The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "BigQuery" or "Vertex"; if absent, it should be "Vertex". This is to describe the entry service, either BigQuery or Vertex. + * The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex. */ labels?: {[key: string]: string} | null; /** @@ -5815,6 +5858,10 @@ export namespace aiplatform_v1 { * Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from. */ notebookRuntimeTemplateRef?: Schema$GoogleCloudAiplatformV1NotebookRuntimeTemplateRef; + /** + * Output only. The type of the notebook runtime. + */ + notebookRuntimeType?: string | null; /** * Output only. The proxy endpoint used to access the NotebookRuntime. */ @@ -5892,6 +5939,10 @@ export namespace aiplatform_v1 { * Optional. Network spec. */ networkSpec?: Schema$GoogleCloudAiplatformV1NetworkSpec; + /** + * Optional. Immutable. The type of the notebook runtime template. + */ + notebookRuntimeType?: string | null; /** * The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */ @@ -6004,7 +6055,7 @@ export namespace aiplatform_v1 { */ templateMetadata?: Schema$GoogleCloudAiplatformV1PipelineTemplateMetadata; /** - * A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. + * A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. */ templateUri?: string | null; /** @@ -7930,6 +7981,28 @@ export namespace aiplatform_v1 { */ status?: string | null; } + /** + * The configuration for grounding checking. + */ + export interface Schema$GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig { + /** + * The sources for the grounding checking. + */ + sources?: Schema$GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry[]; + } + /** + * Single source entry for the grounding checking. + */ + export interface Schema$GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfigSourceEntry { + /** + * The uri of the Enterprise Search data source. + */ + enterpriseDatastore?: string | null; + /** + * The type of the grounding checking source. + */ + type?: string | null; + } /** * Prediction model parameters for Image Classification. */ @@ -8364,10 +8437,18 @@ export namespace aiplatform_v1 { * The metadata of Datasets that contain Text Prompt data. */ export interface Schema$GoogleCloudAiplatformV1SchemaTextPromptDatasetMetadata { + /** + * Number of candidates. + */ + candidateCount?: string | null; /** * The Google Cloud Storage URI that stores the prompt data. */ gcsUri?: string | null; + /** + * Grounding checking configuration. + */ + groundingConfig?: Schema$GoogleCloudAiplatformV1SchemaPredictParamsGroundingConfig; /** * Value of the maximum number of tokens generated set when the dataset was saved. */ @@ -8376,6 +8457,10 @@ export namespace aiplatform_v1 { * Type of the prompt dataset. */ promptType?: string | null; + /** + * Customized stop sequences. + */ + stopSequences?: string[] | null; /** * Temperature value used for sampling set when the dataset was saved. This value is used to tune the degree of randomness. */ @@ -14197,6 +14282,7 @@ export namespace aiplatform_v1 { context: APIRequestContext; annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; dataItems: Resource$Projects$Locations$Datasets$Dataitems; + datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; operations: Resource$Projects$Locations$Datasets$Operations; savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; constructor(context: APIRequestContext) { @@ -14206,6 +14292,8 @@ export namespace aiplatform_v1 { this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( this.context ); + this.datasetVersions = + new Resource$Projects$Locations$Datasets$Datasetversions(this.context); this.operations = new Resource$Projects$Locations$Datasets$Operations( this.context ); @@ -17063,6 +17151,551 @@ export namespace aiplatform_v1 { timeout?: string; } + export class Resource$Projects$Locations$Datasets$Datasetversions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Create a version from a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a Dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a Dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists DatasetVersions in a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Restores a dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + callback: BodyResponseCallback + ): void; + restore( + callback: BodyResponseCallback + ): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List + extends StandardParameters { + /** + * Optional. The standard list filter. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + extends StandardParameters { + /** + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + export class Resource$Projects$Locations$Datasets$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -23893,11 +24526,11 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create extends StandardParameters { /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType . + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. */ featureId?: string; /** - * Required. The resource name of the EntityType to create a Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * */ parent?: string; @@ -23909,14 +24542,14 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete extends StandardParameters { /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get extends StandardParameters { /** - * Required. The name of the Feature resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The name of the Feature resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ name?: string; } @@ -23943,7 +24576,7 @@ export namespace aiplatform_v1 { */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The resource name of the Location to list Features. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ parent?: string; /** @@ -39281,7 +39914,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** @@ -40030,7 +40663,7 @@ export namespace aiplatform_v1 { export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** diff --git a/src/apis/aiplatform/v1beta1.ts b/src/apis/aiplatform/v1beta1.ts index 869e8e418e..418bad4c5e 100644 --- a/src/apis/aiplatform/v1beta1.ts +++ b/src/apis/aiplatform/v1beta1.ts @@ -1223,6 +1223,24 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } + /** + * Details of operations that perform create FeatureGroup. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CreateFeatureGroupOperationMetadata { + /** + * Operation metadata for FeatureGroup. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } + /** + * Details of operations that perform create FeatureOnlineStore. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CreateFeatureOnlineStoreOperationMetadata { + /** + * Operation metadata for FeatureOnlineStore. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } /** * Details of operations that perform create Feature. */ @@ -1233,7 +1251,7 @@ export namespace aiplatform_v1beta1 { genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } /** - * Request message for FeaturestoreService.CreateFeature. + * Request message for FeaturestoreService.CreateFeature. Request message for FeatureRegistryService.CreateFeature. */ export interface Schema$GoogleCloudAiplatformV1beta1CreateFeatureRequest { /** @@ -1241,12 +1259,9 @@ export namespace aiplatform_v1beta1 { */ feature?: Schema$GoogleCloudAiplatformV1beta1Feature; /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType . + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. */ featureId?: string | null; - /** - * Required. The resource name of the EntityType to create a Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` - */ parent?: string | null; } /** @@ -1258,6 +1273,15 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } + /** + * Details of operations that perform create FeatureView. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CreateFeatureViewOperationMetadata { + /** + * Operation metadata for FeatureView Create. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } /** * Runtime operation information for IndexEndpointService.CreateIndexEndpoint. */ @@ -1324,6 +1348,15 @@ export namespace aiplatform_v1beta1 { */ pipelineJobId?: string | null; } + /** + * Details of operations that perform create FeatureGroup. + */ + export interface Schema$GoogleCloudAiplatformV1beta1CreateRegistryFeatureOperationMetadata { + /** + * Operation metadata for Feature. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } /** * Runtime operation information for SolverService.CreateSolver. */ @@ -1689,6 +1722,31 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * Describes the dataset version. + */ + export interface Schema$GoogleCloudAiplatformV1beta1DatasetVersion { + /** + * Output only. Name of the associated BigQuery dataset. + */ + bigQueryDatasetName?: string | null; + /** + * Output only. Timestamp when this DatasetVersion was created. + */ + createTime?: string | null; + /** + * Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Output only. The resource name of the DatasetVersion. + */ + name?: string | null; + /** + * Output only. Timestamp when this DatasetVersion was last updated. + */ + updateTime?: string | null; + } /** * A description of resources that are dedicated to a DeployedModel, and that need a higher degree of manual configuration. */ @@ -3044,6 +3102,52 @@ export namespace aiplatform_v1beta1 { */ valueType?: string | null; } + /** + * Vertex AI Feature Group. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureGroup { + /** + * Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source, which is required to have an entity_id and a feature_timestamp column in the source. + */ + bigQuery?: Schema$GoogleCloudAiplatformV1beta1FeatureGroupBigQuery; + /** + * Output only. Timestamp when this FeatureGroup was created. + */ + createTime?: string | null; + /** + * Optional. Description of the FeatureGroup. + */ + description?: string | null; + /** + * Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Optional. The labels with user-defined metadata to organize your FeatureGroup. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` + */ + name?: string | null; + /** + * Output only. Timestamp when this FeatureGroup was last updated. + */ + updateTime?: string | null; + } + /** + * Input source type for BigQuery Tables and Views. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureGroupBigQuery { + /** + * Required. Immutable. The BigQuery source URI that points to either a BigQuery Table or View. + */ + bigQuerySource?: Schema$GoogleCloudAiplatformV1beta1BigQuerySource; + /** + * Optional. Columns to construct entity_id / row keys. Currently only supports 1 entity_id_column. If not provided defaults to `entity_id`. + */ + entityIdColumns?: string[] | null; + } /** * A list of historical SnapshotAnalysis or ImportFeaturesAnalysis stats requested by user, sorted by FeatureStatsAnomaly.start_time descending. */ @@ -3079,6 +3183,85 @@ export namespace aiplatform_v1beta1 { */ sigma?: number | null; } + /** + * Vertex AI Feature Online Store provides a centralized repository for serving ML features and embedding indexes at low latency. The Feature Online Store is a top-level container. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore { + /** + * Contains settings for the Cloud Bigtable instance that will be created to serve featureValues for all FeatureViews under this FeatureOnlineStore. + */ + bigtable?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable; + /** + * Output only. Timestamp when this FeatureOnlineStore was created. + */ + createTime?: string | null; + /** + * Optional. The dedicated serving endpoint for this FeatureOnlineStore, which is different from common Vertex service endpoint. + */ + dedicatedServingEndpoint?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint; + /** + * Optional. The settings for embedding management in FeatureOnlineStore. + */ + embeddingManagement?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement; + /** + * Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Optional. The labels with user-defined metadata to organize your FeatureOnlineStore. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + */ + name?: string | null; + /** + * Output only. State of the featureOnlineStore. + */ + state?: string | null; + /** + * Output only. Timestamp when this FeatureOnlineStore was last updated. + */ + updateTime?: string | null; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtable { + /** + * Required. Autoscaling config applied to Bigtable Instance. + */ + autoScaling?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreBigtableAutoScaling { + /** + * Optional. A percentage of the cluster's CPU capacity. Can be from 10% to 80%. When a cluster's CPU utilization exceeds the target that you have set, Bigtable immediately adds nodes to the cluster. When CPU utilization is substantially lower than the target, Bigtable removes nodes. If not set will default to 50%. + */ + cpuUtilizationTarget?: number | null; + /** + * Required. The maximum number of nodes to scale up to. Must be greater than or equal to min_node_count, and less than or equal to 10 times of 'min_node_count'. + */ + maxNodeCount?: number | null; + /** + * Required. The minimum number of nodes to scale down to. Must be greater than or equal to 1. + */ + minNodeCount?: number | null; + } + /** + * The dedicated serving endpoint for this FeatureOnlineStore. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreDedicatedServingEndpoint { + /** + * Output only. This field will be populated with the domain name to use for this FeatureOnlineStore + */ + publicEndpointDomainName?: string | null; + } + /** + * Contains settings for embedding management. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStoreEmbeddingManagement { + /** + * Optional. Immutable. Whether to enable embedding management in this FeatureOnlineStore. It's immutable after creation to ensure the FeatureOnlineStore availability. + */ + enabled?: boolean | null; + } /** * Selector for Features of an EntityType. */ @@ -3336,6 +3519,194 @@ export namespace aiplatform_v1beta1 { */ generateTime?: string | null; } + /** + * FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureView { + /** + * Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore. + */ + bigQuerySource?: Schema$GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource; + /** + * Output only. Timestamp when this FeatureView was created. + */ + createTime?: string | null; + /** + * Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. + */ + etag?: string | null; + /** + * Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. + */ + featureRegistrySource?: Schema$GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource; + /** + * Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string | null; + /** + * Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving. + */ + syncConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewSyncConfig; + /** + * Output only. Timestamp when this FeatureView was last updated. + */ + updateTime?: string | null; + /** + * Optional. Configuration for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving. + */ + vectorSearchConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewBigQuerySource { + /** + * Required. Columns to construct entity_id / row keys. Start by supporting 1 only. + */ + entityIdColumns?: string[] | null; + /** + * Required. The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig. + */ + uri?: string | null; + } + /** + * A Feature Registry source for features that need to be synced to Online Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySource { + /** + * Required. List of features that need to be synced to Online Store. + */ + featureGroups?: Schema$GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup[]; + } + /** + * Features belonging to a single feature group that will be synced to Online Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewFeatureRegistrySourceFeatureGroup { + /** + * Required. Identifier of the feature group. + */ + featureGroupId?: string | null; + /** + * Required. Identifiers of features under the feature group. + */ + featureIds?: string[] | null; + } + /** + * FeatureViewSync is a representation of sync operation which copies data from data source to Feature View in Online Store. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewSync { + /** + * Output only. Time when this FeatureViewSync is created. Creation of a FeatureViewSync means that the job is pending / waiting for sufficient resources but may not have started the actual data transfer yet. + */ + createTime?: string | null; + /** + * Output only. Final status of the FeatureViewSync. + */ + finalStatus?: Schema$GoogleRpcStatus; + /** + * Output only. Name of the FeatureViewSync. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + name?: string | null; + /** + * Output only. Time when this FeatureViewSync is finished. + */ + runTime?: Schema$GoogleTypeInterval; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewSyncConfig { + /** + * Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs. To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: "CRON_TZ=${IANA_TIME_ZONE\}" or "TZ=${IANA_TIME_ZONE\}". The ${IANA_TIME_ZONE\} may only be a valid string from IANA time zone database. For example, "CRON_TZ=America/New_York 1 * * * *", or "TZ=America/New_York 1 * * * *". + */ + cron?: string | null; + } + /** + * Configuration for vector search. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfig { + /** + * Optional. Configuration options for using brute force search, which simply implements the standard linear search in the database for each query. It is primarily meant for benchmarking and to generate the ground truth for approximate search. + */ + bruteForceConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig; + /** + * Optional. Column of crowding. This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k' of the k neighbors returned have the same value of crowding_attribute. + */ + crowdingColumn?: string | null; + /** + * Optional. The distance measure used in nearest neighbor search. + */ + distanceMeasureType?: string | null; + /** + * Optional. Column of embedding. This column contains the source data to create index for vector search. embedding_column must be set when using vector search. + */ + embeddingColumn?: string | null; + /** + * Optional. The number of dimensions of the input embedding. + */ + embeddingDimension?: number | null; + /** + * Optional. Columns of features that're used to filter vector search results. + */ + filterColumns?: string[] | null; + /** + * Optional. Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing). Please refer to this paper for more details: https://arxiv.org/abs/1908.10396 + */ + treeAhConfig?: Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig; + } + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigBruteForceConfig {} + export interface Schema$GoogleCloudAiplatformV1beta1FeatureViewVectorSearchConfigTreeAHConfig { + /** + * Optional. Number of embeddings on each leaf node. The default value is 1000 if not set. + */ + leafNodeEmbeddingCount?: string | null; + } + /** + * Request message for FeatureOnlineStoreService.FetchFeatureValues. All the features under the requested feature view will be returned. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest { + /** + * Specify response data format. If not set, KeyValue format will be used. + */ + format?: string | null; + /** + * Simple ID. The whole string will be used as is to identify Entity to fetch feature values for. + */ + id?: string | null; + } + /** + * Response message for FeatureOnlineStoreService.FetchFeatureValues + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse { + /** + * Feature values in KeyValue format. + */ + keyValues?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList; + /** + * Feature values in proto Struct format. + */ + protoStruct?: {[key: string]: any} | null; + } + /** + * Response structure in the format of key (feature name) and (feature) value pair. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairList { + /** + * List of feature names and values. + */ + features?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair[]; + } + /** + * Feature name & value pair. + */ + export interface Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponseFeatureNameValuePairListFeatureNameValuePair { + /** + * Feature short name. + */ + name?: string | null; + /** + * Feature value. + */ + value?: Schema$GoogleCloudAiplatformV1beta1FeatureValue; + } /** * Assigns input data to training, validation, and test sets based on the given filters, data pieces not matched by any filter are ignored. Currently only supported for Datasets containing DataItems. If any of the filters in this message are to match nothing, then they can be set as '-' (the minus sign). Supported only for unstructured Datasets. */ @@ -3512,6 +3883,15 @@ export namespace aiplatform_v1beta1 { */ updateTime?: string | null; } + /** + * Contains information about the source of the models generated from Generative AI Studio. + */ + export interface Schema$GoogleCloudAiplatformV1beta1GenieSource { + /** + * Required. The public base model URI. + */ + baseModelUri?: string | null; + } /** * Represents a HyperparameterTuningJob. A HyperparameterTuningJob has a Study specification and multiple CustomJobs with identical CustomJob specification. */ @@ -4154,6 +4534,19 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for DatasetService.ListDatasetVersions. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListDatasetVersionsResponse { + /** + * A list of DatasetVersions that matches the specified filter in the request. + */ + datasetVersions?: Schema$GoogleCloudAiplatformV1beta1DatasetVersion[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } /** * Response message for ListDeploymentResourcePools method. */ @@ -4207,7 +4600,33 @@ export namespace aiplatform_v1beta1 { nextPageToken?: string | null; } /** - * Response message for FeaturestoreService.ListFeatures. + * Response message for FeatureRegistryService.ListFeatureGroups. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListFeatureGroupsResponse { + /** + * The FeatureGroups matching the request. + */ + featureGroups?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup[]; + /** + * A token, which can be sent as ListFeatureGroupsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for FeatureOnlineStoreAdminService.ListFeatureOnlineStores. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListFeatureOnlineStoresResponse { + /** + * The FeatureOnlineStores matching the request. + */ + featureOnlineStores?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore[]; + /** + * A token, which can be sent as ListFeatureOnlineStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for FeaturestoreService.ListFeatures. Response message for FeatureRegistryService.ListFeatures. */ export interface Schema$GoogleCloudAiplatformV1beta1ListFeaturesResponse { /** @@ -4232,6 +4651,32 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * Response message for FeatureOnlineStoreAdminService.ListFeatureViews. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListFeatureViewsResponse { + /** + * The FeatureViews matching the request. + */ + featureViews?: Schema$GoogleCloudAiplatformV1beta1FeatureView[]; + /** + * A token, which can be sent as ListFeatureViewsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } + /** + * Response message for FeatureOnlineStoreAdminService.ListFeatureViewSyncs. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListFeatureViewSyncsResponse { + /** + * The FeatureViewSyncs matching the request. + */ + featureViewSyncs?: Schema$GoogleCloudAiplatformV1beta1FeatureViewSync[]; + /** + * A token, which can be sent as ListFeatureViewSyncsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + } /** * Response message for JobService.ListHyperparameterTuningJobs */ @@ -4450,6 +4895,19 @@ export namespace aiplatform_v1beta1 { */ pipelineJobs?: Schema$GoogleCloudAiplatformV1beta1PipelineJob[]; } + /** + * Response message for ModelGardenService.ListPublisherModels. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ListPublisherModelsResponse { + /** + * A token to retrieve next page of results. Pass to ListPublisherModels.page_token to obtain that page. + */ + nextPageToken?: string | null; + /** + * List of PublisherModels in the requested page. + */ + publisherModels?: Schema$GoogleCloudAiplatformV1beta1PublisherModel[]; + } /** * Response message for DatasetService.ListSavedQueries. */ @@ -4605,6 +5063,10 @@ export namespace aiplatform_v1beta1 { * Immutable. The type of the machine. See the [list of machine types supported for prediction](https://cloud.google.com/vertex-ai/docs/predictions/configure-compute#machine-types) See the [list of machine types supported for custom training](https://cloud.google.com/vertex-ai/docs/training/configure-compute#machine-types). For DeployedModel this field is optional, and the default value is `n1-standard-2`. For BatchPredictionJob or as part of WorkerPoolSpec this field is required. */ machineType?: string | null; + /** + * Immutable. The topology of the TPUs. Corresponds to the TPU topologies available from GKE. (Example: tpu_topology: "2x2x1"). + */ + tpuTopology?: string | null; } /** * Manual batch tuning parameters. @@ -4966,6 +5428,10 @@ export namespace aiplatform_v1beta1 { * The default explanation specification for this Model. The Model can be used for requesting explanation after being deployed if it is populated. The Model can be used for batch explanation if it is populated. All fields of the explanation_spec can be overridden by explanation_spec of DeployModelRequest.deployed_model, or explanation_spec of BatchPredictionJob. If the default explanation specification is not set for this Model, this Model can still be used for requesting explanation by setting explanation_spec of DeployModelRequest.deployed_model and for batch explanation by setting explanation_spec of BatchPredictionJob. */ explanationSpec?: Schema$GoogleCloudAiplatformV1beta1ExplanationSpec; + /** + * Optional. Used to specify the source of the Model Garden model or Genie models. Only present for models created or tuned from Model Garden and Genie. + */ + generatedModelSource?: Schema$GoogleCloudAiplatformV1beta1ModelGeneratedModelSource; /** * The labels with user-defined metadata to organize your Models. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. */ @@ -5421,6 +5887,28 @@ export namespace aiplatform_v1beta1 { */ id?: string | null; } + /** + * Contains information about the source of the models generated from Model Garden. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ModelGardenSource { + /** + * Required. The model garden source model resource name. + */ + publicModelName?: string | null; + } + /** + * Used to specify the source of the Model Garden model or Genie models. Only present for models created or tuned from Model Garden and Genie. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ModelGeneratedModelSource { + /** + * Information about the base model of Genie models. + */ + genieSource?: Schema$GoogleCloudAiplatformV1beta1GenieSource; + /** + * Source information of Model Garden models. + */ + modelGardenSource?: Schema$GoogleCloudAiplatformV1beta1ModelGardenSource; + } export interface Schema$GoogleCloudAiplatformV1beta1ModelMonitoringAlertConfig { /** * Email alert config. @@ -5918,6 +6406,83 @@ export namespace aiplatform_v1beta1 { */ trainTrial?: Schema$GoogleCloudAiplatformV1beta1NasTrial; } + /** + * A query to find a number of similar entities. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborQuery { + /** + * Optional. The embedding vector that be used for similar search. + */ + embedding?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding; + /** + * Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id. + */ + entityId?: string | null; + /** + * Optional. The number of similar entities to be retrieved from feature view for each query. + */ + neighborCount?: number | null; + /** + * Optional. Parameters that can be set to tune query on the fly. + */ + parameters?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters; + /** + * Optional. Crowding is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than sper_crowding_attribute_neighbor_count of the k neighbors returned have the same value of crowding_attribute. It's used for improving result diversity. + */ + perCrowdingAttributeNeighborCount?: number | null; + /** + * Optional. The list of string filters. + */ + stringFilters?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter[]; + } + /** + * The embedding vector. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryEmbedding { + /** + * Optional. Individual value in the embedding. + */ + value?: number[] | null; + } + /** + * Parameters that can be overrided in each query to tune query latency and recall. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryParameters { + /** + * Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be \> neighbor_count. + */ + approximateNeighborCandidates?: number | null; + /** + * Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0. + */ + leafNodesSearchFraction?: number | null; + } + /** + * String filter is used to search a subset of the entities by using boolean rules. For example: if a query specifies string filter with 'name = color, allow_tokens = {red, blue\}, deny_tokens = {purple\}',' then that query will match entities that are red or blue, but if those points are also purple, then they will be excluded even if they are red/blue. Only string filter is supported for now, numeric filter will be supported in the near future. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborQueryStringFilter { + /** + * Optional. The allowed tokens. + */ + allowTokens?: string[] | null; + /** + * Optional. The denied tokens. + */ + denyTokens?: string[] | null; + /** + * Required. Column names in BigQuery that used as filters. + */ + name?: string | null; + } + /** + * Nearest neighbors for one query. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighbors { + /** + * All its neighbors. + */ + neighbors?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor[]; + } /** * Runtime operation metadata with regard to Matching Engine Index. */ @@ -5971,6 +6536,23 @@ export namespace aiplatform_v1beta1 { */ sourceGcsUri?: string | null; } + /** + * A neighbor of the query vector. + */ + export interface Schema$GoogleCloudAiplatformV1beta1NearestNeighborsNeighbor { + /** + * The distance between the neighbor and the query vector. + */ + distance?: number | null; + /** + * The id of the similar entity. + */ + entityId?: string | null; + /** + * The attributes of the neighbor, e.g. filters, crowding and metadata Note that full entities are returned only when "return_full_entity" is set to true. Otherwise, only the "entity_id" and "distance" fields are populated. + */ + entityKeyValues?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesResponse; + } /** * Neighbors for example-based explanations. */ @@ -6069,7 +6651,7 @@ export namespace aiplatform_v1beta1 { */ healthState?: string | null; /** - * The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one Dataset (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "BigQuery" or "Vertex"; if absent, it should be "Vertex". This is to describe the entry service, either BigQuery or Vertex. + * The labels with user-defined metadata to organize your NotebookRuntime. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one NotebookRuntime (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. Following system labels exist for NotebookRuntime: * "aiplatform.googleapis.com/notebook_runtime_gce_instance_id": output only, its value is the Compute Engine instance id. * "aiplatform.googleapis.com/colab_enterprise_entry_service": its value is either "bigquery" or "vertex"; if absent, it should be "vertex". This is to describe the entry service, either BigQuery or Vertex. */ labels?: {[key: string]: string} | null; /** @@ -6080,6 +6662,10 @@ export namespace aiplatform_v1beta1 { * Output only. The pointer to NotebookRuntimeTemplate this NotebookRuntime is created from. */ notebookRuntimeTemplateRef?: Schema$GoogleCloudAiplatformV1beta1NotebookRuntimeTemplateRef; + /** + * Output only. The type of the notebook runtime. + */ + notebookRuntimeType?: string | null; /** * Output only. The proxy endpoint used to access the NotebookRuntime. */ @@ -6157,6 +6743,10 @@ export namespace aiplatform_v1beta1 { * Optional. Network spec. */ networkSpec?: Schema$GoogleCloudAiplatformV1beta1NetworkSpec; + /** + * Optional. Immutable. The type of the notebook runtime template. + */ + notebookRuntimeType?: string | null; /** * The service account that the runtime workload runs as. You can use any service account within the same project, but you must have the service account user permission to use the instance. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. */ @@ -6225,11 +6815,11 @@ export namespace aiplatform_v1beta1 { */ name?: string | null; /** - * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources is not peered with any network. + * Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project\}/global/networks/{network\}`. Where {project\} is a project number, as in `12345`, and {network\} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network. */ network?: string | null; /** - * Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided ip ranges. Otherwise, the persistent resource will be deployed to any ip ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. + * Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range']. */ reservedIpRanges?: string[] | null; /** @@ -6241,7 +6831,7 @@ export namespace aiplatform_v1beta1 { */ resourceRuntime?: Schema$GoogleCloudAiplatformV1beta1ResourceRuntime; /** - * Optional. Persistent Resource runtime spec. Used for e.g. Ray cluster configuration. + * Optional. Persistent Resource runtime spec. For example, used for Ray cluster configuration. */ resourceRuntimeSpec?: Schema$GoogleCloudAiplatformV1beta1ResourceRuntimeSpec; /** @@ -6330,7 +6920,7 @@ export namespace aiplatform_v1beta1 { */ templateMetadata?: Schema$GoogleCloudAiplatformV1beta1PipelineTemplateMetadata; /** - * A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. + * A template uri from where the PipelineJob.pipeline_spec, if empty, will be downloaded. Currently, only uri from Vertex Template Registry & Gallery is supported. Reference to https://cloud.google.com/vertex-ai/docs/pipelines/create-pipeline-template. */ templateUri?: string | null; /** @@ -7044,15 +7634,15 @@ export namespace aiplatform_v1beta1 { */ export interface Schema$GoogleCloudAiplatformV1beta1RaySpec { /** - * Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field is not set. + * Optional. This will be used to indicate which resource pool will serve as the Ray head node(the first node within that pool). Will use the machine from the first workerpool as the head node by default if this field isn't set. */ headNodeResourcePoolId?: string | null; /** - * Optional. Default image for user to choose a preferred ML framework(e.g. tensorflow or Pytorch) by choosing from Vertex prebuild images(https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image, Otherwise, use the {@code resource_pool_images\} field. + * Optional. Default image for user to choose a preferred ML framework (for example, TensorFlow or Pytorch) by choosing from [Vertex prebuilt images](https://cloud.google.com/vertex-ai/docs/training/pre-built-containers). Either this or the resource_pool_images is required. Use this field if you need all the resource pools to have the same Ray image. Otherwise, use the {@code resource_pool_images\} field. */ imageUri?: string | null; /** - * Optional. Required if image_uri is not set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" \} + * Optional. Required if image_uri isn't set. A map of resource_pool_id to prebuild Ray image if user need to use different images for different head/worker pools. This map needs to cover all the resource pool ids. Example: { "ray_head_node_pool": "head image" "ray_worker_node_pool1": "worker image" "ray_worker_node_pool2": "another worker image" \} */ resourcePoolImages?: {[key: string]: string} | null; } @@ -7240,6 +7830,23 @@ export namespace aiplatform_v1beta1 { * Response message for IndexService.RemoveDatapoints */ export interface Schema$GoogleCloudAiplatformV1beta1RemoveDatapointsResponse {} + /** + * Request message for NotebookInternalService.ReportExecutionEvent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventRequest { + /** + * Required. The type of the event. + */ + eventType?: string | null; + /** + * Required. The VM identity token (a JWT) for authenticating the VM. https://cloud.google.com/compute/docs/instances/verifying-instance-identity + */ + vmToken?: string | null; + } + /** + * Response message for NotebookInternalService.ReportExecutionEvent. + */ + export interface Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventResponse {} /** * LINT.IfChange(report_event_message_types) Request message for NotebookInternalService.ReportRuntimeEvent. */ @@ -7267,7 +7874,7 @@ export namespace aiplatform_v1beta1 { idleShutdownMessage?: string | null; } /** - * Represents the spec a group of resources of same type, e.g. machine, disk and accelerators, in a PersistentResource. + * Represents the spec of a group of resources of the same type, for example machine type, disk, and accelerators, in a PersistentResource. */ export interface Schema$GoogleCloudAiplatformV1beta1ResourcePool { /** @@ -7279,7 +7886,7 @@ export namespace aiplatform_v1beta1 { */ diskSpec?: Schema$GoogleCloudAiplatformV1beta1DiskSpec; /** - * Immutable. The unique ID in a PersistentResource to refer the this resource pool. User can specify it if need to use it, otherwise we will generate it automatically. + * Immutable. The unique ID in a PersistentResource for referring to this resource pool. User can specify it if necessary. Otherwise, it's generated automatically. */ id?: string | null; /** @@ -7322,7 +7929,7 @@ export namespace aiplatform_v1beta1 { notebookRuntimeTemplate?: string | null; } /** - * Configure runtime on a PersistentResource instance, including but may not limited to: * Service accounts used to run the workloads; * Whether make it a dedicated Ray Cluster; + * Configuration for the runtime on a PersistentResource instance, including but not limited to: * Service accounts used to run the workloads. * Whether to make it a dedicated Ray Cluster. */ export interface Schema$GoogleCloudAiplatformV1beta1ResourceRuntimeSpec { /** @@ -10135,16 +10742,38 @@ export namespace aiplatform_v1beta1 { */ nextPageToken?: string | null; } + /** + * The request message for FeatureOnlineStoreService.SearchNearestEntities. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest { + /** + * Required. The query. + */ + query?: Schema$GoogleCloudAiplatformV1beta1NearestNeighborQuery; + /** + * Optional. If set to true, the full entities (including all vector values and metadata) of the nearest neighbors are returned; otherwise only entity id of the nearest neighbors will be returned. Note that returning full entities will significantly increase the latency and cost of the query. + */ + returnFullEntity?: boolean | null; + } + /** + * Response message for FeatureOnlineStoreService.SearchNearestEntities + */ + export interface Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesResponse { + /** + * The nearest neighbors of the query entity. + */ + nearestNeighbors?: Schema$GoogleCloudAiplatformV1beta1NearestNeighbors; + } /** * Configuration for the use of custom service account to run the workloads. */ export interface Schema$GoogleCloudAiplatformV1beta1ServiceAccountSpec { /** - * Required. If true, custom user-managed service account is enforced to run any workloads (e.g. Vertex Jobs) on the resource; Otherwise, will always use [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) + * Required. If true, custom user-managed service account is enforced to run any workloads (for example, Vertex Jobs) on the resource. Otherwise, uses the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents). */ enableCustomServiceAccount?: boolean | null; /** - * Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, e.g. Ray; * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers specified in `ResourceRuntimeSpec`. + * Optional. Default service account that this PersistentResource's workloads run as. The workloads include: * Any runtime specified via `ResourceRuntimeSpec` on creation time, for example, Ray. * Jobs submitted to PersistentResource, if no other service account specified in the job specs. Only works when custom service account is enabled and users have the `iam.serviceAccounts.actAs` permission on this service account. Required if any containers are specified in `ResourceRuntimeSpec`. */ serviceAccount?: string | null; } @@ -10665,6 +11294,19 @@ export namespace aiplatform_v1beta1 { */ trials?: Schema$GoogleCloudAiplatformV1beta1Trial[]; } + /** + * Request message for FeatureOnlineStoreAdminService.SyncFeatureView. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest {} + /** + * Respose message for FeatureOnlineStoreAdminService.SyncFeatureView. + */ + export interface Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewResponse { + /** + * Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` + */ + featureViewSync?: string | null; + } /** * A tensor value type. */ @@ -11291,6 +11933,33 @@ export namespace aiplatform_v1beta1 { * Response message of ModelService.UpdateExplanationDataset operation. */ export interface Schema$GoogleCloudAiplatformV1beta1UpdateExplanationDatasetResponse {} + /** + * Details of operations that perform update FeatureGroup. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpdateFeatureGroupOperationMetadata { + /** + * Operation metadata for FeatureGroup. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } + /** + * Details of operations that perform update FeatureOnlineStore. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpdateFeatureOnlineStoreOperationMetadata { + /** + * Operation metadata for FeatureOnlineStore. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } + /** + * Details of operations that perform update Feature. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpdateFeatureOperationMetadata { + /** + * Operation metadata for Feature Update. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } /** * Details of operations that perform update Featurestore. */ @@ -11300,6 +11969,15 @@ export namespace aiplatform_v1beta1 { */ genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; } + /** + * Details of operations that perform update FeatureView. + */ + export interface Schema$GoogleCloudAiplatformV1beta1UpdateFeatureViewOperationMetadata { + /** + * Operation metadata for FeatureView Update. + */ + genericMetadata?: Schema$GoogleCloudAiplatformV1beta1GenericOperationMetadata; + } /** * Runtime operation information for IndexService.UpdateIndex. */ @@ -14811,6 +15489,7 @@ export namespace aiplatform_v1beta1 { context: APIRequestContext; annotationSpecs: Resource$Projects$Locations$Datasets$Annotationspecs; dataItems: Resource$Projects$Locations$Datasets$Dataitems; + datasetVersions: Resource$Projects$Locations$Datasets$Datasetversions; operations: Resource$Projects$Locations$Datasets$Operations; savedQueries: Resource$Projects$Locations$Datasets$Savedqueries; constructor(context: APIRequestContext) { @@ -14820,6 +15499,8 @@ export namespace aiplatform_v1beta1 { this.dataItems = new Resource$Projects$Locations$Datasets$Dataitems( this.context ); + this.datasetVersions = + new Resource$Projects$Locations$Datasets$Datasetversions(this.context); this.operations = new Resource$Projects$Locations$Datasets$Operations( this.context ); @@ -17701,68 +18382,72 @@ export namespace aiplatform_v1beta1 { timeout?: string; } - export class Resource$Projects$Locations$Datasets$Operations { + export class Resource$Projects$Locations$Datasets$Datasetversions { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * Create a version from a Dataset. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions ): GaxiosPromise; - cancel( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + create( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options?: MethodOptions - ): GaxiosPromise; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - cancel( - params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Create, + callback: BodyResponseCallback ): void; - cancel(callback: BodyResponseCallback): void; - cancel( + create( + callback: BodyResponseCallback + ): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Cancel - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Create; options = {}; } @@ -17775,7 +18460,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + url: (rootUrl + '/v1beta1/{+parent}/datasetVersions').replace( /([^:]\/)\/+/g, '$1' ), @@ -17784,22 +18469,22 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a Dataset version. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17807,53 +18492,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete; options = {}; } @@ -17877,17 +18566,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets a Dataset version. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17895,57 +18584,594 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Datasets$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Datasets$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists DatasetVersions in a Dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/datasetVersions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Restores a dataset version. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: StreamMethodOptions + ): GaxiosPromise; + restore( + params?: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options?: MethodOptions + ): GaxiosPromise; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + restore( + params: Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore, + callback: BodyResponseCallback + ): void; + restore( + callback: BodyResponseCallback + ): void; + restore( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:restore').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Create + extends StandardParameters { + /** + * Required. The name of the Dataset resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1DatasetVersion; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Delete + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Get + extends StandardParameters { + /** + * Required. The resource name of the Dataset version to delete. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$List + extends StandardParameters { + /** + * Optional. The standard list filter. + */ + filter?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Dataset to list DatasetVersions from. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}` + */ + parent?: string; + /** + * Optional. Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Datasets$Datasetversions$Restore + extends StandardParameters { + /** + * Required. The name of the DatasetVersion resource. Format: `projects/{project\}/locations/{location\}/datasets/{dataset\}/datasetVersions/{dataset_version\}` + */ + name?: string; + } + + export class Resource$Projects$Locations$Datasets$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Datasets$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:cancel').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Datasets$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Datasets$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Operations$Get; options = {}; } @@ -24435,28 +25661,103 @@ export namespace aiplatform_v1beta1 { this.operations = new Resource$Projects$Locations$Featuregroups$Operations(this.context); } - } - export class Resource$Projects$Locations$Featuregroups$Features { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featuregroups$Features$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featuregroups$Features$Operations( - this.context - ); - } - } + /** + * Creates a new FeatureGroup in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; - export class Resource$Projects$Locations$Featuregroups$Features$Operations { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Deletes a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24464,53 +25765,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Delete; options = {}; } @@ -24534,17 +25838,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets details of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24552,57 +25856,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Get; options = {}; } @@ -24626,17 +25929,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists FeatureGroups in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24644,57 +25949,56 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params?: Params$Resource$Projects$Locations$Featuregroups$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + params: Params$Resource$Projects$Locations$Featuregroups$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; + {}) as Params$Resource$Projects$Locations$Featuregroups$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; + params = {} as Params$Resource$Projects$Locations$Featuregroups$List; options = {}; } @@ -24707,7 +26011,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureGroups').replace( /([^:]\/)\/+/g, '$1' ), @@ -24716,60 +26020,60 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * Updates the parameters of a single FeatureGroup. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Patch, options?: MethodOptions ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, options: | MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Patch, callback: BodyResponseCallback ): void; - wait( + patch( callback: BodyResponseCallback ): void; - wait( + patch( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + | Params$Resource$Projects$Locations$Featuregroups$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -24785,13 +26089,12 @@ export namespace aiplatform_v1beta1 { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + {}) as Params$Resource$Projects$Locations$Featuregroups$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + params = {} as Params$Resource$Projects$Locations$Featuregroups$Patch; options = {}; } @@ -24804,11 +26107,8 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), @@ -24828,59 +26128,188 @@ export namespace aiplatform_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + export interface Params$Resource$Projects$Locations$Featuregroups$Create extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The ID to use for this FeatureGroup, which will become the final component of the FeatureGroup's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureGroupId?: string; + /** + * Required. The resource name of the Location to create FeatureGroups. Format: `projects/{project\}/locations/{location\}'` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Delete + extends StandardParameters { + /** + * If set to true, any Features under this FeatureGroup will also be deleted. (Otherwise, the request will only work if the FeatureGroup has no Features.) + */ + force?: boolean; + /** + * Required. The name of the FeatureGroup to be deleted. Format: `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + export interface Params$Resource$Projects$Locations$Featuregroups$Get extends StandardParameters { /** - * The name of the operation resource. + * Required. The name of the FeatureGroup resource. */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List + export interface Params$Resource$Projects$Locations$Featuregroups$List extends StandardParameters { /** - * The standard list filter. + * Lists the FeatureGroups that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureGroups created or updated after 2020-01-01. * `labels.env = "prod"` FeatureGroups with label "env" set to "prod". */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of FeatureGroups to return. The service may return fewer than this value. If unspecified, at most 100 FeatureGroups will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous FeatureGroupAdminService.ListFeatureGroups call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureGroupAdminService.ListFeatureGroups must match the call that provided the page token. */ pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureGroups. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + export interface Params$Resource$Projects$Locations$Featuregroups$Patch extends StandardParameters { /** - * The name of the operation resource to wait on. + * Output only. Name of the FeatureGroup. Format: `projects/{project\}/locations/{location\}/featureGroups/{featureGroup\}` */ name?: string; /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Field mask is used to specify the fields to be overwritten in the FeatureGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` */ - timeout?: string; + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureGroup; } - export class Resource$Projects$Locations$Featuregroups$Operations { + export class Resource$Projects$Locations$Featuregroups$Features { context: APIRequestContext; + operations: Resource$Projects$Locations$Featuregroups$Features$Operations; constructor(context: APIRequestContext) { this.context = context; + this.operations = + new Resource$Projects$Locations$Featuregroups$Features$Operations( + this.context + ); } /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * Creates a new Feature in a given FeatureGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24888,53 +26317,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Features$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Delete; options = {}; } @@ -24958,17 +26391,17 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * 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. + * Gets details of a single Feature. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -24976,57 +26409,2720 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featuregroups$Features$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Get - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featuregroups$Features$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists Features in a given FeatureGroup. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/features').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single Feature. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Create + extends StandardParameters { + /** + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. + */ + featureId?: string; + /** + * + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Delete + extends StandardParameters { + /** + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Get + extends StandardParameters { + /** + * Required. The name of the Feature resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$List + extends StandardParameters { + /** + * Lists the Features that match the filter expression. The following filters are supported: * `value_type`: Supports = and != comparisons. * `create_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `update_time`: Supports =, !=, <, \>, \>=, and <= comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `value_type = DOUBLE` --\> Features whose type is DOUBLE. * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> EntityTypes created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> Features having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any Feature which has a label with 'env' as the key. + */ + filter?: string; + /** + * If set, return the most recent ListFeaturesRequest.latest_stats_count of stats for each Feature in response. Valid value is [0, 10]. If number of stats exists < ListFeaturesRequest.latest_stats_count, return all existing stats. + */ + latestStatsCount?: number; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_id` * `value_type` (Not supported for FeatureRegistry Feature) * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of Features to return. The service may return fewer than this value. If unspecified, at most 1000 Features will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeaturestoreService.ListFeatures call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeaturestoreService.ListFeatures must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list Features. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` + */ + parent?: string; + /** + * Mask specifying which fields to read. + */ + readMask?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Patch + extends StandardParameters { + /** + * Immutable. Name of the Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` The last part feature is assigned by the client. The feature can be up to 64 characters long and can consist only of ASCII Latin letters A-Z and a-z, underscore(_), and ASCII digits 0-9 starting with a letter. The value will be unique given an entity type. + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the Features resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `description` * `labels` * `disable_monitoring` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1Feature; + } + + export class Resource$Projects$Locations$Featuregroups$Features$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Features$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featuregroups$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions + ): GaxiosPromise; + wait( + params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options?: MethodOptions + ): GaxiosPromise; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + wait( + params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, + callback: BodyResponseCallback + ): void; + wait( + callback: BodyResponseCallback + ): void; + wait( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:wait').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait + extends StandardParameters { + /** + * The name of the operation resource to wait on. + */ + name?: string; + /** + * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + */ + timeout?: string; + } + + export class Resource$Projects$Locations$Featureonlinestores { + context: APIRequestContext; + featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; + operations: Resource$Projects$Locations$Featureonlinestores$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViews = + new Resource$Projects$Locations$Featureonlinestores$Featureviews( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Operations( + this.context + ); + } + + /** + * Creates a new FeatureOnlineStore in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single FeatureOnlineStore. The FeatureOnlineStore must not contain any FeatureViews. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single FeatureOnlineStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists FeatureOnlineStores in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureOnlineStores').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single FeatureOnlineStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Create + extends StandardParameters { + /** + * Required. The ID to use for this FeatureOnlineStore, which will become the final component of the FeatureOnlineStore's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within the project and location. + */ + featureOnlineStoreId?: string; + /** + * Required. The resource name of the Location to create FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}'` + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Delete + extends StandardParameters { + /** + * If set to true, any FeatureViews and Features for this FeatureOnlineStore will also be deleted. (Otherwise, the request will only work if the FeatureOnlineStore has no FeatureViews.) + */ + force?: boolean; + /** + * Required. The name of the FeatureOnlineStore to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Get + extends StandardParameters { + /** + * Required. The name of the FeatureOnlineStore resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$List + extends StandardParameters { + /** + * Lists the FeatureOnlineStores that match the filter expression. The following fields are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `<=`, and `\>=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality and key presence. Examples: * `create_time \> "2020-01-01" OR update_time \> "2020-01-01"` FeatureOnlineStores created or updated after 2020-01-01. * `labels.env = "prod"` FeatureOnlineStores with label "env" set to "prod". + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported Fields: * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureOnlineStores to return. The service may return fewer than this value. If unspecified, at most 100 FeatureOnlineStores will be returned. The maximum value is 100; any value greater than 100 will be coerced to 100. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureOnlineStores call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureOnlineStores must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the Location to list FeatureOnlineStores. Format: `projects/{project\}/locations/{location\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Patch + extends StandardParameters { + /** + * Output only. Name of the FeatureOnlineStore. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureOnlineStore resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `big_query_source` * `labels` * `sync_config` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureOnlineStore; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews { + context: APIRequestContext; + featureViewSyncs: Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs; + operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.featureViewSyncs = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs( + this.context + ); + this.operations = + new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( + this.context + ); + } + + /** + * Creates a new FeatureView in a given FeatureOnlineStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single FeatureView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete, + callback: BodyResponseCallback + ): void; + delete( + callback: BodyResponseCallback + ): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Fetch feature values under a FeatureView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions + ): GaxiosPromise; + fetchFeatureValues( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options?: MethodOptions + ): GaxiosPromise; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues, + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + callback: BodyResponseCallback + ): void; + fetchFeatureValues( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+featureView}:fetchFeatureValues' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets details of a single FeatureView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists FeatureViews in a given FeatureOnlineStore. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/featureViews').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of a single FeatureView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: StreamMethodOptions + ): GaxiosPromise; + searchNearestEntities( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options?: MethodOptions + ): GaxiosPromise; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities, + callback: BodyResponseCallback + ): void; + searchNearestEntities( + callback: BodyResponseCallback + ): void; + searchNearestEntities( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1beta1/{+featureView}:searchNearestEntities' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Triggers on-demand sync for the FeatureView. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: StreamMethodOptions + ): GaxiosPromise; + sync( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options?: MethodOptions + ): GaxiosPromise; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + sync( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync, + callback: BodyResponseCallback + ): void; + sync( + callback: BodyResponseCallback + ): void; + sync( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+featureView}:sync').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['featureView'], + pathParams: ['featureView'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Create + extends StandardParameters { + /** + * Required. The ID to use for the FeatureView, which will become the final component of the FeatureView's resource name. This value may be up to 60 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within a FeatureOnlineStore. + */ + featureViewId?: string; + /** + * Required. The resource name of the FeatureOnlineStore to create FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + /** + * Immutable. If set to true, one on demand sync will be run immediately, regardless whether the FeatureView.sync_config is configured or not. + */ + runSyncImmediately?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Delete + extends StandardParameters { + /** + * Required. The name of the FeatureView to be deleted. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Fetchfeaturevalues + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FetchFeatureValuesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Get + extends StandardParameters { + /** + * Required. The name of the FeatureView resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$List + extends StandardParameters { + /** + * Lists the FeatureViews that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `update_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. * `labels`: Supports key-value equality as well as key presence. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\" OR update_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViews created or updated after 2020-01-31T15:30:00.000000Z. * `labels.active = yes AND labels.env = prod` --\> FeatureViews having both (active: yes) and (env: prod) labels. * `labels.env: *` --\> Any FeatureView which has a label with 'env' as the key. + */ + filter?: string; + /** + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `feature_view_id` * `create_time` * `update_time` + */ + orderBy?: string; + /** + * The maximum number of FeatureViews to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViews will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. + */ + pageSize?: number; + /** + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViews call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViews must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the FeatureOnlineStore to list FeatureViews. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Patch + extends StandardParameters { + /** + * Output only. Name of the FeatureView. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + name?: string; + /** + * Field mask is used to specify the fields to be overwritten in the FeatureView resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then only the non-empty fields present in the request will be overwritten. Set the update_mask to `*` to override all fields. Updatable fields: * `labels` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1FeatureView; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Searchnearestentities + extends StandardParameters { + /** + * Required. FeatureView resource format `projects/{project\}/locations/{location\}/featureOnlineStores/{featureOnlineStore\}/featureViews/{featureView\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SearchNearestEntitiesRequest; + } + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Sync + extends StandardParameters { + /** + * Required. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` + */ + featureView?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudAiplatformV1beta1SyncFeatureViewRequest; + } + + export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single FeatureViewSync. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get; options = {}; } @@ -25050,17 +29146,19 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * Lists FeatureViewSyncs in a given FeatureView. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -25068,57 +29166,57 @@ export namespace aiplatform_v1beta1 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params?: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$List, - callback: BodyResponseCallback + params: Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$List - | BodyResponseCallback + | Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + {}) as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$List; + {} as Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List; options = {}; } @@ -25131,7 +29229,7 @@ export namespace aiplatform_v1beta1 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta1/{+name}/operations').replace( + url: (rootUrl + '/v1beta1/{+parent}/featureViewSyncs').replace( /([^:]\/)\/+/g, '$1' ), @@ -25140,190 +29238,52 @@ export namespace aiplatform_v1beta1 { options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } - - /** - * Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - options: StreamMethodOptions - ): GaxiosPromise; - wait( - params?: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - options?: MethodOptions - ): GaxiosPromise; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - wait( - params: Params$Resource$Projects$Locations$Featuregroups$Operations$Wait, - callback: BodyResponseCallback - ): void; - wait( - callback: BodyResponseCallback - ): void; - wait( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Featuregroups$Operations$Wait - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Featuregroups$Operations$Wait; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta1/{+name}:wait').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Delete + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$Get extends StandardParameters { /** - * The name of the operation resource to be deleted. + * Required. The name of the FeatureViewSync resource. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}/featureViewSyncs/{feature_view_sync\}` */ name?: string; } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Get + export interface Params$Resource$Projects$Locations$Featureonlinestores$Featureviews$Featureviewsyncs$List extends StandardParameters { /** - * The name of the operation resource. - */ - name?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$List - extends StandardParameters { - /** - * The standard list filter. + * Lists the FeatureViewSyncs that match the filter expression. The following filters are supported: * `create_time`: Supports `=`, `!=`, `<`, `\>`, `\>=`, and `<=` comparisons. Values must be in RFC 3339 format. Examples: * `create_time \> \"2020-01-31T15:30:00.000000Z\"` --\> FeatureViewSyncs created after 2020-01-31T15:30:00.000000Z. */ filter?: string; /** - * The name of the operation's parent resource. + * A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `create_time` */ - name?: string; + orderBy?: string; /** - * The standard list page size. + * The maximum number of FeatureViewSyncs to return. The service may return fewer than this value. If unspecified, at most 1000 FeatureViewSyncs will be returned. The maximum value is 1000; any value greater than 1000 will be coerced to 1000. */ pageSize?: number; /** - * The standard list page token. + * A page token, received from a previous FeatureOnlineStoreAdminService.ListFeatureViewSyncs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to FeatureOnlineStoreAdminService.ListFeatureViewSyncs must match the call that provided the page token. */ pageToken?: string; - } - export interface Params$Resource$Projects$Locations$Featuregroups$Operations$Wait - extends StandardParameters { /** - * The name of the operation resource to wait on. - */ - name?: string; - /** - * The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used. + * Required. The resource name of the FeatureView to list FeatureViewSyncs. Format: `projects/{project\}/locations/{location\}/featureOnlineStores/{feature_online_store\}/featureViews/{feature_view\}` */ - timeout?: string; - } - - export class Resource$Projects$Locations$Featureonlinestores { - context: APIRequestContext; - featureViews: Resource$Projects$Locations$Featureonlinestores$Featureviews; - operations: Resource$Projects$Locations$Featureonlinestores$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.featureViews = - new Resource$Projects$Locations$Featureonlinestores$Featureviews( - this.context - ); - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Operations( - this.context - ); - } - } - - export class Resource$Projects$Locations$Featureonlinestores$Featureviews { - context: APIRequestContext; - operations: Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations; - constructor(context: APIRequestContext) { - this.context = context; - this.operations = - new Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations( - this.context - ); - } + parent?: string; } export class Resource$Projects$Locations$Featureonlinestores$Featureviews$Operations { @@ -29391,11 +33351,11 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Create extends StandardParameters { /** - * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType . + * Required. The ID to use for the Feature, which will become the final component of the Feature's resource name. This value may be up to 128 characters, and valid characters are `[a-z0-9_]`. The first character cannot be a number. The value must be unique within an EntityType/FeatureGroup. */ featureId?: string; /** - * Required. The resource name of the EntityType to create a Feature. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * */ parent?: string; @@ -29407,14 +33367,14 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Delete extends StandardParameters { /** - * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` + * Required. The name of the Features to be deleted. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}/features/{feature\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}/features/{feature\}` */ name?: string; } export interface Params$Resource$Projects$Locations$Featurestores$Entitytypes$Features$Get extends StandardParameters { /** - * Required. The name of the Feature resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The name of the Feature resource. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ name?: string; } @@ -29441,7 +33401,7 @@ export namespace aiplatform_v1beta1 { */ pageToken?: string; /** - * Required. The resource name of the Location to list Features. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` + * Required. The resource name of the Location to list Features. Format: `projects/{project\}/locations/{location\}/featurestores/{featurestore\}/entityTypes/{entity_type\}` `projects/{project\}/locations/{location\}/featureGroups/{feature_group\}` */ parent?: string; /** @@ -45303,7 +49263,7 @@ export namespace aiplatform_v1beta1 { reportEvent( params?: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; reportEvent( params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options: StreamMethodOptions | BodyResponseCallback, @@ -45313,32 +49273,32 @@ export namespace aiplatform_v1beta1 { params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; reportEvent( params: Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; reportEvent( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; reportEvent( paramsOrCallback?: | Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || {}) as Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent; @@ -45374,12 +49334,12 @@ export namespace aiplatform_v1beta1 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -45389,7 +49349,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Generateaccesstoken extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` + * Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_job\}` */ name?: string; @@ -45401,14 +49361,14 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookexecutionjobs$Reportevent extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` + * Required. The name of the NotebookExecutionJob resource. Format: `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_jobs\}` */ name?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportRuntimeEventRequest; + requestBody?: Schema$GoogleCloudAiplatformV1beta1ReportExecutionEventRequest; } export class Resource$Projects$Locations$Notebookruntimes { @@ -46103,7 +50063,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookruntimes$Generateaccesstoken extends StandardParameters { /** - * Required. The name of the NotebookRuntime resource. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` + * Required. The name of the resource requesting the OAuth2 token. Format: `projects/{project\}/locations/{location\}/notebookRuntimes/{notebook_runtime\}` `projects/{project\}/locations/{location\}/notebookExecutionJobs/{notebook_execution_job\}` */ name?: string; @@ -46122,7 +50082,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookruntimes$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntime` supports = and !=. `notebookRuntime` represents the NotebookRuntime ID, i.e. the last segment of the NotebookRuntime's resource name. * `displayName` supports = and != and regex. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `healthState` supports = and !=. healthState enum: [HEALTHY, UNHEALTHY, HEALTH_STATE_UNSPECIFIED]. * `runtimeState` supports = and !=. runtimeState enum: [RUNTIME_STATE_UNSPECIFIED, RUNNING, BEING_STARTED, BEING_STOPPED, STOPPED, BEING_UPGRADED]. * `runtimeUser` supports = and !=. * API version is UI only: `uiState` supports = and !=. uiState enum: [UI_RESOURCE_STATE_UNSPECIFIED, UI_RESOURCE_STATE_BEING_CREATED, UI_RESOURCE_STATE_ACTIVE, UI_RESOURCE_STATE_BEING_DELETED, UI_RESOURCE_STATE_CREATION_FAILED]. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntime="notebookRuntime123"` * `displayName="myDisplayName"` and `displayName=~"myDisplayNameRegex"` * `notebookRuntimeTemplate="notebookRuntimeTemplate321"` * `healthState=HEALTHY` * `runtimeState=RUNNING` * `runtimeUser="test@google.com"` * `uiState=UI_RESOURCE_STATE_BEING_DELETED` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** @@ -46881,7 +50841,7 @@ export namespace aiplatform_v1beta1 { export interface Params$Resource$Projects$Locations$Notebookruntimetemplates$List extends StandardParameters { /** - * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` + * Optional. An expression for filtering the results of the request. For field names both snake_case and camelCase are supported. * `notebookRuntimeTemplate` supports = and !=. `notebookRuntimeTemplate` represents the NotebookRuntimeTemplate ID, i.e. the last segment of the NotebookRuntimeTemplate's resource name. * `display_name` supports = and != * `labels` supports general map functions that is: * `labels.key=value` - key:value equality * `labels.key:* or labels:key - key existence * A key including a space must be quoted. `labels."a key"`. * `notebookRuntimeType` supports = and !=. notebookRuntimeType enum: [USER_DEFINED, ONE_CLICK]. Some examples: * `notebookRuntimeTemplate=notebookRuntimeTemplate123` * `displayName="myDisplayName"` * `labels.myKey="myValue"` * `notebookRuntimeType=USER_DEFINED` */ filter?: string; /** @@ -61939,6 +65899,102 @@ export namespace aiplatform_v1beta1 { ); } } + + /** + * Lists publisher models in Model Garden. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Publishers$Models$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Publishers$Models$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Publishers$Models$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Publishers$Models$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Publishers$Models$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Publishers$Models$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Publishers$Models$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Publishers$Models$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://aiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/models').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Publishers$Models$Get @@ -61956,4 +66012,35 @@ export namespace aiplatform_v1beta1 { */ view?: string; } + export interface Params$Resource$Publishers$Models$List + extends StandardParameters { + /** + * Optional. The standard list filter. + */ + filter?: string; + /** + * Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en). + */ + languageCode?: string; + /** + * Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. + */ + orderBy?: string; + /** + * Optional. The standard list page size. + */ + pageSize?: number; + /** + * Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call. + */ + pageToken?: string; + /** + * Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher\}` + */ + parent?: string; + /** + * Optional. PublisherModel view specifying which fields to read. + */ + view?: string; + } } diff --git a/src/apis/alloydb/v1.ts b/src/apis/alloydb/v1.ts index a1a9ee9e24..585c2ccf7b 100644 --- a/src/apis/alloydb/v1.ts +++ b/src/apis/alloydb/v1.ts @@ -366,7 +366,7 @@ export namespace alloydb_v1 { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -399,6 +399,23 @@ export namespace alloydb_v1 { */ updateTime?: string | null; } + /** + * ConnectionInfo singleton resource. https://google.aip.dev/156 + */ + export interface Schema$ConnectionInfo { + /** + * Output only. The unique ID of the Instance. + */ + instanceUid?: string | null; + /** + * Output only. The private network IP address for the Instance. This is the default IP for the instance and is always created (even if enable_public_ip is set). This is the connection endpoint for an end-user application. + */ + ipAddress?: string | null; + /** + * The name of the ConnectionInfo singleton resource, e.g.: projects/{project\}/locations/{location\}/clusters/x/instances/x/connectionInfo This field currently has no semantic meaning. + */ + name?: string | null; + } /** * ContinuousBackupConfig describes the continuous backups recovery configurations of a cluster. */ @@ -489,6 +506,36 @@ export namespace alloydb_v1 { */ validateOnly?: boolean | null; } + /** + * Message for requests to generate a client certificate signed by the Cluster CA. + */ + export interface Schema$GenerateClientCertificateRequest { + /** + * Optional. An optional hint to the endpoint to generate the client certificate with the requested duration. The duration can be from 1 hour to 24 hours. The endpoint may or may not honor the hint. If the hint is left unspecified or is not honored, then the endpoint will pick an appropriate default duration. + */ + certDuration?: string | null; + /** + * Optional. The public key from the client. + */ + publicKey?: string | null; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Message returned by a GenerateClientCertificate operation. + */ + export interface Schema$GenerateClientCertificateResponse { + /** + * Optional. The pem-encoded cluster ca X.509 certificate. + */ + caCert?: string | null; + /** + * Output only. The pem-encoded chain that may be used to verify the X.509 certificate. Expected to be in issuer-to-root order according to RFC 5246. + */ + pemCertificateChain?: string[] | null; + } /** * The response message for Locations.ListLocations. */ @@ -800,7 +847,7 @@ export namespace alloydb_v1 { */ allocatedIpRange?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. */ network?: string | null; } @@ -1062,6 +1109,10 @@ export namespace alloydb_v1 { * Backup retention settings. */ backupRetentionSettings?: Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings; + /** + * Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted. + */ + pointInTimeRecoveryEnabled?: boolean | null; } /** * A backup run. @@ -1084,6 +1135,19 @@ export namespace alloydb_v1 { */ status?: string | null; } + /** + * Contains compliance information about a security standard indicating unmet recommendations. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainCompliance { + /** + * Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. + */ + standard?: string | null; + /** + * Version of the standard or benchmark, for example, 1.1 + */ + version?: string | null; + } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. */ @@ -1096,14 +1160,65 @@ export namespace alloydb_v1 { * Required. Type feed to be ingested into condor */ feedType?: string | null; + /** + * More feed data would be added in subsequent CLs + */ + resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData; /** * Required. Primary key associated with the Resource */ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + } + /** + * Common model for database resource health signal data. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData { /** - * More feed data would be added in subsequent CLs + * Any other additional metadata */ - resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + additionalMetadata?: {[key: string]: any} | null; + /** + * Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards. + */ + compliance?: Schema$StorageDatabasecenterPartnerapiV1mainCompliance[]; + /** + * Description associated with signal + */ + description?: string | null; + /** + * The last time at which the event described by this signal took place + */ + eventTime?: string | null; + /** + * The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals. + */ + externalUri?: string | null; + /** + * The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc. + */ + name?: string | null; + /** + * Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". + */ + resourceContainer?: string | null; + /** + * Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * The class of the signal, such as if it's a THREAT or VULNERABILITY. + */ + signalClass?: string | null; + /** + * Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. + */ + signalId?: string | null; + state?: string | null; } /** * DatabaseResourceId will serve as primary key for any resource ingestion event. @@ -1114,7 +1229,11 @@ export namespace alloydb_v1 { */ provider?: string | null; /** - * Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED + * Optional. Needs to be used only when the provider is PROVIDER_OTHER. + */ + providerDescription?: string | null; + /** + * Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -1147,7 +1266,11 @@ export namespace alloydb_v1 { */ currentState?: string | null; /** - * The actual instance state. + * Any custom metadata associated with the resource (a JSON field) + */ + customMetadata?: {[key: string]: any} | null; + /** + * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; /** @@ -1163,7 +1286,7 @@ export namespace alloydb_v1 { */ location?: string | null; /** - * Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform. + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1171,11 +1294,11 @@ export namespace alloydb_v1 { */ product?: Schema$StorageDatabasecenterProtoCommonProduct; /** - * Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: "projects/123". + * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". */ resourceContainer?: string | null; /** - * Required. Different from unique_id, a resource name can be reused over time. That is after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. + * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; /** @@ -2375,6 +2498,103 @@ export namespace alloydb_v1 { } } + /** + * Generate a client certificate signed by a Cluster CA. The sole purpose of this endpoint is to support AlloyDB connectors and the Auth Proxy client. The endpoint's behavior is subject to change without notice, so do not rely on its behavior remaining constant. Future changes will not break AlloyDB connectors or the Auth Proxy client. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateClientCertificate( + params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, + options: StreamMethodOptions + ): GaxiosPromise; + generateClientCertificate( + params?: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, + options?: MethodOptions + ): GaxiosPromise; + generateClientCertificate( + params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateClientCertificate( + params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateClientCertificate( + params: Params$Resource$Projects$Locations$Clusters$Generateclientcertificate, + callback: BodyResponseCallback + ): void; + generateClientCertificate( + callback: BodyResponseCallback + ): void; + generateClientCertificate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Generateclientcertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Generateclientcertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}:generateClientCertificate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets details of a single Cluster. * @@ -2881,6 +3101,18 @@ export namespace alloydb_v1 { */ validateOnly?: boolean; } + export interface Params$Resource$Projects$Locations$Clusters$Generateclientcertificate + extends StandardParameters { + /** + * Required. The name of the parent resource. The required format is: * projects/{project\}/locations/{location\}/clusters/{cluster\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateClientCertificateRequest; + } export interface Params$Resource$Projects$Locations$Clusters$Get extends StandardParameters { /** @@ -3408,6 +3640,96 @@ export namespace alloydb_v1 { } } + /** + * Get instance metadata used for a connection. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getConnectionInfo( + params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, + options: StreamMethodOptions + ): GaxiosPromise; + getConnectionInfo( + params?: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, + options?: MethodOptions + ): GaxiosPromise; + getConnectionInfo( + params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConnectionInfo( + params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getConnectionInfo( + params: Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo, + callback: BodyResponseCallback + ): void; + getConnectionInfo( + callback: BodyResponseCallback + ): void; + getConnectionInfo( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://alloydb.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/connectionInfo').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Injects fault in an instance. Imperative only. * @@ -3853,6 +4175,17 @@ export namespace alloydb_v1 { */ view?: string; } + export interface Params$Resource$Projects$Locations$Clusters$Instances$Getconnectioninfo + extends StandardParameters { + /** + * Required. The name of the parent resource. The required format is: projects/{project\}/locations/{location\}/clusters/{cluster\}/instances/{instance\} + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } export interface Params$Resource$Projects$Locations$Clusters$Instances$Injectfault extends StandardParameters { /** diff --git a/src/apis/alloydb/v1alpha.ts b/src/apis/alloydb/v1alpha.ts index 40ab821c97..259d737cd6 100644 --- a/src/apis/alloydb/v1alpha.ts +++ b/src/apis/alloydb/v1alpha.ts @@ -370,7 +370,7 @@ export namespace alloydb_v1alpha { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -527,7 +527,7 @@ export namespace alloydb_v1alpha { */ certDuration?: string | null; /** - * Optional. A pem-encoded X.509 certificate signing request (CSR). + * Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead. */ pemCsr?: string | null; /** @@ -879,7 +879,7 @@ export namespace alloydb_v1alpha { */ allocatedIpRange?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. */ network?: string | null; } @@ -1141,6 +1141,10 @@ export namespace alloydb_v1alpha { * Backup retention settings. */ backupRetentionSettings?: Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings; + /** + * Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted. + */ + pointInTimeRecoveryEnabled?: boolean | null; } /** * A backup run. @@ -1163,6 +1167,19 @@ export namespace alloydb_v1alpha { */ status?: string | null; } + /** + * Contains compliance information about a security standard indicating unmet recommendations. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainCompliance { + /** + * Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. + */ + standard?: string | null; + /** + * Version of the standard or benchmark, for example, 1.1 + */ + version?: string | null; + } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. */ @@ -1175,14 +1192,65 @@ export namespace alloydb_v1alpha { * Required. Type feed to be ingested into condor */ feedType?: string | null; + /** + * More feed data would be added in subsequent CLs + */ + resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData; /** * Required. Primary key associated with the Resource */ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + } + /** + * Common model for database resource health signal data. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData { /** - * More feed data would be added in subsequent CLs + * Any other additional metadata */ - resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + additionalMetadata?: {[key: string]: any} | null; + /** + * Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards. + */ + compliance?: Schema$StorageDatabasecenterPartnerapiV1mainCompliance[]; + /** + * Description associated with signal + */ + description?: string | null; + /** + * The last time at which the event described by this signal took place + */ + eventTime?: string | null; + /** + * The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals. + */ + externalUri?: string | null; + /** + * The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc. + */ + name?: string | null; + /** + * Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". + */ + resourceContainer?: string | null; + /** + * Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * The class of the signal, such as if it's a THREAT or VULNERABILITY. + */ + signalClass?: string | null; + /** + * Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. + */ + signalId?: string | null; + state?: string | null; } /** * DatabaseResourceId will serve as primary key for any resource ingestion event. @@ -1193,7 +1261,11 @@ export namespace alloydb_v1alpha { */ provider?: string | null; /** - * Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED + * Optional. Needs to be used only when the provider is PROVIDER_OTHER. + */ + providerDescription?: string | null; + /** + * Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -1226,7 +1298,11 @@ export namespace alloydb_v1alpha { */ currentState?: string | null; /** - * The actual instance state. + * Any custom metadata associated with the resource (a JSON field) + */ + customMetadata?: {[key: string]: any} | null; + /** + * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; /** @@ -1242,7 +1318,7 @@ export namespace alloydb_v1alpha { */ location?: string | null; /** - * Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform. + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1250,11 +1326,11 @@ export namespace alloydb_v1alpha { */ product?: Schema$StorageDatabasecenterProtoCommonProduct; /** - * Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: "projects/123". + * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". */ resourceContainer?: string | null; /** - * Required. Different from unique_id, a resource name can be reused over time. That is after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. + * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; /** diff --git a/src/apis/alloydb/v1beta.ts b/src/apis/alloydb/v1beta.ts index 3d187ab13a..8bacbc20a1 100644 --- a/src/apis/alloydb/v1beta.ts +++ b/src/apis/alloydb/v1beta.ts @@ -362,7 +362,7 @@ export namespace alloydb_v1beta { */ name?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. Deprecated, use network_config.network instead. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project\}/global/networks/{network_id\}". This is required to create a cluster. Deprecated, use network_config.network instead. */ network?: string | null; networkConfig?: Schema$NetworkConfig; @@ -515,7 +515,7 @@ export namespace alloydb_v1beta { */ certDuration?: string | null; /** - * Optional. A pem-encoded X.509 certificate signing request (CSR). + * Optional. A pem-encoded X.509 certificate signing request (CSR). It is recommended to use public_key instead. */ pemCsr?: string | null; /** @@ -863,7 +863,7 @@ export namespace alloydb_v1beta { */ allocatedIpRange?: string | null; /** - * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. It can be updated, but it cannot be removed. + * Required. The resource link for the VPC network in which cluster resources are created and from which they are accessible via Private IP. The network must belong to the same project as the cluster. It is specified in the form: "projects/{project_number\}/global/networks/{network_id\}". This is required to create a cluster. */ network?: string | null; } @@ -1125,6 +1125,10 @@ export namespace alloydb_v1beta { * Backup retention settings. */ backupRetentionSettings?: Schema$StorageDatabasecenterPartnerapiV1mainRetentionSettings; + /** + * Whether point-in-time recovery is enabled. This is optional field, if the database service does not have this feature or metadata is not available in control plane, this can be omitted. + */ + pointInTimeRecoveryEnabled?: boolean | null; } /** * A backup run. @@ -1147,6 +1151,19 @@ export namespace alloydb_v1beta { */ status?: string | null; } + /** + * Contains compliance information about a security standard indicating unmet recommendations. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainCompliance { + /** + * Industry-wide compliance standards or benchmarks, such as CIS, PCI, and OWASP. + */ + standard?: string | null; + /** + * Version of the standard or benchmark, for example, 1.1 + */ + version?: string | null; + } /** * DatabaseResourceFeed is the top level proto to be used to ingest different database resource level events into Condor platform. */ @@ -1159,14 +1176,65 @@ export namespace alloydb_v1beta { * Required. Type feed to be ingested into condor */ feedType?: string | null; + /** + * More feed data would be added in subsequent CLs + */ + resourceHealthSignalData?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData; /** * Required. Primary key associated with the Resource */ resourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; + resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + } + /** + * Common model for database resource health signal data. + */ + export interface Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceHealthSignalData { /** - * More feed data would be added in subsequent CLs + * Any other additional metadata */ - resourceMetadata?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceMetadata; + additionalMetadata?: {[key: string]: any} | null; + /** + * Industry standards associated with this signal; if this signal is an issue, that could be a violation of the associated industry standard(s). For example, AUTO_BACKUP_DISABLED signal is associated with CIS GCP 1.1, CIS GCP 1.2, CIS GCP 1.3, NIST 800-53 and ISO-27001 compliance standards. If a database resource does not have automated backup enable, it will violate these following industry standards. + */ + compliance?: Schema$StorageDatabasecenterPartnerapiV1mainCompliance[]; + /** + * Description associated with signal + */ + description?: string | null; + /** + * The last time at which the event described by this signal took place + */ + eventTime?: string | null; + /** + * The external-uri of the signal, using which more information about this signal can be obtained. In GCP, this will take user to SCC page to get more details about signals. + */ + externalUri?: string | null; + /** + * The name of the signal, ex: PUBLIC_SQL_INSTANCE, SQL_LOG_ERROR_VERBOSITY etc. + */ + name?: string | null; + /** + * Cloud provider name. Ex: GCP/AWS/Azure/OnPrem/SelfManaged + */ + provider?: string | null; + /** + * Closest parent container of this resource. In GCP, 'container' refers to a Cloud Resource Manager project. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". + */ + resourceContainer?: string | null; + /** + * Database resource name associated with the signal. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel + */ + resourceName?: string | null; + /** + * The class of the signal, such as if it's a THREAT or VULNERABILITY. + */ + signalClass?: string | null; + /** + * Unique identifier for the signal. This is an unique id which would be mainatined by partner to identify a signal. + */ + signalId?: string | null; + state?: string | null; } /** * DatabaseResourceId will serve as primary key for any resource ingestion event. @@ -1177,7 +1245,11 @@ export namespace alloydb_v1beta { */ provider?: string | null; /** - * Required. The type of resource this ID is identifying. Ex google.sqladmin.Instance, google.alloydb.cluster, google.sqladmin.Backup REQUIRED + * Optional. Needs to be used only when the provider is PROVIDER_OTHER. + */ + providerDescription?: string | null; + /** + * Required. The type of resource this ID is identifying. Ex alloydb.googleapis.com/Cluster, alloydb.googleapis.com/Instance, spanner.googleapis.com/Instance REQUIRED Please refer go/condor-common-datamodel */ resourceType?: string | null; /** @@ -1210,7 +1282,11 @@ export namespace alloydb_v1beta { */ currentState?: string | null; /** - * The actual instance state. + * Any custom metadata associated with the resource (a JSON field) + */ + customMetadata?: {[key: string]: any} | null; + /** + * The state that the instance is expected to be in. For example, an instance state can transition to UNHEALTHY due to wrong patch update, while the expected state will remain at the HEALTHY. */ expectedState?: string | null; /** @@ -1226,7 +1302,7 @@ export namespace alloydb_v1beta { */ location?: string | null; /** - * Unique identifier for this resource's immediate parent resource. This parent resource id would be used to build resource hierarchy in condor platform. + * Identifier for this resource's immediate parent/primary resource if the current resource is a replica or derived form of another Database resource. Else it would be NULL. REQUIRED if the immediate parent exists when first time resource is getting ingested */ primaryResourceId?: Schema$StorageDatabasecenterPartnerapiV1mainDatabaseResourceId; /** @@ -1234,11 +1310,11 @@ export namespace alloydb_v1beta { */ product?: Schema$StorageDatabasecenterProtoCommonProduct; /** - * Closest parent Cloud Resource Manager container of this resource. It must either be resource name of a Cloud Resource Manager project, for ex: "projects/123". + * Closest parent Cloud Resource Manager container of this resource. It must be resource name of a Cloud Resource Manager project with the format of "provider//", such as "gcp/projects/123". */ resourceContainer?: string | null; /** - * Required. Different from unique_id, a resource name can be reused over time. That is after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. + * Required. Different from DatabaseResourceId.unique_id, a resource name can be reused over time. That is, after a resource named "ABC" is deleted, the name "ABC" can be used to to create a new resource within the same source. Resource name to follow CAIS resource_name format as noted here go/condor-common-datamodel */ resourceName?: string | null; /** diff --git a/src/apis/analyticsadmin/v1alpha.ts b/src/apis/analyticsadmin/v1alpha.ts index 9641b5c037..c09009fd37 100644 --- a/src/apis/analyticsadmin/v1alpha.ts +++ b/src/apis/analyticsadmin/v1alpha.ts @@ -806,53 +806,6 @@ export namespace analyticsadmin_v1alpha { */ scope?: string | null; } - /** - * Read-only resource used to summarize a principal's effective roles. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLink { - /** - * Roles directly assigned to this user for this entity. Format: predefinedRoles/viewer Excludes roles that are inherited from an account (if this is for a property), group, or organization admin role. - */ - directRoles?: string[] | null; - /** - * Union of all permissions a user has at this account or property (includes direct permissions, group-inherited permissions, etc.). Format: predefinedRoles/viewer - */ - effectiveRoles?: string[] | null; - /** - * Email address of the linked user - */ - emailAddress?: string | null; - /** - * Example format: properties/1234/userLinks/5678 - */ - name?: string | null; - } - /** - * Request message for AuditUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksRequest { - /** - * The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 1000 user links will be returned. The maximum value is 5000; values above 5000 will be coerced to 5000. - */ - pageSize?: number | null; - /** - * A page token, received from a previous `AuditUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `AuditUserLinks` must match the call that provided the page token. - */ - pageToken?: string | null; - } - /** - * Response message for AuditUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksResponse { - /** - * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. - */ - nextPageToken?: string | null; - /** - * List of AuditUserLinks. These will be ordered stably, but in an arbitrary order. - */ - userLinks?: Schema$GoogleAnalyticsAdminV1alphaAuditUserLink[]; - } /** * Request message for BatchCreateAccessBindings RPC. */ @@ -871,28 +824,6 @@ export namespace analyticsadmin_v1alpha { */ accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[]; } - /** - * Request message for BatchCreateUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest { - /** - * Optional. If set, then email the new users notifying them that they've been granted permissions to the resource. Regardless of whether this is set or not, notify_new_user field inside each individual request is ignored. - */ - notifyNewUsers?: boolean | null; - /** - * Required. The requests specifying the user links to create. A maximum of 1000 user links can be created in a batch. - */ - requests?: Schema$GoogleAnalyticsAdminV1alphaCreateUserLinkRequest[]; - } - /** - * Response message for BatchCreateUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksResponse { - /** - * The user links created. - */ - userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[]; - } /** * Request message for BatchDeleteAccessBindings RPC. */ @@ -902,15 +833,6 @@ export namespace analyticsadmin_v1alpha { */ requests?: Schema$GoogleAnalyticsAdminV1alphaDeleteAccessBindingRequest[]; } - /** - * Request message for BatchDeleteUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest { - /** - * Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch. - */ - requests?: Schema$GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest[]; - } /** * Response message for BatchGetAccessBindings RPC. */ @@ -920,15 +842,6 @@ export namespace analyticsadmin_v1alpha { */ accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[]; } - /** - * Response message for BatchGetUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchGetUserLinksResponse { - /** - * The requested user links. - */ - userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[]; - } /** * Request message for BatchUpdateAccessBindings RPC. */ @@ -947,24 +860,6 @@ export namespace analyticsadmin_v1alpha { */ accessBindings?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding[]; } - /** - * Request message for BatchUpdateUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest { - /** - * Required. The requests specifying the user links to update. A maximum of 1000 user links can be updated in a batch. - */ - requests?: Schema$GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest[]; - } - /** - * Response message for BatchUpdateUserLinks RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksResponse { - /** - * The user links updated. - */ - userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[]; - } /** * A link between a GA4 Property and BigQuery project. */ @@ -1071,6 +966,10 @@ export namespace analyticsadmin_v1alpha { * A snapshot of a CustomMetric resource in change history. */ customMetric?: Schema$GoogleAnalyticsAdminV1alphaCustomMetric; + /** + * A snapshot of DataRedactionSettings resource in change history. + */ + dataRedactionSettings?: Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings; /** * A snapshot of a data retention settings resource in change history. */ @@ -1349,21 +1248,60 @@ export namespace analyticsadmin_v1alpha { */ export interface Schema$GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagResponse {} /** - * Request message for CreateUserLink RPC. Users can have multiple email addresses associated with their Google account, and one of these email addresses is the "primary" email address. Any of the email addresses associated with a Google account may be used for a new UserLink, but the returned UserLink will always contain the "primary" email address. As a result, the input and output email address for this request may differ. + * Request message for CreateRollupProperty RPC. */ - export interface Schema$GoogleAnalyticsAdminV1alphaCreateUserLinkRequest { + export interface Schema$GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest { /** - * Optional. If set, then email the new user notifying them that they've been granted permissions to the resource. + * Required. The roll-up property to create. */ - notifyNewUser?: boolean | null; + rollupProperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; /** - * Required. Example format: accounts/1234 + * Optional. The resource names of properties that will be sources to the created roll-up property. + */ + sourceProperties?: string[] | null; + } + /** + * Response message for CreateRollupProperty RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaCreateRollupPropertyResponse { + /** + * The created roll-up property. + */ + rollupProperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * The created roll-up property source links. + */ + rollupPropertySourceLinks?: Schema$GoogleAnalyticsAdminV1alphaRollupPropertySourceLink[]; + } + /** + * Request message for CreateSubproperty RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest { + /** + * Required. The ordinary property for which to create a subproperty. Format: properties/property_id Example: properties/123 */ parent?: string | null; /** - * Required. The user link to create. + * Required. The subproperty to create. + */ + subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * Optional. The subproperty event filter to create on an ordinary property. + */ + subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; + } + /** + * Response message for CreateSubproperty RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyResponse { + /** + * The created subproperty. + */ + subproperty?: Schema$GoogleAnalyticsAdminV1alphaProperty; + /** + * The created subproperty event filter. */ - userLink?: Schema$GoogleAnalyticsAdminV1alphaUserLink; + subpropertyEventFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; } /** * A definition for a CustomDimension. @@ -1427,6 +1365,27 @@ export namespace analyticsadmin_v1alpha { */ scope?: string | null; } + /** + * Settings for client-side data redaction. Singleton resource under a Web Stream. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings { + /** + * If enabled, any event parameter or user property values that look like an email will be redacted. + */ + emailRedactionEnabled?: boolean | null; + /** + * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" + */ + name?: string | null; + /** + * The query parameter keys to apply redaction logic to if present in the URL. Query parameter matching is case-insensitive. Must contain at least one element if query_parameter_replacement_enabled is true. Keys cannot contain commas. + */ + queryParameterKeys?: string[] | null; + /** + * Query Parameter redaction removes the key and value portions of a query parameter if it is in the configured set of query parameters. If enabled, URL query replacement logic will be run for the Stream. Any query parameters defined in query_parameter_keys will be redacted. + */ + queryParameterRedactionEnabled?: boolean | null; + } /** * Settings values for data retention. This is a singleton resource. */ @@ -1575,15 +1534,6 @@ export namespace analyticsadmin_v1alpha { */ tagId?: string | null; } - /** - * Request message for DeleteUserLink RPC. - */ - export interface Schema$GoogleAnalyticsAdminV1alphaDeleteUserLinkRequest { - /** - * Required. Example format: accounts/1234/userLinks/5678 - */ - name?: string | null; - } /** * A link between a GA4 property and a Display & Video 360 advertiser. */ @@ -2257,6 +2207,19 @@ export namespace analyticsadmin_v1alpha { */ properties?: Schema$GoogleAnalyticsAdminV1alphaProperty[]; } + /** + * Response message for ListRollupPropertySourceLinks RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaListRollupPropertySourceLinksResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * List of RollupPropertySourceLinks. + */ + rollupPropertySourceLinks?: Schema$GoogleAnalyticsAdminV1alphaRollupPropertySourceLink[]; + } /** * Response message for ListSearchAds360Links RPC. */ @@ -2284,17 +2247,17 @@ export namespace analyticsadmin_v1alpha { skadnetworkConversionValueSchemas?: Schema$GoogleAnalyticsAdminV1alphaSKAdNetworkConversionValueSchema[]; } /** - * Response message for ListUserLinks RPC. + * Response message for ListSubpropertyEventFilter RPC. */ - export interface Schema$GoogleAnalyticsAdminV1alphaListUserLinksResponse { + export interface Schema$GoogleAnalyticsAdminV1alphaListSubpropertyEventFiltersResponse { /** * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */ nextPageToken?: string | null; /** - * List of UserLinks. These will be ordered stably, but in an arbitrary order. + * List of subproperty event filters. */ - userLinks?: Schema$GoogleAnalyticsAdminV1alphaUserLink[]; + subpropertyEventFilters?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter[]; } /** * Defines a condition for when an Event Edit or Event Creation rule applies to an event. @@ -2414,7 +2377,7 @@ export namespace analyticsadmin_v1alpha { */ parent?: string | null; /** - * Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API. + * Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. */ propertyType?: string | null; /** @@ -2473,6 +2436,19 @@ export namespace analyticsadmin_v1alpha { */ accountTicketId?: string | null; } + /** + * A link that references a source property under the parent rollup property. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaRollupPropertySourceLink { + /** + * Output only. Resource name of this RollupPropertySourceLink. Format: 'properties/{property_id\}/rollupPropertySourceLinks/{rollup_property_source_link\}' Format: 'properties/123/rollupPropertySourceLinks/456' + */ + name?: string | null; + /** + * Immutable. Resource name of the source property. Format: properties/{property_id\} Example: "properties/789" + */ + sourceProperty?: string | null; + } /** * The request for a Data Access Record Report. */ @@ -2489,6 +2465,14 @@ export namespace analyticsadmin_v1alpha { * The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. */ dimensions?: Schema$GoogleAnalyticsAdminV1alphaAccessDimension[]; + /** + * Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. + */ + expandGroups?: boolean | null; + /** + * Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. + */ + includeAllUsers?: boolean | null; /** * The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). */ @@ -2669,39 +2653,103 @@ export namespace analyticsadmin_v1alpha { postbackWindowTwo?: Schema$GoogleAnalyticsAdminV1alphaPostbackWindow; } /** - * Request message for UpdateAccessBinding RPC. + * A resource message representing a GA4 Subproperty event filter. */ - export interface Schema$GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest { + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter { /** - * Required. The access binding to update. + * Immutable. Resource name of the Subproperty that uses this filter. */ - accessBinding?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding; + applyToProperty?: string | null; + /** + * Required. Unordered list. Filter clauses that define the SubpropertyEventFilter. All clauses are AND'ed together to determine what data is sent to the subproperty. + */ + filterClauses?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause[]; + /** + * Output only. Format: properties/{ordinary_property_id\}/subpropertyEventFilters/{sub_property_event_filter\} Example: properties/1234/subpropertyEventFilters/5678 + */ + name?: string | null; } /** - * Request message for UpdateUserLink RPC. + * A clause for defining a filter. A filter may be inclusive (events satisfying the filter clause are included in the subproperty's data) or exclusive (events satisfying the filter clause are excluded from the subproperty's data). */ - export interface Schema$GoogleAnalyticsAdminV1alphaUpdateUserLinkRequest { + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterClause { + /** + * Required. The type for the filter clause. + */ + filterClauseType?: string | null; /** - * Required. The user link to update. + * Required. The logical expression for what events are sent to the subproperty. */ - userLink?: Schema$GoogleAnalyticsAdminV1alphaUserLink; + filterExpression?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression; } /** - * A resource message representing a user's permissions on an Account or Property resource. + * A specific filter expression */ - export interface Schema$GoogleAnalyticsAdminV1alphaUserLink { + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition { + /** + * Required. The field that is being filtered. + */ + fieldName?: string | null; /** - * Roles directly assigned to this user for this account or property. Valid values: predefinedRoles/viewer predefinedRoles/analyst predefinedRoles/editor predefinedRoles/admin predefinedRoles/no-cost-data predefinedRoles/no-revenue-data Excludes roles that are inherited from a higher-level entity, group, or organization admin role. A UserLink that is updated to have an empty list of direct_roles will be deleted. + * A filter for null values. */ - directRoles?: string[] | null; + nullFilter?: boolean | null; /** - * Immutable. Email address of the user to link + * A filter for a string-type dimension that matches a particular pattern. */ - emailAddress?: string | null; + stringFilter?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter; + } + /** + * A filter for a string-type dimension that matches a particular pattern. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterConditionStringFilter { /** - * Output only. Example format: properties/1234/userLinks/5678 + * Optional. If true, the string value is case sensitive. If false, the match is case-insensitive. */ - name?: string | null; + caseSensitive?: boolean | null; + /** + * Required. The match type for the string filter. + */ + matchType?: string | null; + /** + * Required. The string value used for the matching. + */ + value?: string | null; + } + /** + * A logical expression of Subproperty event filters. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression { + /** + * Creates a filter that matches a specific event. This cannot be set on the top level SubpropertyEventFilterExpression. + */ + filterCondition?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterCondition; + /** + * A filter expression to be NOT'ed (inverted, complemented). It can only include a filter. This cannot be set on the top level SubpropertyEventFilterExpression. + */ + notExpression?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression; + /** + * A list of expressions to OR’ed together. Must only contain not_expression or filter_condition expressions. + */ + orGroup?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList; + } + /** + * A list of Subproperty event filter expressions. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpressionList { + /** + * Required. Unordered list. A list of Subproperty event filter expressions + */ + filterExpressions?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilterExpression[]; + } + /** + * Request message for UpdateAccessBinding RPC. + */ + export interface Schema$GoogleAnalyticsAdminV1alphaUpdateAccessBindingRequest { + /** + * Required. The access binding to update. + */ + accessBinding?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding; } /** * 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); \} @@ -2711,15 +2759,13 @@ export namespace analyticsadmin_v1alpha { export class Resource$Accounts { context: APIRequestContext; accessBindings: Resource$Accounts$Accessbindings; - userLinks: Resource$Accounts$Userlinks; constructor(context: APIRequestContext) { this.context = context; this.accessBindings = new Resource$Accounts$Accessbindings(this.context); - this.userLinks = new Resource$Accounts$Userlinks(this.context); } /** - * Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. + * Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4507,71 +4553,71 @@ export namespace analyticsadmin_v1alpha { requestBody?: Schema$GoogleAnalyticsAdminV1alphaAccessBinding; } - export class Resource$Accounts$Userlinks { + export class Resource$Accountsummaries { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs. + * Returns summaries of all accounts accessible by the caller. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - audit( - params: Params$Resource$Accounts$Userlinks$Audit, + list( + params: Params$Resource$Accountsummaries$List, options: StreamMethodOptions ): GaxiosPromise; - audit( - params?: Params$Resource$Accounts$Userlinks$Audit, + list( + params?: Params$Resource$Accountsummaries$List, options?: MethodOptions - ): GaxiosPromise; - audit( - params: Params$Resource$Accounts$Userlinks$Audit, + ): GaxiosPromise; + list( + params: Params$Resource$Accountsummaries$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - audit( - params: Params$Resource$Accounts$Userlinks$Audit, + list( + params: Params$Resource$Accountsummaries$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - audit( - params: Params$Resource$Accounts$Userlinks$Audit, - callback: BodyResponseCallback + list( + params: Params$Resource$Accountsummaries$List, + callback: BodyResponseCallback ): void; - audit( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - audit( + list( paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Audit - | BodyResponseCallback + | Params$Resource$Accountsummaries$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Audit; + {}) as Params$Resource$Accountsummaries$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Audit; + params = {} as Params$Resource$Accountsummaries$List; options = {}; } @@ -4585,1118 +4631,43 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:audit').replace( + url: (rootUrl + '/v1alpha/accountSummaries').replace( /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: [], + pathParams: [], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + export interface Params$Resource$Accountsummaries$List + extends StandardParameters { /** - * Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. + * The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */ - batchCreate( - params: Params$Resource$Accounts$Userlinks$Batchcreate, - options: StreamMethodOptions - ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Accounts$Userlinks$Batchcreate, - options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Accounts$Userlinks$Batchcreate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Accounts$Userlinks$Batchcreate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Accounts$Userlinks$Batchcreate, - callback: BodyResponseCallback - ): void; - batchCreate( - callback: BodyResponseCallback - ): void; - batchCreate( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Batchcreate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Batchcreate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Batchcreate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes information about multiple users' links to an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchDelete( - params: Params$Resource$Accounts$Userlinks$Batchdelete, - options: StreamMethodOptions - ): GaxiosPromise; - batchDelete( - params?: Params$Resource$Accounts$Userlinks$Batchdelete, - options?: MethodOptions - ): GaxiosPromise; - batchDelete( - params: Params$Resource$Accounts$Userlinks$Batchdelete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchDelete( - params: Params$Resource$Accounts$Userlinks$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchDelete( - params: Params$Resource$Accounts$Userlinks$Batchdelete, - callback: BodyResponseCallback - ): void; - batchDelete( - callback: BodyResponseCallback - ): void; - batchDelete( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Batchdelete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Batchdelete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Batchdelete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets information about multiple users' links to an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchGet( - params: Params$Resource$Accounts$Userlinks$Batchget, - options: StreamMethodOptions - ): GaxiosPromise; - batchGet( - params?: Params$Resource$Accounts$Userlinks$Batchget, - options?: MethodOptions - ): GaxiosPromise; - batchGet( - params: Params$Resource$Accounts$Userlinks$Batchget, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchGet( - params: Params$Resource$Accounts$Userlinks$Batchget, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchGet( - params: Params$Resource$Accounts$Userlinks$Batchget, - callback: BodyResponseCallback - ): void; - batchGet( - callback: BodyResponseCallback - ): void; - batchGet( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Batchget - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Batchget; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Batchget; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchGet').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates information about multiple users' links to an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - batchUpdate( - params: Params$Resource$Accounts$Userlinks$Batchupdate, - options: StreamMethodOptions - ): GaxiosPromise; - batchUpdate( - params?: Params$Resource$Accounts$Userlinks$Batchupdate, - options?: MethodOptions - ): GaxiosPromise; - batchUpdate( - params: Params$Resource$Accounts$Userlinks$Batchupdate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchUpdate( - params: Params$Resource$Accounts$Userlinks$Batchupdate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchUpdate( - params: Params$Resource$Accounts$Userlinks$Batchupdate, - callback: BodyResponseCallback - ): void; - batchUpdate( - callback: BodyResponseCallback - ): void; - batchUpdate( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Batchupdate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Batchupdate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Batchupdate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchUpdate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - create( - params: Params$Resource$Accounts$Userlinks$Create, - options: StreamMethodOptions - ): GaxiosPromise; - create( - params?: Params$Resource$Accounts$Userlinks$Create, - options?: MethodOptions - ): GaxiosPromise; - create( - params: Params$Resource$Accounts$Userlinks$Create, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Accounts$Userlinks$Create, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - create( - params: Params$Resource$Accounts$Userlinks$Create, - callback: BodyResponseCallback - ): void; - create( - callback: BodyResponseCallback - ): void; - create( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Create - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Create; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Create; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes a user link on an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Accounts$Userlinks$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Accounts$Userlinks$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Accounts$Userlinks$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Accounts$Userlinks$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Accounts$Userlinks$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - - /** - * Gets information about a user's link to an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - get( - params: Params$Resource$Accounts$Userlinks$Get, - options: StreamMethodOptions - ): GaxiosPromise; - get( - params?: Params$Resource$Accounts$Userlinks$Get, - options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Accounts$Userlinks$Get, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accounts$Userlinks$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Accounts$Userlinks$Get, - callback: BodyResponseCallback - ): void; - get( - callback: BodyResponseCallback - ): void; - get( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Get - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Get; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Get; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Lists all user links on an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Accounts$Userlinks$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Accounts$Userlinks$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accounts$Userlinks$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accounts$Userlinks$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accounts$Userlinks$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+parent}/userLinks').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: ['parent'], - pathParams: ['parent'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Updates a user link on an account or property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - patch( - params: Params$Resource$Accounts$Userlinks$Patch, - options: StreamMethodOptions - ): GaxiosPromise; - patch( - params?: Params$Resource$Accounts$Userlinks$Patch, - options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Accounts$Userlinks$Patch, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Userlinks$Patch, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - patch( - params: Params$Resource$Accounts$Userlinks$Patch, - callback: BodyResponseCallback - ): void; - patch( - callback: BodyResponseCallback - ): void; - patch( - paramsOrCallback?: - | Params$Resource$Accounts$Userlinks$Patch - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accounts$Userlinks$Patch; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accounts$Userlinks$Patch; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accounts$Userlinks$Audit - extends StandardParameters { - /** - * Required. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksRequest; - } - export interface Params$Resource$Accounts$Userlinks$Batchcreate - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest; - } - export interface Params$Resource$Accounts$Userlinks$Batchdelete - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest; - } - export interface Params$Resource$Accounts$Userlinks$Batchget - extends StandardParameters { - /** - * Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId\}/userLinks/{userLinkId\} - */ - names?: string[]; - /** - * Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234 - */ - parent?: string; - } - export interface Params$Resource$Accounts$Userlinks$Batchupdate - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest; - } - export interface Params$Resource$Accounts$Userlinks$Create - extends StandardParameters { - /** - * Optional. If set, then email the new user notifying them that they've been granted permissions to the resource. - */ - notifyNewUser?: boolean; - /** - * Required. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaUserLink; - } - export interface Params$Resource$Accounts$Userlinks$Delete - extends StandardParameters { - /** - * Required. Example format: accounts/1234/userLinks/5678 - */ - name?: string; - } - export interface Params$Resource$Accounts$Userlinks$Get - extends StandardParameters { - /** - * Required. Example format: accounts/1234/userLinks/5678 - */ - name?: string; - } - export interface Params$Resource$Accounts$Userlinks$List - extends StandardParameters { - /** - * The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500. - */ - pageSize?: number; - /** - * A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token. - */ - pageToken?: string; - /** - * Required. Example format: accounts/1234 - */ - parent?: string; - } - export interface Params$Resource$Accounts$Userlinks$Patch - extends StandardParameters { - /** - * Output only. Example format: properties/1234/userLinks/5678 - */ - name?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaUserLink; - } - - export class Resource$Accountsummaries { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; - } - - /** - * Returns summaries of all accounts accessible by the caller. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - list( - params: Params$Resource$Accountsummaries$List, - options: StreamMethodOptions - ): GaxiosPromise; - list( - params?: Params$Resource$Accountsummaries$List, - options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Accountsummaries$List, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountsummaries$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Accountsummaries$List, - callback: BodyResponseCallback - ): void; - list( - callback: BodyResponseCallback - ): void; - list( - paramsOrCallback?: - | Params$Resource$Accountsummaries$List - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Accountsummaries$List; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Accountsummaries$List; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/accountSummaries').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', - }, - options - ), - params, - requiredParams: [], - pathParams: [], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - } - - export interface Params$Resource$Accountsummaries$List - extends StandardParameters { - /** - * The maximum number of AccountSummary resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) - */ - pageSize?: number; - /** - * A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. - */ - pageToken?: string; - } + pageSize?: number; + /** + * A page token, received from a previous `ListAccountSummaries` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListAccountSummaries` must match the call that provided the page token. + */ + pageToken?: string; + } export class Resource$Properties { context: APIRequestContext; @@ -5714,8 +4685,9 @@ export namespace analyticsadmin_v1alpha { expandedDataSets: Resource$Properties$Expandeddatasets; firebaseLinks: Resource$Properties$Firebaselinks; googleAdsLinks: Resource$Properties$Googleadslinks; + rollupPropertySourceLinks: Resource$Properties$Rolluppropertysourcelinks; searchAds360Links: Resource$Properties$Searchads360links; - userLinks: Resource$Properties$Userlinks; + subpropertyEventFilters: Resource$Properties$Subpropertyeventfilters; constructor(context: APIRequestContext) { this.context = context; this.accessBindings = new Resource$Properties$Accessbindings( @@ -5746,10 +4718,13 @@ export namespace analyticsadmin_v1alpha { this.googleAdsLinks = new Resource$Properties$Googleadslinks( this.context ); + this.rollupPropertySourceLinks = + new Resource$Properties$Rolluppropertysourcelinks(this.context); this.searchAds360Links = new Resource$Properties$Searchads360links( this.context ); - this.userLinks = new Resource$Properties$Userlinks(this.context); + this.subpropertyEventFilters = + new Resource$Properties$Subpropertyeventfilters(this.context); } /** @@ -6042,7 +5017,201 @@ export namespace analyticsadmin_v1alpha { } /** - * Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. + * Create a roll-up property and all roll-up property source links. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + createRollupProperty( + params: Params$Resource$Properties$Createrollupproperty, + options: StreamMethodOptions + ): GaxiosPromise; + createRollupProperty( + params?: Params$Resource$Properties$Createrollupproperty, + options?: MethodOptions + ): GaxiosPromise; + createRollupProperty( + params: Params$Resource$Properties$Createrollupproperty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createRollupProperty( + params: Params$Resource$Properties$Createrollupproperty, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createRollupProperty( + params: Params$Resource$Properties$Createrollupproperty, + callback: BodyResponseCallback + ): void; + createRollupProperty( + callback: BodyResponseCallback + ): void; + createRollupProperty( + paramsOrCallback?: + | Params$Resource$Properties$Createrollupproperty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Createrollupproperty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Createrollupproperty; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/properties:createRollupProperty').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Create a subproperty and a subproperty event filter that applies to the created subproperty. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + createSubproperty( + params: Params$Resource$Properties$Createsubproperty, + options: StreamMethodOptions + ): GaxiosPromise; + createSubproperty( + params?: Params$Resource$Properties$Createsubproperty, + options?: MethodOptions + ): GaxiosPromise; + createSubproperty( + params: Params$Resource$Properties$Createsubproperty, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSubproperty( + params: Params$Resource$Properties$Createsubproperty, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + createSubproperty( + params: Params$Resource$Properties$Createsubproperty, + callback: BodyResponseCallback + ): void; + createSubproperty( + callback: BodyResponseCallback + ): void; + createSubproperty( + paramsOrCallback?: + | Params$Resource$Properties$Createsubproperty + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Createsubproperty; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Createsubproperty; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/properties:createSubproperty').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -7584,6 +6753,20 @@ export namespace analyticsadmin_v1alpha { */ requestBody?: Schema$GoogleAnalyticsAdminV1alphaCreateConnectedSiteTagRequest; } + export interface Params$Resource$Properties$Createrollupproperty + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCreateRollupPropertyRequest; + } + export interface Params$Resource$Properties$Createsubproperty + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaCreateSubpropertyRequest; + } export interface Params$Resource$Properties$Delete extends StandardParameters { /** @@ -12196,31 +11379,123 @@ export namespace analyticsadmin_v1alpha { params: Params$Resource$Properties$Datastreams$Delete, callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Properties$Datastreams$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Datastreams$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Properties$Datastreams$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lookup for a single DataStream. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Properties$Datastreams$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Properties$Datastreams$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Datastreams$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Datastreams$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Properties$Datastreams$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Delete - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Delete; + {}) as Params$Resource$Properties$Datastreams$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Delete; + params = {} as Params$Resource$Properties$Datastreams$Get; options = {}; } @@ -12235,7 +11510,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', }, options ), @@ -12245,74 +11520,77 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Lookup for a single DataStream. + * Lookup for a single DataRedactionSettings. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Datastreams$Get, + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Datastreams$Get, + getDataRedactionSettings( + params?: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Properties$Datastreams$Get, + ): GaxiosPromise; + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Datastreams$Get, + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Datastreams$Get, - callback: BodyResponseCallback + getDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Getdataredactionsettings, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + getDataRedactionSettings( + callback: BodyResponseCallback ): void; - get( + getDataRedactionSettings( paramsOrCallback?: - | Params$Resource$Properties$Datastreams$Get - | BodyResponseCallback + | Params$Resource$Properties$Datastreams$Getdataredactionsettings + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Datastreams$Get; + {}) as Params$Resource$Properties$Datastreams$Getdataredactionsettings; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Datastreams$Get; + params = + {} as Params$Resource$Properties$Datastreams$Getdataredactionsettings; options = {}; } @@ -12337,12 +11615,12 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } @@ -12728,6 +12006,101 @@ export namespace analyticsadmin_v1alpha { } } + /** + * Updates a DataRedactionSettings on a property. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + options: StreamMethodOptions + ): GaxiosPromise; + updateDataRedactionSettings( + params?: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + options?: MethodOptions + ): GaxiosPromise; + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateDataRedactionSettings( + params: Params$Resource$Properties$Datastreams$Updatedataredactionsettings, + callback: BodyResponseCallback + ): void; + updateDataRedactionSettings( + callback: BodyResponseCallback + ): void; + updateDataRedactionSettings( + paramsOrCallback?: + | Params$Resource$Properties$Datastreams$Updatedataredactionsettings + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Properties$Datastreams$Updatedataredactionsettings; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://analyticsadmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates the enhanced measurement settings for this data stream. Note that the stream must enable enhanced measurement for these settings to take effect. * @@ -12850,6 +12223,13 @@ export namespace analyticsadmin_v1alpha { */ name?: string; } + export interface Params$Resource$Properties$Datastreams$Getdataredactionsettings + extends StandardParameters { + /** + * Required. The name of the settings to lookup. Format: properties/{property\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" + */ + name?: string; + } export interface Params$Resource$Properties$Datastreams$Getenhancedmeasurementsettings extends StandardParameters { /** @@ -12895,6 +12275,22 @@ export namespace analyticsadmin_v1alpha { */ requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataStream; } + export interface Params$Resource$Properties$Datastreams$Updatedataredactionsettings + extends StandardParameters { + /** + * Output only. Name of this Data Redaction Settings resource. Format: properties/{property_id\}/dataStreams/{data_stream\}/dataRedactionSettings Example: "properties/1000/dataStreams/2000/dataRedactionSettings" + */ + name?: string; + /** + * Required. The list of fields to be updated. Field names must be in snake case (e.g., "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaDataRedactionSettings; + } export interface Params$Resource$Properties$Datastreams$Updateenhancedmeasurementsettings extends StandardParameters { /** @@ -17008,14 +16404,14 @@ export namespace analyticsadmin_v1alpha { requestBody?: Schema$GoogleAnalyticsAdminV1alphaGoogleAdsLink; } - export class Resource$Properties$Searchads360links { + export class Resource$Properties$Rolluppropertysourcelinks { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Creates a SearchAds360Link. + * Creates a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -17023,56 +16419,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Searchads360links$Create, + params: Params$Resource$Properties$Rolluppropertysourcelinks$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Searchads360links$Create, + params?: Params$Resource$Properties$Rolluppropertysourcelinks$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Searchads360links$Create, + params: Params$Resource$Properties$Rolluppropertysourcelinks$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Searchads360links$Create, + params: Params$Resource$Properties$Rolluppropertysourcelinks$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Searchads360links$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Rolluppropertysourcelinks$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Searchads360links$Create - | BodyResponseCallback + | Params$Resource$Properties$Rolluppropertysourcelinks$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Searchads360links$Create; + {}) as Params$Resource$Properties$Rolluppropertysourcelinks$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Searchads360links$Create; + params = + {} as Params$Resource$Properties$Rolluppropertysourcelinks$Create; options = {}; } @@ -17086,10 +16483,9 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/searchAds360Links').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/rollupPropertySourceLinks' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options @@ -17100,164 +16496,73 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest( - parameters - ); - } - } - - /** - * Deletes a SearchAds360Link on a property. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - delete( - params: Params$Resource$Properties$Searchads360links$Delete, - options: StreamMethodOptions - ): GaxiosPromise; - delete( - params?: Params$Resource$Properties$Searchads360links$Delete, - options?: MethodOptions - ): GaxiosPromise; - delete( - params: Params$Resource$Properties$Searchads360links$Delete, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Properties$Searchads360links$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - delete( - params: Params$Resource$Properties$Searchads360links$Delete, - callback: BodyResponseCallback - ): void; - delete(callback: BodyResponseCallback): void; - delete( - paramsOrCallback?: - | Params$Resource$Properties$Searchads360links$Delete - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): - | void - | GaxiosPromise - | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Searchads360links$Delete; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Searchads360links$Delete; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://analyticsadmin.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Look up a single SearchAds360Link + * Deletes a roll-up property source link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - get( - params: Params$Resource$Properties$Searchads360links$Get, + delete( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Delete, options: StreamMethodOptions ): GaxiosPromise; - get( - params?: Params$Resource$Properties$Searchads360links$Get, + delete( + params?: Params$Resource$Properties$Rolluppropertysourcelinks$Delete, options?: MethodOptions - ): GaxiosPromise; - get( - params: Params$Resource$Properties$Searchads360links$Get, + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Properties$Searchads360links$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - get( - params: Params$Resource$Properties$Searchads360links$Get, - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Delete, + callback: BodyResponseCallback ): void; - get( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Properties$Searchads360links$Get - | BodyResponseCallback + | Params$Resource$Properties$Rolluppropertysourcelinks$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Searchads360links$Get; + {}) as Params$Resource$Properties$Rolluppropertysourcelinks$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Searchads360links$Get; + params = + {} as Params$Resource$Properties$Rolluppropertysourcelinks$Delete; options = {}; } @@ -17272,7 +16577,7 @@ export namespace analyticsadmin_v1alpha { options: Object.assign( { url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'DELETE', }, options ), @@ -17282,76 +16587,74 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Lists all SearchAds360Links on a property. + * Lookup for a single roll-up property source Link. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - list( - params: Params$Resource$Properties$Searchads360links$List, + get( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Get, options: StreamMethodOptions ): GaxiosPromise; - list( - params?: Params$Resource$Properties$Searchads360links$List, + get( + params?: Params$Resource$Properties$Rolluppropertysourcelinks$Get, options?: MethodOptions - ): GaxiosPromise; - list( - params: Params$Resource$Properties$Searchads360links$List, + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Searchads360links$List, + get( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Properties$Searchads360links$List, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Rolluppropertysourcelinks$Get, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - list( + get( paramsOrCallback?: - | Params$Resource$Properties$Searchads360links$List - | BodyResponseCallback + | Params$Resource$Properties$Rolluppropertysourcelinks$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Searchads360links$List; + {}) as Params$Resource$Properties$Rolluppropertysourcelinks$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Searchads360links$List; + params = {} as Params$Resource$Properties$Rolluppropertysourcelinks$Get; options = {}; } @@ -17365,90 +16668,88 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/searchAds360Links').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a SearchAds360Link on a property. + * Lists roll-up property source Links on a property. Only roll-up properties can have source links, so this method will throw an error if used on other types of properties. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - patch( - params: Params$Resource$Properties$Searchads360links$Patch, + list( + params: Params$Resource$Properties$Rolluppropertysourcelinks$List, options: StreamMethodOptions ): GaxiosPromise; - patch( - params?: Params$Resource$Properties$Searchads360links$Patch, + list( + params?: Params$Resource$Properties$Rolluppropertysourcelinks$List, options?: MethodOptions - ): GaxiosPromise; - patch( - params: Params$Resource$Properties$Searchads360links$Patch, + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Rolluppropertysourcelinks$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Searchads360links$Patch, + list( + params: Params$Resource$Properties$Rolluppropertysourcelinks$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Properties$Searchads360links$Patch, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Rolluppropertysourcelinks$List, + callback: BodyResponseCallback ): void; - patch( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - patch( + list( paramsOrCallback?: - | Params$Resource$Properties$Searchads360links$Patch - | BodyResponseCallback + | Params$Resource$Properties$Rolluppropertysourcelinks$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Searchads360links$Patch; + {}) as Params$Resource$Properties$Rolluppropertysourcelinks$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Searchads360links$Patch; + params = + {} as Params$Resource$Properties$Rolluppropertysourcelinks$List; options = {}; } @@ -17462,152 +16763,138 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + url: ( + rootUrl + '/v1alpha/{+parent}/rollupPropertySourceLinks' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['name'], - pathParams: ['name'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Searchads360links$Create + export interface Params$Resource$Properties$Rolluppropertysourcelinks$Create extends StandardParameters { /** - * Required. Example format: properties/1234 + * Required. Format: properties/{property_id\} Example: properties/1234 */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaRollupPropertySourceLink; } - export interface Params$Resource$Properties$Searchads360links$Delete + export interface Params$Resource$Properties$Rolluppropertysourcelinks$Delete extends StandardParameters { /** - * Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678 + * Required. Format: properties/{property_id\}/rollupPropertySourceLinks/{rollup_property_source_link_id\} Example: properties/1234/rollupPropertySourceLinks/5678 */ name?: string; } - export interface Params$Resource$Properties$Searchads360links$Get + export interface Params$Resource$Properties$Rolluppropertysourcelinks$Get extends StandardParameters { /** - * Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678 + * Required. The name of the roll-up property source link to lookup. Format: properties/{property_id\}/rollupPropertySourceLinks/{rollup_property_source_link_id\} Example: properties/123/rollupPropertySourceLinks/456 */ name?: string; } - export interface Params$Resource$Properties$Searchads360links$List + export interface Params$Resource$Properties$Rolluppropertysourcelinks$List extends StandardParameters { /** - * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + * Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */ pageSize?: number; /** - * A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token. + * Optional. A page token, received from a previous `ListRollupPropertySourceLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListRollupPropertySourceLinks` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Example format: properties/1234 + * Required. The name of the roll-up property to list roll-up property source links under. Format: properties/{property_id\} Example: properties/1234 */ parent?: string; } - export interface Params$Resource$Properties$Searchads360links$Patch - extends StandardParameters { - /** - * Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId\}/searchAds360Links/{linkId\} Note: linkId is not the Search Ads 360 advertiser ID - */ - name?: string; - /** - * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. - */ - updateMask?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link; - } - export class Resource$Properties$Userlinks { + export class Resource$Properties$Searchads360links { context: APIRequestContext; constructor(context: APIRequestContext) { this.context = context; } /** - * Lists all user links on an account or property, including implicit ones that come from effective permissions granted by groups or organization admin roles. If a returned user link does not have direct permissions, they cannot be removed from the account or property directly with the DeleteUserLink command. They have to be removed from the group/etc that gives them permissions, which is currently only usable/discoverable in the GA or GMP UIs. + * Creates a SearchAds360Link. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - audit( - params: Params$Resource$Properties$Userlinks$Audit, + create( + params: Params$Resource$Properties$Searchads360links$Create, options: StreamMethodOptions ): GaxiosPromise; - audit( - params?: Params$Resource$Properties$Userlinks$Audit, + create( + params?: Params$Resource$Properties$Searchads360links$Create, options?: MethodOptions - ): GaxiosPromise; - audit( - params: Params$Resource$Properties$Userlinks$Audit, + ): GaxiosPromise; + create( + params: Params$Resource$Properties$Searchads360links$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - audit( - params: Params$Resource$Properties$Userlinks$Audit, + create( + params: Params$Resource$Properties$Searchads360links$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - audit( - params: Params$Resource$Properties$Userlinks$Audit, - callback: BodyResponseCallback + create( + params: Params$Resource$Properties$Searchads360links$Create, + callback: BodyResponseCallback ): void; - audit( - callback: BodyResponseCallback + create( + callback: BodyResponseCallback ): void; - audit( + create( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Audit - | BodyResponseCallback + | Params$Resource$Properties$Searchads360links$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Audit; + {}) as Params$Resource$Properties$Searchads360links$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Audit; + params = {} as Params$Resource$Properties$Searchads360links$Create; options = {}; } @@ -17621,7 +16908,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:audit').replace( + url: (rootUrl + '/v1alpha/{+parent}/searchAds360Links').replace( /([^:]\/)\/+/g, '$1' ), @@ -17635,76 +16922,72 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Creates information about multiple users' links to an account or property. This method is transactional. If any UserLink cannot be created, none of the UserLinks will be created. + * Deletes a SearchAds360Link on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchCreate( - params: Params$Resource$Properties$Userlinks$Batchcreate, + delete( + params: Params$Resource$Properties$Searchads360links$Delete, options: StreamMethodOptions ): GaxiosPromise; - batchCreate( - params?: Params$Resource$Properties$Userlinks$Batchcreate, + delete( + params?: Params$Resource$Properties$Searchads360links$Delete, options?: MethodOptions - ): GaxiosPromise; - batchCreate( - params: Params$Resource$Properties$Userlinks$Batchcreate, + ): GaxiosPromise; + delete( + params: Params$Resource$Properties$Searchads360links$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchCreate( - params: Params$Resource$Properties$Userlinks$Batchcreate, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - batchCreate( - params: Params$Resource$Properties$Userlinks$Batchcreate, - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Searchads360links$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchCreate( - callback: BodyResponseCallback + delete( + params: Params$Resource$Properties$Searchads360links$Delete, + callback: BodyResponseCallback ): void; - batchCreate( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Batchcreate - | BodyResponseCallback + | Params$Resource$Properties$Searchads360links$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Batchcreate; + {}) as Params$Resource$Properties$Searchads360links$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Batchcreate; + params = {} as Params$Resource$Properties$Searchads360links$Delete; options = {}; } @@ -17718,88 +17001,85 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchCreate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } /** - * Deletes information about multiple users' links to an account or property. + * Look up a single SearchAds360Link * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchDelete( - params: Params$Resource$Properties$Userlinks$Batchdelete, + get( + params: Params$Resource$Properties$Searchads360links$Get, options: StreamMethodOptions ): GaxiosPromise; - batchDelete( - params?: Params$Resource$Properties$Userlinks$Batchdelete, + get( + params?: Params$Resource$Properties$Searchads360links$Get, options?: MethodOptions - ): GaxiosPromise; - batchDelete( - params: Params$Resource$Properties$Userlinks$Batchdelete, + ): GaxiosPromise; + get( + params: Params$Resource$Properties$Searchads360links$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Properties$Userlinks$Batchdelete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Searchads360links$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchDelete( - params: Params$Resource$Properties$Userlinks$Batchdelete, - callback: BodyResponseCallback + get( + params: Params$Resource$Properties$Searchads360links$Get, + callback: BodyResponseCallback ): void; - batchDelete( - callback: BodyResponseCallback + get( + callback: BodyResponseCallback ): void; - batchDelete( + get( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Batchdelete - | BodyResponseCallback + | Params$Resource$Properties$Searchads360links$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Batchdelete; + {}) as Params$Resource$Properties$Searchads360links$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Batchdelete; + params = {} as Params$Resource$Properties$Searchads360links$Get; options = {}; } @@ -17813,88 +17093,87 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchDelete').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest( + parameters + ); } } /** - * Gets information about multiple users' links to an account or property. + * Lists all SearchAds360Links on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchGet( - params: Params$Resource$Properties$Userlinks$Batchget, + list( + params: Params$Resource$Properties$Searchads360links$List, options: StreamMethodOptions ): GaxiosPromise; - batchGet( - params?: Params$Resource$Properties$Userlinks$Batchget, + list( + params?: Params$Resource$Properties$Searchads360links$List, options?: MethodOptions - ): GaxiosPromise; - batchGet( - params: Params$Resource$Properties$Userlinks$Batchget, + ): GaxiosPromise; + list( + params: Params$Resource$Properties$Searchads360links$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchGet( - params: Params$Resource$Properties$Userlinks$Batchget, + list( + params: Params$Resource$Properties$Searchads360links$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchGet( - params: Params$Resource$Properties$Userlinks$Batchget, - callback: BodyResponseCallback + list( + params: Params$Resource$Properties$Searchads360links$List, + callback: BodyResponseCallback ): void; - batchGet( - callback: BodyResponseCallback + list( + callback: BodyResponseCallback ): void; - batchGet( + list( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Batchget - | BodyResponseCallback + | Params$Resource$Properties$Searchads360links$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Batchget; + {}) as Params$Resource$Properties$Searchads360links$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Batchget; + params = {} as Params$Resource$Properties$Searchads360links$List; options = {}; } @@ -17908,7 +17187,7 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchGet').replace( + url: (rootUrl + '/v1alpha/{+parent}/searchAds360Links').replace( /([^:]\/)\/+/g, '$1' ), @@ -17922,76 +17201,76 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates information about multiple users' links to an account or property. + * Updates a SearchAds360Link on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - batchUpdate( - params: Params$Resource$Properties$Userlinks$Batchupdate, + patch( + params: Params$Resource$Properties$Searchads360links$Patch, options: StreamMethodOptions ): GaxiosPromise; - batchUpdate( - params?: Params$Resource$Properties$Userlinks$Batchupdate, + patch( + params?: Params$Resource$Properties$Searchads360links$Patch, options?: MethodOptions - ): GaxiosPromise; - batchUpdate( - params: Params$Resource$Properties$Userlinks$Batchupdate, + ): GaxiosPromise; + patch( + params: Params$Resource$Properties$Searchads360links$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - batchUpdate( - params: Params$Resource$Properties$Userlinks$Batchupdate, + patch( + params: Params$Resource$Properties$Searchads360links$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - batchUpdate( - params: Params$Resource$Properties$Userlinks$Batchupdate, - callback: BodyResponseCallback + patch( + params: Params$Resource$Properties$Searchads360links$Patch, + callback: BodyResponseCallback ): void; - batchUpdate( - callback: BodyResponseCallback + patch( + callback: BodyResponseCallback ): void; - batchUpdate( + patch( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Batchupdate - | BodyResponseCallback + | Params$Resource$Properties$Searchads360links$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Batchupdate; + {}) as Params$Resource$Properties$Searchads360links$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Batchupdate; + params = {} as Params$Resource$Properties$Searchads360links$Patch; options = {}; } @@ -18005,33 +17284,95 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks:batchUpdate').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'POST', + url: (rootUrl + '/v1alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', }, options ), params, - requiredParams: ['parent'], - pathParams: ['parent'], + requiredParams: ['name'], + pathParams: ['name'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } + } + + export interface Params$Resource$Properties$Searchads360links$Create + extends StandardParameters { + /** + * Required. Example format: properties/1234 + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link; + } + export interface Params$Resource$Properties$Searchads360links$Delete + extends StandardParameters { + /** + * Required. The name of the SearchAds360Link to delete. Example format: properties/1234/SearchAds360Links/5678 + */ + name?: string; + } + export interface Params$Resource$Properties$Searchads360links$Get + extends StandardParameters { + /** + * Required. The name of the SearchAds360Link to get. Example format: properties/1234/SearchAds360Link/5678 + */ + name?: string; + } + export interface Params$Resource$Properties$Searchads360links$List + extends StandardParameters { + /** + * The maximum number of resources to return. If unspecified, at most 50 resources will be returned. The maximum value is 200 (higher values will be coerced to the maximum). + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSearchAds360Links` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSearchAds360Links` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. Example format: properties/1234 + */ + parent?: string; + } + export interface Params$Resource$Properties$Searchads360links$Patch + extends StandardParameters { + /** + * Output only. The resource name for this SearchAds360Link resource. Format: properties/{propertyId\}/searchAds360Links/{linkId\} Note: linkId is not the Search Ads 360 advertiser ID + */ + name?: string; + /** + * Required. The list of fields to be updated. Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleAnalyticsAdminV1alphaSearchAds360Link; + } + + export class Resource$Properties$Subpropertyeventfilters { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } /** - * Creates a user link on an account or property. If the user with the specified email already has permissions on the account or property, then the user's existing permissions will be unioned with the permissions specified in the new UserLink. + * Creates a subproperty Event Filter. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18039,56 +17380,57 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Properties$Userlinks$Create, + params: Params$Resource$Properties$Subpropertyeventfilters$Create, options: StreamMethodOptions ): GaxiosPromise; create( - params?: Params$Resource$Properties$Userlinks$Create, + params?: Params$Resource$Properties$Subpropertyeventfilters$Create, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; create( - params: Params$Resource$Properties$Userlinks$Create, + params: Params$Resource$Properties$Subpropertyeventfilters$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Userlinks$Create, + params: Params$Resource$Properties$Subpropertyeventfilters$Create, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Properties$Userlinks$Create, - callback: BodyResponseCallback + params: Params$Resource$Properties$Subpropertyeventfilters$Create, + callback: BodyResponseCallback ): void; create( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; create( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Create - | BodyResponseCallback + | Params$Resource$Properties$Subpropertyeventfilters$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Create; + {}) as Params$Resource$Properties$Subpropertyeventfilters$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Create; + params = + {} as Params$Resource$Properties$Subpropertyeventfilters$Create; options = {}; } @@ -18102,10 +17444,9 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/subpropertyEventFilters' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options @@ -18116,19 +17457,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Deletes a user link on an account or property. + * Deletes a subproperty event filter. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18136,31 +17477,31 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Properties$Userlinks$Delete, + params: Params$Resource$Properties$Subpropertyeventfilters$Delete, options: StreamMethodOptions ): GaxiosPromise; delete( - params?: Params$Resource$Properties$Userlinks$Delete, + params?: Params$Resource$Properties$Subpropertyeventfilters$Delete, options?: MethodOptions ): GaxiosPromise; delete( - params: Params$Resource$Properties$Userlinks$Delete, + params: Params$Resource$Properties$Subpropertyeventfilters$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Userlinks$Delete, + params: Params$Resource$Properties$Subpropertyeventfilters$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Properties$Userlinks$Delete, + params: Params$Resource$Properties$Subpropertyeventfilters$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Delete + | Params$Resource$Properties$Subpropertyeventfilters$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -18176,12 +17517,13 @@ export namespace analyticsadmin_v1alpha { | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Delete; + {}) as Params$Resource$Properties$Subpropertyeventfilters$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Delete; + params = + {} as Params$Resource$Properties$Subpropertyeventfilters$Delete; options = {}; } @@ -18216,7 +17558,7 @@ export namespace analyticsadmin_v1alpha { } /** - * Gets information about a user's link to an account or property. + * Lookup for a single subproperty Event Filter. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18224,56 +17566,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Properties$Userlinks$Get, + params: Params$Resource$Properties$Subpropertyeventfilters$Get, options: StreamMethodOptions ): GaxiosPromise; get( - params?: Params$Resource$Properties$Userlinks$Get, + params?: Params$Resource$Properties$Subpropertyeventfilters$Get, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; get( - params: Params$Resource$Properties$Userlinks$Get, + params: Params$Resource$Properties$Subpropertyeventfilters$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Userlinks$Get, + params: Params$Resource$Properties$Subpropertyeventfilters$Get, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Properties$Userlinks$Get, - callback: BodyResponseCallback + params: Params$Resource$Properties$Subpropertyeventfilters$Get, + callback: BodyResponseCallback ): void; get( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; get( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Get - | BodyResponseCallback + | Params$Resource$Properties$Subpropertyeventfilters$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Get; + {}) as Params$Resource$Properties$Subpropertyeventfilters$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Get; + params = {} as Params$Resource$Properties$Subpropertyeventfilters$Get; options = {}; } @@ -18298,19 +17640,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Lists all user links on an account or property. + * List all subproperty Event Filters on a property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18318,56 +17660,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Properties$Userlinks$List, + params: Params$Resource$Properties$Subpropertyeventfilters$List, options: StreamMethodOptions ): GaxiosPromise; list( - params?: Params$Resource$Properties$Userlinks$List, + params?: Params$Resource$Properties$Subpropertyeventfilters$List, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; list( - params: Params$Resource$Properties$Userlinks$List, + params: Params$Resource$Properties$Subpropertyeventfilters$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Userlinks$List, + params: Params$Resource$Properties$Subpropertyeventfilters$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - params: Params$Resource$Properties$Userlinks$List, - callback: BodyResponseCallback + params: Params$Resource$Properties$Subpropertyeventfilters$List, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; list( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$List - | BodyResponseCallback + | Params$Resource$Properties$Subpropertyeventfilters$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$List; + {}) as Params$Resource$Properties$Subpropertyeventfilters$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$List; + params = {} as Params$Resource$Properties$Subpropertyeventfilters$List; options = {}; } @@ -18381,10 +17723,9 @@ export namespace analyticsadmin_v1alpha { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1alpha/{+parent}/userLinks').replace( - /([^:]\/)\/+/g, - '$1' - ), + url: ( + rootUrl + '/v1alpha/{+parent}/subpropertyEventFilters' + ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', }, options @@ -18395,19 +17736,19 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } /** - * Updates a user link on an account or property. + * Updates a subproperty Event Filter. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -18415,56 +17756,56 @@ export namespace analyticsadmin_v1alpha { * @returns A promise if used with async/await, or void if used with a callback. */ patch( - params: Params$Resource$Properties$Userlinks$Patch, + params: Params$Resource$Properties$Subpropertyeventfilters$Patch, options: StreamMethodOptions ): GaxiosPromise; patch( - params?: Params$Resource$Properties$Userlinks$Patch, + params?: Params$Resource$Properties$Subpropertyeventfilters$Patch, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; patch( - params: Params$Resource$Properties$Userlinks$Patch, + params: Params$Resource$Properties$Subpropertyeventfilters$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Userlinks$Patch, + params: Params$Resource$Properties$Subpropertyeventfilters$Patch, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; patch( - params: Params$Resource$Properties$Userlinks$Patch, - callback: BodyResponseCallback + params: Params$Resource$Properties$Subpropertyeventfilters$Patch, + callback: BodyResponseCallback ): void; patch( - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; patch( paramsOrCallback?: - | Params$Resource$Properties$Userlinks$Patch - | BodyResponseCallback + | Params$Resource$Properties$Subpropertyeventfilters$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | GaxiosPromise + | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Properties$Userlinks$Patch; + {}) as Params$Resource$Properties$Subpropertyeventfilters$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Properties$Userlinks$Patch; + params = {} as Params$Resource$Properties$Subpropertyeventfilters$Patch; options = {}; } @@ -18489,132 +17830,73 @@ export namespace analyticsadmin_v1alpha { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( + return createAPIRequest( parameters ); } } } - export interface Params$Resource$Properties$Userlinks$Audit - extends StandardParameters { - /** - * Required. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaAuditUserLinksRequest; - } - export interface Params$Resource$Properties$Userlinks$Batchcreate - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. This field is required. The parent field in the CreateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchCreateUserLinksRequest; - } - export interface Params$Resource$Properties$Userlinks$Batchdelete - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. The parent of all values for user link names to delete must match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchDeleteUserLinksRequest; - } - export interface Params$Resource$Properties$Userlinks$Batchget - extends StandardParameters { - /** - * Required. The names of the user links to retrieve. A maximum of 1000 user links can be retrieved in a batch. Format: accounts/{accountId\}/userLinks/{userLinkId\} - */ - names?: string[]; - /** - * Required. The account or property that all user links in the request are for. The parent of all provided values for the 'names' field must match this field. Example format: accounts/1234 - */ - parent?: string; - } - export interface Params$Resource$Properties$Userlinks$Batchupdate - extends StandardParameters { - /** - * Required. The account or property that all user links in the request are for. The parent field in the UpdateUserLinkRequest messages must either be empty or match this field. Example format: accounts/1234 - */ - parent?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaBatchUpdateUserLinksRequest; - } - export interface Params$Resource$Properties$Userlinks$Create + export interface Params$Resource$Properties$Subpropertyeventfilters$Create extends StandardParameters { /** - * Optional. If set, then email the new user notifying them that they've been granted permissions to the resource. - */ - notifyNewUser?: boolean; - /** - * Required. Example format: accounts/1234 + * Required. The ordinary property for which to create a subproperty event filter. Format: properties/property_id Example: properties/123 */ parent?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaUserLink; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; } - export interface Params$Resource$Properties$Userlinks$Delete + export interface Params$Resource$Properties$Subpropertyeventfilters$Delete extends StandardParameters { /** - * Required. Example format: accounts/1234/userLinks/5678 + * Required. Resource name of the subproperty event filter to delete. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 */ name?: string; } - export interface Params$Resource$Properties$Userlinks$Get + export interface Params$Resource$Properties$Subpropertyeventfilters$Get extends StandardParameters { /** - * Required. Example format: accounts/1234/userLinks/5678 + * Required. Resource name of the subproperty event filter to lookup. Format: properties/property_id/subpropertyEventFilters/subproperty_event_filter Example: properties/123/subpropertyEventFilters/456 */ name?: string; } - export interface Params$Resource$Properties$Userlinks$List + export interface Params$Resource$Properties$Subpropertyeventfilters$List extends StandardParameters { /** - * The maximum number of user links to return. The service may return fewer than this value. If unspecified, at most 200 user links will be returned. The maximum value is 500; values above 500 will be coerced to 500. + * Optional. The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum) */ pageSize?: number; /** - * A page token, received from a previous `ListUserLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListUserLinks` must match the call that provided the page token. + * Optional. A page token, received from a previous `ListSubpropertyEventFilters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubpropertyEventFilters` must match the call that provided the page token. */ pageToken?: string; /** - * Required. Example format: accounts/1234 + * Required. Resource name of the ordinary property. Format: properties/property_id Example: properties/123 */ parent?: string; } - export interface Params$Resource$Properties$Userlinks$Patch + export interface Params$Resource$Properties$Subpropertyeventfilters$Patch extends StandardParameters { /** - * Output only. Example format: properties/1234/userLinks/5678 + * Output only. Format: properties/{ordinary_property_id\}/subpropertyEventFilters/{sub_property_event_filter\} Example: properties/1234/subpropertyEventFilters/5678 */ name?: string; + /** + * Required. The list of fields to update. Field names must be in snake case (for example, "field_to_update"). Omitted fields will not be updated. To replace the entire entity, use one path with the string "*" to match all fields. + */ + updateMask?: string; /** * Request body metadata */ - requestBody?: Schema$GoogleAnalyticsAdminV1alphaUserLink; + requestBody?: Schema$GoogleAnalyticsAdminV1alphaSubpropertyEventFilter; } } diff --git a/src/apis/analyticsadmin/v1beta.ts b/src/apis/analyticsadmin/v1beta.ts index 21c5bc97ea..54da00c192 100644 --- a/src/apis/analyticsadmin/v1beta.ts +++ b/src/apis/analyticsadmin/v1beta.ts @@ -1022,7 +1022,7 @@ export namespace analyticsadmin_v1beta { */ parent?: string | null; /** - * Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. "SUBPROPERTY" and "ROLLUP_PROPERTY" types cannot yet be created with the Google Analytics Admin API. + * Immutable. The property type for this Property resource. When creating a property, if the type is "PROPERTY_TYPE_UNSPECIFIED", then "ORDINARY_PROPERTY" will be implied. */ propertyType?: string | null; /** @@ -1097,6 +1097,14 @@ export namespace analyticsadmin_v1beta { * The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions. */ dimensions?: Schema$GoogleAnalyticsAdminV1betaAccessDimension[]; + /** + * Optional. Decides whether to return the users within user groups. This field works only when include_all_users is set to true. If true, it will return all users with access to the specified property or account. If false, only the users with direct access will be returned. + */ + expandGroups?: boolean | null; + /** + * Optional. Determines whether to include users who have never made an API call in the response. If true, all users with access to the specified property or account are included in the response, regardless of whether they have made an API call or not. If false, only the users who have made an API call will be included. + */ + includeAllUsers?: boolean | null; /** * The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination). */ @@ -1213,7 +1221,7 @@ export namespace analyticsadmin_v1beta { } /** - * Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. + * Marks target Account as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted accounts. However, they can be restored using the Trash Can UI. If the accounts are not restored before the expiration time, the account and all child resources (eg: Properties, GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2374,7 +2382,7 @@ export namespace analyticsadmin_v1beta { } /** - * Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, UserLinks) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. + * Marks target Property as soft-deleted (ie: "trashed") and returns it. This API does not have a method to restore soft-deleted properties. However, they can be restored using the Trash Can UI. If the properties are not restored before the expiration time, the Property and all child resources (eg: GoogleAdsLinks, Streams, AccessBindings) will be permanently purged. https://support.google.com/analytics/answer/6154772 Returns an error if the target is not found, or is not a GA4 Property. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/analyticshub/v1.ts b/src/apis/analyticshub/v1.ts index c38ad477c4..543a066f2a 100644 --- a/src/apis/analyticshub/v1.ts +++ b/src/apis/analyticshub/v1.ts @@ -474,17 +474,13 @@ export namespace analyticshub_v1 { response?: {[key: string]: any} | null; } /** - * Represents the metadata of the long-running operation. + * Represents the metadata of a long-running operation in Analytics Hub. */ export interface Schema$OperationMetadata { /** * Output only. API version used to start the operation. */ apiVersion?: string | null; - /** - * 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`. - */ - cancelRequested?: boolean | null; /** * Output only. The time the operation was created. */ @@ -493,10 +489,14 @@ export namespace analyticshub_v1 { * Output only. The time the operation finished running. */ endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; /** * Output only. Human-readable status of the operation, if any. */ - statusDetail?: string | null; + statusMessage?: string | null; /** * Output only. Server-defined resource path for the target of the operation. */ diff --git a/src/apis/analyticshub/v1beta1.ts b/src/apis/analyticshub/v1beta1.ts index 4abb93c1ca..4f3ffb8556 100644 --- a/src/apis/analyticshub/v1beta1.ts +++ b/src/apis/analyticshub/v1beta1.ts @@ -411,17 +411,13 @@ export namespace analyticshub_v1beta1 { nextPageToken?: string | null; } /** - * Represents the metadata of the long-running operation. + * Represents the metadata of a long-running operation in Analytics Hub. */ export interface Schema$OperationMetadata { /** * Output only. API version used to start the operation. */ apiVersion?: string | null; - /** - * 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`. - */ - cancelRequested?: boolean | null; /** * Output only. The time the operation was created. */ @@ -430,10 +426,14 @@ export namespace analyticshub_v1beta1 { * Output only. The time the operation finished running. */ endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; /** * Output only. Human-readable status of the operation, if any. */ - statusDetail?: string | null; + statusMessage?: string | null; /** * Output only. Server-defined resource path for the target of the operation. */ diff --git a/src/apis/androidmanagement/v1.ts b/src/apis/androidmanagement/v1.ts index 945575b55c..e23a7931db 100644 --- a/src/apis/androidmanagement/v1.ts +++ b/src/apis/androidmanagement/v1.ts @@ -801,7 +801,7 @@ export namespace androidmanagement_v1 { */ exemptionsToShowWorkContactsInPersonalProfile?: Schema$PackageNameList; /** - * Whether contacts stored in the work profile can be shown in personal profile contact searches and incoming calls. + * Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. */ showWorkContactsInPersonalProfile?: string | null; /** @@ -1009,6 +1009,14 @@ export namespace androidmanagement_v1 { * Controls whether airplane mode can be toggled by the user or not. */ airplaneModeState?: string | null; + /** + * Controls whether cellular 2G setting can be toggled by the user or not. + */ + cellularTwoGState?: string | null; + /** + * Controls the state of the ultra wideband setting and whether the user can toggle it on or off. + */ + ultraWidebandState?: string | null; /** * Controls current state of Wi-Fi and if user can change its state. */ @@ -2028,7 +2036,7 @@ export namespace androidmanagement_v1 { */ cameraDisabled?: boolean | null; /** - * Controls how long the work profile can stay off. The duration must be at least 3 days. + * Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to any value between 1-2 days, the feature is automatically set to 3 days. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. */ maxDaysWithWorkOff?: number | null; /** @@ -2558,7 +2566,7 @@ export namespace androidmanagement_v1 { title?: Schema$UserFacingMessage; } /** - * A resource containing sign in details for an enterprise. + * A resource containing sign in details for an enterprise. Use enterprises to manage SigninDetails for a given enterprise.For an enterprise, we can have any number of SigninDetails that is uniquely identified by combination of the following three fields (signin_url, allow_personal_usage, token_tag). One cannot create two SigninDetails with the same (signin_url, allow_personal_usage, token_tag). (token_tag is an optional field).Patch: The operation updates the current list of SigninDetails with the new list of SigninDetails. If the stored SigninDetail configuration is passed, it returns the same signin_enrollment_token and qr_code. If we pass multiple identical SigninDetail configurations that are not stored, it will store the first one amongst those SigninDetail configurations. if the configuration already exists we cannot request it more than once in a particular patch API call, otherwise it will give a duplicate key error and the whole operation will fail. If we remove certain SigninDetail configuration from the request then it will get removed from the storage. We can then request another signin_enrollment_token and qr_code for the same SigninDetail configuration. */ export interface Schema$SigninDetail { /** @@ -2577,6 +2585,10 @@ export namespace androidmanagement_v1 { * Sign-in URL for authentication when device is provisioned with a sign-in enrollment token. The sign-in endpoint should finish authentication flow with a URL in the form of https://enterprise.google.com/android/enroll?et= for a successful login, or https://enterprise.google.com/android/enroll/invalid for a failed login. */ signinUrl?: string | null; + /** + * An EMM-specified metadata to distinguish between instances of SigninDetail. + */ + tokenTag?: string | null; } /** * An enterprise signup URL. diff --git a/src/apis/androidpublisher/v3.ts b/src/apis/androidpublisher/v3.ts index 78eb9cdaf4..7653249f70 100644 --- a/src/apis/androidpublisher/v3.ts +++ b/src/apis/androidpublisher/v3.ts @@ -2170,7 +2170,7 @@ export namespace androidpublisher_v3 { */ export interface Schema$SubscriptionItemPriceChangeDetails { /** - * The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. + * The renewal time at which the price change will become effective for the user. This is subject to change(to a future time) due to cases where the renewal time shifts like pause. This field is only populated if the price change has not taken effect. */ expectedNewPriceChargeTime?: string | null; /** diff --git a/src/apis/apigeeregistry/v1.ts b/src/apis/apigeeregistry/v1.ts index 2c3836ed69..5269198586 100644 --- a/src/apis/apigeeregistry/v1.ts +++ b/src/apis/apigeeregistry/v1.ts @@ -810,6 +810,7 @@ export namespace apigeeregistry_v1 { context: APIRequestContext; apis: Resource$Projects$Locations$Apis; artifacts: Resource$Projects$Locations$Artifacts; + documents: Resource$Projects$Locations$Documents; instances: Resource$Projects$Locations$Instances; operations: Resource$Projects$Locations$Operations; runtime: Resource$Projects$Locations$Runtime; @@ -817,6 +818,7 @@ export namespace apigeeregistry_v1 { this.context = context; this.apis = new Resource$Projects$Locations$Apis(this.context); this.artifacts = new Resource$Projects$Locations$Artifacts(this.context); + this.documents = new Resource$Projects$Locations$Documents(this.context); this.instances = new Resource$Projects$Locations$Instances(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context @@ -9580,6 +9582,323 @@ export namespace apigeeregistry_v1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Documents { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Documents$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Documents$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Documents$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Documents$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://apigeeregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Documents$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Documents$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Documents$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Documents$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Documents$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://apigeeregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Documents$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Documents$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Documents$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Documents$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Documents$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Documents$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Documents$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Documents$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://apigeeregistry.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Documents$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Documents$Setiampolicy + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Documents$Testiampermissions + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export class Resource$Projects$Locations$Instances { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/artifactregistry/v1.ts b/src/apis/artifactregistry/v1.ts index 02d72e044b..f27b42a970 100644 --- a/src/apis/artifactregistry/v1.ts +++ b/src/apis/artifactregistry/v1.ts @@ -2858,7 +2858,7 @@ export namespace artifactregistry_v1 { */ parent?: string; /** - * The repository id to use for this repository. + * Required. The repository id to use for this repository. */ repositoryId?: string; diff --git a/src/apis/artifactregistry/v1beta1.ts b/src/apis/artifactregistry/v1beta1.ts index f9b74613fd..29bb9b26ba 100644 --- a/src/apis/artifactregistry/v1beta1.ts +++ b/src/apis/artifactregistry/v1beta1.ts @@ -1559,7 +1559,7 @@ export namespace artifactregistry_v1beta1 { */ parent?: string; /** - * The repository id to use for this repository. + * Required. The repository id to use for this repository. */ repositoryId?: string; diff --git a/src/apis/backupdr/README.md b/src/apis/backupdr/README.md new file mode 100644 index 0000000000..541824e507 --- /dev/null +++ b/src/apis/backupdr/README.md @@ -0,0 +1,28 @@ +Google Inc. logo + +# backupdr + +> + +## Installation + +```sh +$ npm install @googleapis/backupdr +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/backupdr/classes/Backupdr.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/backupdr/index.ts b/src/apis/backupdr/index.ts new file mode 100644 index 0000000000..2612629068 --- /dev/null +++ b/src/apis/backupdr/index.ts @@ -0,0 +1,44 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {backupdr_v1} from './v1'; + +export const VERSIONS = { + v1: backupdr_v1.Backupdr, +}; + +export function backupdr(version: 'v1'): backupdr_v1.Backupdr; +export function backupdr(options: backupdr_v1.Options): backupdr_v1.Backupdr; +export function backupdr( + this: GoogleConfigurable, + versionOrOptions: 'v1' | backupdr_v1.Options +) { + return getAPI('backupdr', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {backupdr_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/backupdr/package.json b/src/apis/backupdr/package.json new file mode 100644 index 0000000000..4310473dd1 --- /dev/null +++ b/src/apis/backupdr/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/backupdr", + "version": "0.1.0", + "description": "backupdr", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/backupdr/tsconfig.json b/src/apis/backupdr/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/backupdr/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/backupdr/v1.ts b/src/apis/backupdr/v1.ts new file mode 100644 index 0000000000..0626a8d854 --- /dev/null +++ b/src/apis/backupdr/v1.ts @@ -0,0 +1,1825 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace backupdr_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Backup and DR Service API + * + * + * + * @example + * ```js + * const {google} = require('googleapis'); + * const backupdr = google.backupdr('v1'); + * ``` + */ + export class Backupdr { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * 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. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * 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. + */ + service?: string | null; + } + /** + * 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. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * 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). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `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. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * The request message for Operations.CancelOperation. + */ + export interface Schema$CancelOperationRequest {} + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * 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. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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. + */ + title?: string | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for listing management servers. + */ + export interface Schema$ListManagementServersResponse { + /** + * The list of ManagementServer instances in the project for the specified location. If the `{location\}` value in the request is "-", the response contains a list of instances from all locations. In case any location is unreachable, the response will only return management servers in reachable locations and the 'unreachable' field will be populated with a list of unreachable locations. + */ + managementServers?: Schema$ManagementServer[]; + /** + * A token identifying a page of results the server should return. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * ManagementServer describes a single BackupDR ManagementServer instance. + */ + export interface Schema$ManagementServer { + /** + * Output only. The time when the instance was created. + */ + createTime?: string | null; + /** + * Optional. The description of the ManagementServer instance (2048 characters or less). + */ + description?: string | null; + /** + * Optional. Server specified ETag for the ManagementServer resource to prevent simultaneous updates from overwiting each other. + */ + etag?: string | null; + /** + * Optional. Resource labels to represent user provided metadata. Labels currently defined: 1. migrate_from_go= If set to true, the MS is created in migration ready mode. + */ + labels?: {[key: string]: string} | null; + /** + * Output only. The hostname or ip address of the exposed AGM endpoints, used by clients to connect to AGM/RD graphical user interface and APIs. + */ + managementUri?: Schema$ManagementURI; + /** + * Output only. The resource name. + */ + name?: string | null; + /** + * Required. VPC networks to which the ManagementServer instance is connected. For this version, only a single network is supported. + */ + networks?: Schema$NetworkConfig[]; + /** + * Output only. The OAuth 2.0 client id is required to make API calls to the BackupDR instance API of this ManagementServer. This is the value that should be provided in the ‘aud’ field of the OIDC ID Token (see openid specification https://openid.net/specs/openid-connect-core-1_0.html#IDToken). + */ + oauth2ClientId?: string | null; + /** + * Output only. The ManagementServer state. + */ + state?: string | null; + /** + * Required. The type of the ManagementServer resource. + */ + type?: string | null; + /** + * Output only. The time when the instance was updated. + */ + updateTime?: string | null; + } + /** + * ManagementURI for the Management Server resource. + */ + export interface Schema$ManagementURI { + /** + * Output only. The ManagementServer AGM/RD API URL. + */ + api?: string | null; + /** + * Output only. The ManagementServer AGM/RD WebUI URL. + */ + webUi?: string | null; + } + /** + * Network configuration for ManagementServer instance. + */ + export interface Schema$NetworkConfig { + /** + * Optional. The resource name of the Google Compute Engine VPC network to which the ManagementServer instance is connected. + */ + network?: string | null; + /** + * Optional. The network connect mode of the ManagementServer instance. For this version, only PRIVATE_SERVICE_ACCESS is supported. + */ + peeringMode?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. AdditionalInfo contains additional Info related to backup plan association resource. + */ + additionalInfo?: {[key: string]: string} | null; + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * 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/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * 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`. + */ + bindings?: Schema$Binding[]; + /** + * `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. + */ + etag?: string | null; + /** + * 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). + */ + version?: number | null; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * 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. + */ + policy?: Schema$Policy; + /** + * 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"` + */ + updateMask?: string | null; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * 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). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + managementServers: Resource$Projects$Locations$Managementservers; + operations: Resource$Projects$Locations$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.managementServers = + new Resource$Projects$Locations$Managementservers(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Managementservers { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new ManagementServer in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Managementservers$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Managementservers$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Managementservers$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Managementservers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Managementservers$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/managementServers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a single ManagementServer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Managementservers$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Managementservers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Managementservers$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Managementservers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Managementservers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of a single ManagementServer. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Managementservers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Managementservers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Managementservers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Managementservers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Managementservers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Managementservers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Managementservers$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ManagementServers in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Managementservers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Managementservers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Managementservers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Managementservers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Managementservers$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/managementServers').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Managementservers$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Managementservers$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Managementservers$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Managementservers$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Managementservers$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Managementservers$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Managementservers$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Managementservers$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Managementservers$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Managementservers$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Managementservers$Create + extends StandardParameters { + /** + * Required. The name of the management server to create. The name must be unique for the specified project and location. + */ + managementServerId?: string; + /** + * Required. The management server project and location in the format `projects/{project_id\}/locations/{location\}`. In Cloud Backup and DR locations map to GCP regions, for example **us-central1**. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ManagementServer; + } + export interface Params$Resource$Projects$Locations$Managementservers$Delete + extends StandardParameters { + /** + * Required. Name of the resource + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Managementservers$Get + extends StandardParameters { + /** + * Required. Name of the management server resource name, in the format `projects/{project_id\}/locations/{location\}/managementServers/{resource_name\}` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Managementservers$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Managementservers$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. + */ + pageToken?: string; + /** + * Required. The project and location for which to retrieve management servers information, in the format `projects/{project_id\}/locations/{location\}`. In Cloud BackupDR, locations map to GCP regions, for example **us-central1**. To retrieve management servers for all locations, use "-" for the `{location\}` value. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Managementservers$Setiampolicy + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Managementservers$Testiampermissions + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Projects$Locations$Operations$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Projects$Locations$Operations$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:cancel').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://backupdr.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Cancel + extends StandardParameters { + /** + * The name of the operation resource to be cancelled. + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CancelOperationRequest; + } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } +} diff --git a/src/apis/backupdr/webpack.config.js b/src/apis/backupdr/webpack.config.js new file mode 100644 index 0000000000..91b7da243b --- /dev/null +++ b/src/apis/backupdr/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Backupdr', + filename: 'backupdr.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/batch/v1.ts b/src/apis/batch/v1.ts index 19a1120015..9e812a67a4 100644 --- a/src/apis/batch/v1.ts +++ b/src/apis/batch/v1.ts @@ -1032,6 +1032,10 @@ export namespace batch_v1 { * Container runnable. */ container?: Schema$Container; + /** + * Optional. DisplayName is an optional field that can be provided by the caller. If provided, it will be used in logs and other outputs to identify the script, making it easier for users to understand the logs. If not provided the index of the runnable will be used for outputs. + */ + displayName?: string | null; /** * Environment variables for this Runnable (overrides variables set for the whole Task or TaskGroup). */ diff --git a/src/apis/beyondcorp/v1alpha.ts b/src/apis/beyondcorp/v1alpha.ts index 9aa1d085e5..244b46fbab 100644 --- a/src/apis/beyondcorp/v1alpha.ts +++ b/src/apis/beyondcorp/v1alpha.ts @@ -1238,6 +1238,10 @@ export namespace beyondcorp_v1alpha { * Output only. ProxyConfig resource name. */ name?: string | null; + /** + * Optional. Protocol config data for the Proxy. + */ + proxyProtocolConfig?: Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig; /** * Required. The URI of the proxy server. */ @@ -1255,6 +1259,15 @@ export namespace beyondcorp_v1alpha { */ updateTime?: string | null; } + /** + * The protocol data that specifies how to communicate with Partner's Proxy. + */ + export interface Schema$GoogleCloudBeyondcorpPartnerservicesV1alphaProxyProtocolConfig { + /** + * Optional. Untyped property bag to be sent back to the proxy using client specific mechanism. + */ + metadata?: {[key: string]: string} | null; + } /** * Message contains the routing information to direct traffic to the proxy server. */ diff --git a/src/apis/binaryauthorization/v1.ts b/src/apis/binaryauthorization/v1.ts index bbc878d52a..e5d1924ead 100644 --- a/src/apis/binaryauthorization/v1.ts +++ b/src/apis/binaryauthorization/v1.ts @@ -421,6 +421,10 @@ export namespace binaryauthorization_v1 { * A public key in the PkixPublicKey [format](https://tools.ietf.org/html/rfc5280#section-4.1.2.7). Public keys of this type are typically textually encoded using the PEM format. */ export interface Schema$PkixPublicKey { + /** + * Optional. The ID of this public key. Signatures verified by Binary Authorization must include the ID of the public key that can be used to verify them, and that ID must match the contents of this field exactly. This may be explicitly provided by the caller, but it MUST be a valid RFC3986 URI. If `key_id` is left blank and this `PkixPublicKey` is not used in the context of a wrapper (see next paragraph), a default key ID will be computed based on the digest of the DER encoding of the public key. If this `PkixPublicKey` is used in the context of a wrapper that has its own notion of key ID (e.g. `AttestorPublicKey`), then this field can either: * Match that value exactly. * Or be left blank, in which case it behaves exactly as though it is equal to that wrapper value. + */ + keyId?: string | null; /** * A PEM-encoded public key, as described in https://tools.ietf.org/html/rfc7468#section-13 */ diff --git a/src/apis/blockchainnodeengine/v1.ts b/src/apis/blockchainnodeengine/v1.ts index 0ed8af5da4..bb1cd4a0f3 100644 --- a/src/apis/blockchainnodeengine/v1.ts +++ b/src/apis/blockchainnodeengine/v1.ts @@ -207,6 +207,10 @@ export namespace blockchainnodeengine_v1 { * Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`. */ apiEnableDebug?: boolean | null; + /** + * An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced. + */ + beaconFeeRecipient?: string | null; /** * Immutable. The consensus client. */ diff --git a/src/apis/chat/v1.ts b/src/apis/chat/v1.ts index 96f5d93308..7ab489b27a 100644 --- a/src/apis/chat/v1.ts +++ b/src/apis/chat/v1.ts @@ -170,7 +170,7 @@ export namespace chat_v1 { userFacingMessage?: string | null; } /** - * Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/api/guides/message-formats/text#format-texts). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user\}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ``` + * Output only. Annotations associated with the plain-text body of the message. To add basic formatting to a text message, see [Format text messages](https://developers.google.com/chat/format-messages). Example plain-text message body: ``` Hello @FooBot how are you!" ``` The corresponding annotations metadata: ``` "annotations":[{ "type":"USER_MENTION", "startIndex":6, "length":7, "userMention": { "user": { "name":"users/{user\}", "displayName":"FooBot", "avatarUrl":"https://goo.gl/aeDtrS", "type":"BOT" \}, "type":"MENTION" \} \}] ``` */ export interface Schema$Annotation { /** @@ -600,7 +600,7 @@ export namespace chat_v1 { */ parameters?: Schema$GoogleAppsCardV1ActionParameter[]; /** - * Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/message-formats/cards) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`. + * Indicates whether form values persist after the action. The default value is `false`. If `true`, form values remain after the action is triggered. To let the user make changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `NONE`. For [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create) in Chat apps, you must also set the action's [`ResponseType`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#responsetype) to `UPDATE_MESSAGE` and use the same [`card_id`](https://developers.google.com/chat/api/reference/rest/v1/spaces.messages#CardWithId) from the card that contained the action. If `false`, the form values are cleared when the action is triggered. To prevent the user from making changes while the action is being processed, set [`LoadIndicator`](https://developers.google.com/workspace/add-ons/reference/rpc/google.apps.card.v1#loadindicator) to `SPINNER`. */ persistValues?: boolean | null; } @@ -685,7 +685,7 @@ export namespace chat_v1 { */ displayStyle?: string | null; /** - * The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards). + * The fixed footer shown at the bottom of this card. Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create). */ fixedFooter?: Schema$GoogleAppsCardV1CardFixedFooter; /** @@ -723,7 +723,7 @@ export namespace chat_v1 { onClick?: Schema$GoogleAppsCardV1OnClick; } /** - * A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/message-formats/cards). + * A persistent (sticky) footer that that appears at the bottom of the card. For an example in Google Chat apps, see [Card footer](https://developers.google.com/chat/ui/widgets/card-fixed-footer). Setting `fixedFooter` without specifying a `primaryButton` or a `secondaryButton` causes an error. Supported by Google Workspace Add-ons and Chat apps. For Chat apps, you can use fixed footers in [dialogs](https://developers.google.com/chat/how-tos/dialogs), but not [card messages](https://developers.google.com/chat/api/guides/v1/messages/create#create). */ export interface Schema$GoogleAppsCardV1CardFixedFooter { /** @@ -832,7 +832,7 @@ export namespace chat_v1 { */ button?: Schema$GoogleAppsCardV1Button; /** - * An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons. + * An icon displayed after the text. Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons. */ endIcon?: Schema$GoogleAppsCardV1Icon; /** @@ -852,7 +852,7 @@ export namespace chat_v1 { */ switchControl?: Schema$GoogleAppsCardV1SwitchControl; /** - * Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * Required. The primary text. Supports simple formatting. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ text?: string | null; /** @@ -919,7 +919,7 @@ export namespace chat_v1 { title?: string | null; } /** - * An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons) and [custom](https://developers.google.com/chat/api/guides/message-formats/cards#customicons) icons. + * An icon displayed in a widget on a card. For an example in Google Chat apps, see [Icon](https://developers.google.com/chat/ui/widgets/icon). Supports [built-in](https://developers.google.com/chat/format-messages#builtinicons) and [custom](https://developers.google.com/chat/format-messages#customicons) icons. */ export interface Schema$GoogleAppsCardV1Icon { /** @@ -935,7 +935,7 @@ export namespace chat_v1 { */ imageType?: string | null; /** - * Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/api/guides/message-formats/cards#builtinicons). + * Display one of the built-in icons provided by Google Workspace. For example, to display an airplane icon, specify `AIRPLANE`. For a bus, specify `BUS`. For a full list of supported icons, see [built-in icons](https://developers.google.com/chat/format-messages#builtinicons). */ knownIcon?: string | null; } @@ -1050,7 +1050,7 @@ export namespace chat_v1 { */ collapsible?: boolean | null; /** - * Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * Text that appears at the top of a section. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ header?: string | null; /** @@ -1213,7 +1213,7 @@ export namespace chat_v1 { value?: string | null; } /** - * A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards##card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * A paragraph of text that supports formatting. For an example in Google Chat apps, see [Text paragraph](https://developers.google.com/chat/ui/widgets/text-paragraph). For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ export interface Schema$GoogleAppsCardV1TextParagraph { /** @@ -1266,7 +1266,7 @@ export namespace chat_v1 { */ textInput?: Schema$GoogleAppsCardV1TextInput; /** - * Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" \} ``` + * Displays a text paragraph. Supports simple HTML formatted text. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). For example, the following JSON creates a bolded text: ``` "textParagraph": { "text": " *bold text*" \} ``` */ textParagraph?: Schema$GoogleAppsCardV1TextParagraph; } @@ -1376,7 +1376,7 @@ export namespace chat_v1 { */ export interface Schema$KeyValue { /** - * The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * The text of the bottom label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ bottomLabel?: string | null; /** @@ -1384,7 +1384,7 @@ export namespace chat_v1 { */ button?: Schema$Button; /** - * The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * The text of the content. Formatted text supported and always required. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ content?: string | null; /** @@ -1404,7 +1404,7 @@ export namespace chat_v1 { */ onClick?: Schema$OnClick; /** - * The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * The text of the top label. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ topLabel?: string | null; } @@ -1483,7 +1483,7 @@ export namespace chat_v1 { */ name?: string | null; /** - * Output only. User's role within a Chat space, which determines their permitted actions in the space. + * Optional. User's role within a Chat space, which determines their permitted actions in the space. [Developer Preview](https://developers.google.com/workspace/preview): This field can only be used as input in `UpdateMembership`. */ role?: string | null; /** @@ -1547,6 +1547,10 @@ export namespace chat_v1 { * A plain-text description of the message's cards, used when the actual cards can't be displayed—for example, mobile notifications. */ fallbackText?: string | null; + /** + * Output only. Contains the message `text` with markups added to communicate formatting. This field might not capture all formatting visible in the UI, but includes the following: * [Markup syntax](https://developers.google.com/chat/format-messages) for bold, italic, strikethrough, monospace, and monospace block. * [User mentions](https://developers.google.com/chat/format-messages#messages-@mention) using the format ``. * Custom hyperlinks using the format `<{url\}|{rendered_text\}\>` where the first string is the URL and the second is the rendered text—for example, ``. * Custom emoji using the format `:{emoji_name\}:`—for example, `:smile:`. This doesn't apply to Unicode emoji, such as `U+1F600` for a grinning face emoji. For more information, see [View text formatting sent in a message](https://developers.google.com/chat/format-messages#view_text_formatting_sent_in_a_message) + */ + formattedText?: string | null; /** * Output only. The time at which the message was last edited by a user. If the message has never been edited, this field is empty. */ @@ -1576,7 +1580,7 @@ export namespace chat_v1 { */ space?: Schema$Space; /** - * Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/api/guides/message-formats/text#messages-@mention), or everyone in the space. To learn about creating text messages, see [Create a text message](https://developers.google.com/chat/api/guides/message-formats/text). + * Plain-text body of the message. The first link to an image, video, or web page generates a [preview chip](https://developers.google.com/chat/how-tos/preview-links). You can also [@mention a Google Chat user](https://developers.google.com/chat/format-messages#messages-@mention), or everyone in the space. To learn about creating text messages, see [Send a text message](https://developers.google.com/chat/api/guides/v1/messages/create#create-text-messages). */ text?: string | null; /** @@ -1645,7 +1649,7 @@ export namespace chat_v1 { */ export interface Schema$Section { /** - * The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * The header of the section. Formatted text is supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ header?: string | null; /** @@ -1812,7 +1816,7 @@ export namespace chat_v1 { text?: string | null; } /** - * A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/api/guides/message-formats/cards#card_text_formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). + * A paragraph of text. Formatted text supported. For more information about formatting text, see [Formatting text in Google Chat apps](https://developers.google.com/chat/format-messages#card-formatting) and [Formatting text in Google Workspace Add-ons](https://developers.google.com/apps-script/add-ons/concepts/widgets#text_formatting). */ export interface Schema$TextParagraph { text?: string | null; @@ -2415,7 +2419,7 @@ export namespace chat_v1 { } /** - * Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). [User authentication](https://developers.google.com/chat/api/guides/auth/users). + * Returns details about a space. For an example, see [Get a space](https://developers.google.com/chat/api/guides/v1/spaces/get). Requires [authentication](https://developers.google.com/chat/api/guides/auth). Fully supports [service account authentication](https://developers.google.com/chat/api/guides/auth/service-accounts) and [user authentication](https://developers.google.com/chat/api/guides/auth/users). * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/chromepolicy/v1.ts b/src/apis/chromepolicy/v1.ts index 56ae302b0d..3270757915 100644 --- a/src/apis/chromepolicy/v1.ts +++ b/src/apis/chromepolicy/v1.ts @@ -126,24 +126,6 @@ export namespace chromepolicy_v1 { } } - export interface Schema$ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle { - /** - * In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI. - */ - deprecatedInFavorOf?: string[] | null; - /** - * Description about current life cycle. - */ - description?: string | null; - /** - * End supporting date for current policy. - */ - endSupport?: Schema$GoogleTypeDate; - /** - * Indicate current life cycle stage of the policy API. - */ - policyApiLifecycleStage?: string | null; - } /** * Additional key names that will be used to identify the target of the policy value. */ @@ -424,6 +406,31 @@ export namespace chromepolicy_v1 { */ minimum?: string | null; } + /** + * Lifecycle information. + */ + export interface Schema$GoogleChromePolicyVersionsV1PolicyApiLifecycle { + /** + * In the event that this policy was deprecated in favor of another policy, the fully qualified namespace(s) of the new policies as they will show in PolicyAPI. Could only be set if policy_api_lifecycle_stage is API_DEPRECATED. + */ + deprecatedInFavorOf?: string[] | null; + /** + * Description about current life cycle. + */ + description?: string | null; + /** + * End supporting date for current policy. Attempting to modify a policy after its end support date will result in a Bad Request (400 error). Could only be set if policy_api_lifecycle_stage is API_DEPRECATED. + */ + endSupport?: Schema$GoogleTypeDate; + /** + * Indicates current life cycle stage of the policy API. + */ + policyApiLifecycleStage?: string | null; + /** + * Corresponding to deprecated_in_favor_of, the fully qualified namespace(s) of the old policies that will be deprecated because of introduction of this policy. This field should not be manually set but will be set and exposed through PolicyAPI automatically. + */ + scheduledToDeprecatePolicies?: string[] | null; + } /** * Error information for a modification request of a specific policy on a specific target. */ @@ -502,7 +509,7 @@ export namespace chromepolicy_v1 { /** * Output only. Current lifecycle information. */ - policyApiLifecycle?: Schema$ChromeCrosDpanelAutosettingsProtoPolicyApiLifecycle; + policyApiLifecycle?: Schema$GoogleChromePolicyVersionsV1PolicyApiLifecycle; /** * Output only. Description about the policy schema for user consumption. */ @@ -878,9 +885,9 @@ export namespace chromepolicy_v1 { */ export interface Schema$Proto2FileDescriptorProto { /** - * The edition of the proto file. + * BEGIN GOOGLE-INTERNAL TODO(b/297898292) Deprecate and remove this field in favor of enums. END GOOGLE-INTERNAL */ - editionEnum?: string | null; + editionDeprecated?: string | null; enumType?: Schema$Proto2EnumDescriptorProto[]; /** * All top-level definitions in this file. diff --git a/src/apis/cloudasset/v1.ts b/src/apis/cloudasset/v1.ts index 2379dcfb14..0f7d14a9a6 100644 --- a/src/apis/cloudasset/v1.ts +++ b/src/apis/cloudasset/v1.ts @@ -511,6 +511,19 @@ export namespace cloudasset_v1 { */ policies?: Schema$PolicyInfo[]; } + /** + * The effective tags and the ancestor resources from which they were inherited. + */ + export interface Schema$EffectiveTagDetails { + /** + * The [full resource name](https://cloud.google.com/asset-inventory/docs/resource-name-format) of the ancestor from which an effective_tag is inherited, according to [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance). + */ + attachedResource?: string | null; + /** + * The effective tags inherited from the attached_resource. Note that tags with the same key but different values may attach to resources at a different hierarchy levels. The lower hierarchy tag value will overwrite the higher hierarchy tag value of the same tag key. In this case, the tag value at the higher hierarchy level will be removed. For more information, see [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance). + */ + effectiveTags?: Schema$Tag[]; + } /** * 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); \} */ @@ -2254,6 +2267,10 @@ export namespace cloudasset_v1 { * The display name of this resource. This field is available only when the resource's Protobuf contains it. To search against the `display_name`: * Use a field query. Example: `displayName:"My Instance"` * Use a free text query. Example: `"My Instance"` */ displayName?: string | null; + /** + * The effective tags on this resource. All of the tags that are both attached to and inherited by a resource are collectively called the effective tags. For more information, see [tag inheritance](https://cloud.google.com/resource-manager/docs/tags/tags-overview#inheritance). To search against the `effective_tags`: * Use a field query. Example: - `effectiveTagKeys:"123456789/env*"` - `effectiveTagKeys="123456789/env"` - `effectiveTagKeys:"env"` - `effectiveTagValues:"env"` - `effectiveTagValues:"env/prod"` - `effectiveTagValues:"123456789/env/prod*"` - `effectiveTagValues="123456789/env/prod"` - `effectiveTagValueIds="tagValues/456"` + */ + effectiveTags?: Schema$EffectiveTagDetails[]; /** * The folder(s) that this resource belongs to, in the form of folders/{FOLDER_NUMBER\}. This field is available when the resource belongs to one or more folders. To search against `folders`: * Use a field query. Example: `folders:(123 OR 456)` * Use a free text query. Example: `123` * Specify the `scope` field as this folder in your search request. */ @@ -2311,15 +2328,19 @@ export namespace cloudasset_v1 { */ state?: string | null; /** - * TagKey namespaced names, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}. To search against the `tagKeys`: * Use a field query. Example: - `tagKeys:"123456789/env*"` - `tagKeys="123456789/env"` - `tagKeys:"env"` * Use a free text query. Example: - `env` + * This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagKey namespaced names, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}. To search against the `tagKeys`: * Use a field query. Example: - `tagKeys:"123456789/env*"` - `tagKeys="123456789/env"` - `tagKeys:"env"` * Use a free text query. Example: - `env` */ tagKeys?: string[] | null; /** - * TagValue IDs, in the format of tagValues/{TAG_VALUE_ID\}. To search against the `tagValueIds`: * Use a field query. Example: - `tagValueIds="tagValues/456"` + * The tags directly attached to this resource. To search against the `tags`: * Use a field query. Example: - `tagKeys:"123456789/env*"` - `tagKeys="123456789/env"` - `tagKeys:"env"` - `tagValues:"env"` - `tagValues:"env/prod"` - `tagValues:"123456789/env/prod*"` - `tagValues="123456789/env/prod"` - `tagValueIds="tagValues/456"` * Use a free text query. Example: - `env/prod` + */ + tags?: Schema$Tag[]; + /** + * This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagValue IDs, in the format of tagValues/{TAG_VALUE_ID\}. To search against the `tagValueIds`: * Use a field query. Example: - `tagValueIds="tagValues/456"` * Use a free text query. Example: - `456` */ tagValueIds?: string[] | null; /** - * TagValue namespaced names, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}/{TAG_VALUE_SHORT_NAME\}. To search against the `tagValues`: * Use a field query. Example: - `tagValues:"env"` - `tagValues:"env/prod"` - `tagValues:"123456789/env/prod*"` - `tagValues="123456789/env/prod"` * Use a free text query. Example: - `prod` + * This field is only present for the purpose of backward compatibility. Please use the `tags` field instead. TagValue namespaced names, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}/{TAG_VALUE_SHORT_NAME\}. To search against the `tagValues`: * Use a field query. Example: - `tagValues:"env"` - `tagValues:"env/prod"` - `tagValues:"123456789/env/prod*"` - `tagValues="123456789/env/prod"` * Use a free text query. Example: - `prod` */ tagValues?: string[] | null; /** @@ -2491,6 +2512,23 @@ export namespace cloudasset_v1 { */ fields?: Schema$TableFieldSchema[]; } + /** + * The key and value for a [tag](https://cloud.google.com/resource-manager/docs/tags/tags-overview), + */ + export interface Schema$Tag { + /** + * TagKey namespaced name, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}. + */ + tagKey?: string | null; + /** + * TagValue namespaced name, in the format of {ORG_ID\}/{TAG_KEY_SHORT_NAME\}/{TAG_VALUE_SHORT_NAME\}. + */ + tagValue?: string | null; + /** + * TagValue ID, in the format of tagValues/{TAG_VALUE_ID\}. + */ + tagValueId?: string | null; + } /** * An asset in Google Cloud and its temporal metadata, including the time window when it was observed and its status during that window. */ @@ -5271,7 +5309,7 @@ export namespace cloudasset_v1 { */ assetTypes?: string[]; /** - * Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only singular primitive fields in the response are sortable: * name * assetType * project * displayName * description * location * createTime * updateTime * state * parentFullResourceName * parentAssetType All the other fields such as repeated fields (e.g., `networkTags`, `kmsKeys`), map fields (e.g., `labels`) and struct fields (e.g., `additionalAttributes`) are not supported. + * Optional. A comma-separated list of fields specifying the sorting order of the results. The default order is ascending. Add " DESC" after the field name to indicate descending order. Redundant space characters are ignored. Example: "location DESC, name". Only the following fields in the response are sortable: * name * assetType * project * displayName * description * location * createTime * updateTime * state * parentFullResourceName * parentAssetType */ orderBy?: string; /** @@ -5283,11 +5321,11 @@ export namespace cloudasset_v1 { */ pageToken?: string; /** - * Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Google Cloud resources whose name contains "Important" as a word. * `name=Important` to find the Google Cloud resource whose name is exactly "Important". * `displayName:Impor*` to find Google Cloud resources whose display name contains "Impor" as a prefix of any word in the field. * `location:us-west*` to find Google Cloud resources whose location contains both "us" and "west" as prefixes. * `labels:prod` to find Google Cloud resources whose labels contain "prod" as a key or value. * `labels.env:prod` to find Google Cloud resources that have a label "env" and its value is "prod". * `labels.env:*` to find Google Cloud resources that have a label "env". * `kmsKey:key` to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains "key" as a word. This field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key information. * `kmsKeys:key` to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word "key". * `relationships:instance-group-1` to find Google Cloud resources that have relationships with "instance-group-1" in the related resource name. * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances that have relationships of type "INSTANCE_TO_INSTANCEGROUP". * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute Engine instances that have relationships with "instance-group-1" in the Compute Engine instance group resource name, for relationship type "INSTANCE_TO_INSTANCEGROUP". * `state:ACTIVE` to find Google Cloud resources whose state contains "ACTIVE" as a word. * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't contain "ACTIVE" as a word. * `createTime<1609459200` to find Google Cloud resources that were created before "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `updateTime\>1609459200` to find Google Cloud resources that were updated after "2021-01-01 00:00:00 UTC". 1609459200 is the epoch timestamp of "2021-01-01 00:00:00 UTC" in seconds. * `Important` to find Google Cloud resources that contain "Important" as a word in any of the searchable fields. * `Impor*` to find Google Cloud resources that contain "Impor" as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Google Cloud resources that contain "Important" as a word in any of the searchable fields and are also located in the "us-west1" region or the "global" location. + * Optional. The query statement. See [how to construct a query](https://cloud.google.com/asset-inventory/docs/searching-resources#how_to_construct_a_query) for more information. If not specified or empty, it will search all the resources within the specified `scope`. Examples: * `name:Important` to find Google Cloud resources whose name contains `Important` as a word. * `name=Important` to find the Google Cloud resource whose name is exactly `Important`. * `displayName:Impor*` to find Google Cloud resources whose display name contains `Impor` as a prefix of any word in the field. * `location:us-west*` to find Google Cloud resources whose location contains both `us` and `west` as prefixes. * `labels:prod` to find Google Cloud resources whose labels contain `prod` as a key or value. * `labels.env:prod` to find Google Cloud resources that have a label `env` and its value is `prod`. * `labels.env:*` to find Google Cloud resources that have a label `env`. * `tagKeys:env` to find Google Cloud resources that have directly attached tags where the [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName` contains `env`. * `tagValues:prod*` to find Google Cloud resources that have directly attached tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName` contains a word prefixed by `prod`. * `tagValueIds=tagValues/123` to find Google Cloud resources that have directly attached tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly `tagValues/123`. * `effectiveTagKeys:env` to find Google Cloud resources that have directly attached or inherited tags where the [`TagKey`](https://cloud.google.com/resource-manager/reference/rest/v3/tagKeys#resource:-tagkey) .`namespacedName` contains `env`. * `effectiveTagValues:prod*` to find Google Cloud resources that have directly attached or inherited tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`namespacedName` contains a word prefixed by `prod`. * `effectiveTagValueIds=tagValues/123` to find Google Cloud resources that have directly attached or inherited tags where the [`TagValue`](https://cloud.google.com/resource-manager/reference/rest/v3/tagValues#resource:-tagvalue) .`name` is exactly `tagValues/123`. * `kmsKey:key` to find Google Cloud resources encrypted with a customer-managed encryption key whose name contains `key` as a word. This field is deprecated. Please use the `kmsKeys` field to retrieve Cloud KMS key information. * `kmsKeys:key` to find Google Cloud resources encrypted with customer-managed encryption keys whose name contains the word `key`. * `relationships:instance-group-1` to find Google Cloud resources that have relationships with `instance-group-1` in the related resource name. * `relationships:INSTANCE_TO_INSTANCEGROUP` to find Compute Engine instances that have relationships of type `INSTANCE_TO_INSTANCEGROUP`. * `relationships.INSTANCE_TO_INSTANCEGROUP:instance-group-1` to find Compute Engine instances that have relationships with `instance-group-1` in the Compute Engine instance group resource name, for relationship type `INSTANCE_TO_INSTANCEGROUP`. * `sccSecurityMarks.key=value` to find Cloud resources that are attached with security marks whose key is `key` and value is `value'. * `sccSecurityMarks.key:*` to find Cloud resources that are attached with security marks whose key is `key`. * `state:ACTIVE` to find Google Cloud resources whose state contains `ACTIVE` as a word. * `NOT state:ACTIVE` to find Google Cloud resources whose state doesn't contain `ACTIVE` as a word. * `createTime<1609459200` to find Google Cloud resources that were created before `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of `2021-01-01 00:00:00 UTC` in seconds. * `updateTime\>1609459200` to find Google Cloud resources that were updated after `2021-01-01 00:00:00 UTC`. `1609459200` is the epoch timestamp of `2021-01-01 00:00:00 UTC` in seconds. * `Important` to find Google Cloud resources that contain `Important` as a word in any of the searchable fields. * `Impor*` to find Google Cloud resources that contain `Impor` as a prefix of any word in any of the searchable fields. * `Important location:(us-west1 OR global)` to find Google Cloud resources that contain `Important` as a word in any of the searchable fields and are also located in the `us-west1` region or the `global` location. */ query?: string; /** - * Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * `name` * `assetType` * `project` * `folders` * `organization` * `displayName` * `description` * `location` * `labels` * `networkTags` * `kmsKeys` * `createTime` * `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` * `parentAssetType` Some fields of large size, such as `versionedResources` and `attachedResources`, are not returned by default, but you can specify them in the `read_mask` parameter if you want to include them. If `"*"` is specified, all [available fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are returned. Examples: `"name,location"`, `"name,versionedResources"`, `"*"`. Any invalid field path will trigger INVALID_ARGUMENT error. + * Optional. A comma-separated list of fields that you want returned in the results. The following fields are returned by default if not specified: * `name` * `assetType` * `project` * `folders` * `organization` * `displayName` * `description` * `location` * `labels` * `tags` * `effectiveTags` * `networkTags` * `kmsKeys` * `createTime` * `updateTime` * `state` * `additionalAttributes` * `parentFullResourceName` * `parentAssetType` Some fields of large size, such as `versionedResources`, `attachedResources`, `effectiveTags` etc., are not returned by default, but you can specify them in the `read_mask` parameter if you want to include them. If `"*"` is specified, all [available fields](https://cloud.google.com/asset-inventory/docs/reference/rest/v1/TopLevel/searchAllResources#resourcesearchresult) are returned. Examples: `"name,location"`, `"name,versionedResources"`, `"*"`. Any invalid field path will trigger INVALID_ARGUMENT error. */ readMask?: string; /** diff --git a/src/apis/cloudbuild/v1.ts b/src/apis/cloudbuild/v1.ts index bc0f349f47..5050ad2b97 100644 --- a/src/apis/cloudbuild/v1.ts +++ b/src/apis/cloudbuild/v1.ts @@ -328,6 +328,10 @@ export namespace cloudbuild_v1 { * Optional. The network to be used when reaching out to the Bitbucket Server instance. The VPC network must be enabled for private service connection. This should be set if the Bitbucket Server instance is hosted on-premises and not reachable by public internet. If this field is left empty, no network peering will occur and calls to the Bitbucket Server instance will be made over the public internet. Must be in the format `projects/{project\}/global/networks/{network\}`, where {project\} is a project number or id and {network\} is the name of a VPC network in the project. */ peeredNetwork?: string | null; + /** + * Immutable. IP range within the peered network. This is specified in CIDR notation with a slash and the subnet prefix size. You can optionally specify an IP address before the subnet prefix value. e.g. `192.168.0.0/29` would specify an IP range starting at 192.168.0.0 with a 29 bit prefix size. `/16` would specify a prefix size of 16 bits, with an automatically determined IP within the peered VPC. If unspecified, a value of `/24` will be used. The field only has an effect if peered_network is set. + */ + peeredNetworkIpRange?: string | null; /** * Required. Secret Manager secrets needed by the config. */ @@ -2031,6 +2035,14 @@ export namespace cloudbuild_v1 { * Output only. Hash(es) of the build source, which can be used to verify that the original source integrity was maintained in the build. Note that `FileHashes` will only be populated if `BuildOptions` has requested a `SourceProvenanceHash`. The keys to this map are file paths used as build source and the values contain the hash values for those files. If the build source came in a single package such as a gzipped tarfile (`.tar.gz`), the `FileHash` will be for the single path to that file. */ fileHashes?: {[key: string]: Schema$FileHashes} | null; + /** + * Output only. A copy of the build's `source.connected_repository`, if exists, with any revisions resolved. + */ + resolvedConnectedRepository?: Schema$ConnectedRepository; + /** + * Output only. A copy of the build's `source.git_source`, if exists, with any revisions resolved. + */ + resolvedGitSource?: Schema$GitSource; /** * A copy of the build's `source.repo_source`, if exists, with any revisions resolved. */ diff --git a/src/apis/cloudsupport/v2.ts b/src/apis/cloudsupport/v2.ts index 4f658d99f0..660774816b 100644 --- a/src/apis/cloudsupport/v2.ts +++ b/src/apis/cloudsupport/v2.ts @@ -1541,7 +1541,7 @@ export namespace cloudsupport_v2 { */ parent?: string; /** - * An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify either `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` restricted 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)` + * An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `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` restricted 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; } diff --git a/src/apis/cloudsupport/v2beta.ts b/src/apis/cloudsupport/v2beta.ts index 8551f81637..1338888050 100644 --- a/src/apis/cloudsupport/v2beta.ts +++ b/src/apis/cloudsupport/v2beta.ts @@ -1548,7 +1548,7 @@ export namespace cloudsupport_v2beta { */ parent?: string; /** - * An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. - `billingAccount`: A billing account in the form `billingAccounts/` You must specify either `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` restricted 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)` + * An expression used to filter cases. Expressions use the following fields separated by `AND` and specified with `=`: - `organization`: An organization name in the form `organizations/`. - `project`: A project name in the form `projects/`. - `state`: Can be `OPEN` or `CLOSED`. - `priority`: Can be `P0`, `P1`, `P2`, `P3`, or `P4`. You can specify multiple values for priority using the `OR` operator. For example, `priority=P1 OR priority=P2`. - `creator.email`: The email address of the case creator. You must specify either `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` restricted 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; } diff --git a/src/apis/cloudtasks/v2beta3.ts b/src/apis/cloudtasks/v2beta3.ts index a171c6bfdc..20a63cad79 100644 --- a/src/apis/cloudtasks/v2beta3.ts +++ b/src/apis/cloudtasks/v2beta3.ts @@ -235,6 +235,19 @@ export namespace cloudtasks_v2beta3 { */ task?: Schema$Task; } + /** + * CMEK, or Customer Managed Encryption Keys, enables GCP products to put control over encryption and key management in their customer’s hands. + */ + export interface Schema$CmekConfig { + /** + * Resource name of the Cloud KMS key, of the form `projects/PROJECT_ID/locations/LOCATION_ID/keyRings/KEY_RING_ID/cryptoKeys/KEY_ID`, that will be used to encrypt the Queues & Tasks in the region. Setting this as blank will turn off CMEK encryption. + */ + kmsKey?: string | null; + /** + * Output only. The config resource name which includes the project and location and must end in 'cmekConfig', in the format projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` + */ + name?: string | null; + } /** * Request message for CreateTask. */ @@ -900,6 +913,90 @@ export namespace cloudtasks_v2beta3 { } } + /** + * Gets the CMEK config. Gets the Customer Managed Encryption Key configured with the Cloud Tasks lcoation. By default there is no kms_key configured. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getCmekConfig( + params?: Params$Resource$Projects$Locations$Getcmekconfig, + options?: MethodOptions + ): GaxiosPromise; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCmekConfig( + params: Params$Resource$Projects$Locations$Getcmekconfig, + callback: BodyResponseCallback + ): void; + getCmekConfig(callback: BodyResponseCallback): void; + getCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Getcmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Getcmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Getcmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtasks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2beta3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Lists information about the supported locations for this service. * @@ -991,6 +1088,93 @@ export namespace cloudtasks_v2beta3 { return createAPIRequest(parameters); } } + + /** + * Creates or Updates a CMEK config. Updates the Customer Managed Encryption Key assotiated with the Cloud Tasks location (Creates if the key does not already exist). All new tasks created in the location will be encrypted at-rest with the KMS-key provided in the config. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateCmekConfig( + params?: Params$Resource$Projects$Locations$Updatecmekconfig, + options?: MethodOptions + ): GaxiosPromise; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateCmekConfig( + params: Params$Resource$Projects$Locations$Updatecmekconfig, + callback: BodyResponseCallback + ): void; + updateCmekConfig(callback: BodyResponseCallback): void; + updateCmekConfig( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Updatecmekconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Updatecmekconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Updatecmekconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://cloudtasks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v2beta3/projects/{projectsId}/locations/{locationsId}/cmekConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['projectsId', 'locationsId'], + pathParams: ['locationsId', 'projectsId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } export interface Params$Resource$Projects$Locations$Get @@ -1000,6 +1184,13 @@ export namespace cloudtasks_v2beta3 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Getcmekconfig + extends StandardParameters { + /** + * Required. The config resource name. For example: projects/PROJECT_ID/locations/LOCATION_ID/cmekConfig` + */ + name?: string; + } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** @@ -1019,6 +1210,26 @@ export namespace cloudtasks_v2beta3 { */ pageToken?: string; } + export interface Params$Resource$Projects$Locations$Updatecmekconfig + extends StandardParameters { + /** + * + */ + locationsId?: string; + /** + * + */ + projectsId?: string; + /** + * List of fields to be updated in this request. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CmekConfig; + } export class Resource$Projects$Locations$Queues { context: APIRequestContext; diff --git a/src/apis/composer/v1.ts b/src/apis/composer/v1.ts index 5ade45c769..feb6b71f34 100644 --- a/src/apis/composer/v1.ts +++ b/src/apis/composer/v1.ts @@ -183,6 +183,10 @@ export namespace composer_v1 { * Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */ machineType?: string | null; + /** + * Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*. + */ + zone?: string | null; } /** * Request to trigger database failover (only for highly resilient environments). @@ -933,7 +937,12 @@ export namespace composer_v1 { /** * The configuration for data storage in the environment. */ - export interface Schema$StorageConfig {} + export interface Schema$StorageConfig { + /** + * Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix. + */ + bucket?: string | null; + } /** * Configuration for resources used by Airflow triggerers. */ diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index c90e4645b4..89aec56d02 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -201,6 +201,10 @@ export namespace composer_v1beta1 { * Optional. Cloud SQL machine type used by Airflow database. It has to be one of: db-n1-standard-2, db-n1-standard-4, db-n1-standard-8 or db-n1-standard-16. If not specified, db-n1-standard-2 will be used. Supported for Cloud Composer environments in versions composer-1.*.*-airflow-*.*.*. */ machineType?: string | null; + /** + * Optional. The Compute Engine zone where the Airflow database is created. If zone is provided, it must be in the region selected for the environment. If zone is not provided, a zone is automatically selected. The zone can only be set during environment creation. Supported for Cloud Composer environments in versions composer-2.*.*-airflow-*.*.*. + */ + zone?: string | null; } /** * Request to trigger database failover (only for highly resilient environments). @@ -963,7 +967,12 @@ export namespace composer_v1beta1 { /** * The configuration for data storage in the environment. */ - export interface Schema$StorageConfig {} + export interface Schema$StorageConfig { + /** + * Optional. The name of the Cloud Storage bucket used by the environment. No `gs://` prefix. + */ + bucket?: string | null; + } /** * Configuration for resources used by Airflow triggerers. */ diff --git a/src/apis/compute/alpha.ts b/src/apis/compute/alpha.ts index 3a89a1cb6a..2ae5d221bc 100644 --- a/src/apis/compute/alpha.ts +++ b/src/apis/compute/alpha.ts @@ -1468,7 +1468,7 @@ export namespace compute_alpha { */ schedule?: string | null; /** - * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty. + * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty. */ timeZone?: string | null; } @@ -1819,7 +1819,7 @@ export namespace compute_alpha { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -4567,7 +4567,7 @@ export namespace compute_alpha { */ autoCreatedReservationsDuration?: Schema$Duration; /** - * Setting for enabling or disabling automatic deletion for auto-created reservation. If omitted or set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. + * Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. */ autoDeleteAutoCreatedReservations?: boolean | null; /** @@ -4977,7 +4977,7 @@ export namespace compute_alpha { type?: string | null; } /** - * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/alpha/healthChecks) * [Regional](/compute/docs/reference/rest/alpha/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview. + * Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/alpha/regionHealthChecks) * [Global](/compute/docs/reference/rest/alpha/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview. */ export interface Schema$HealthCheck { /** @@ -7900,7 +7900,7 @@ export namespace compute_alpha { instanceEncryptionKey?: Schema$CustomerEncryptionKey; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. + * Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/alpha/instanceTemplates) * [Regional](/compute/docs/reference/rest/alpha/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates. */ export interface Schema$InstanceTemplate { /** @@ -8260,7 +8260,7 @@ export namespace compute_alpha { */ adminEnabled?: boolean | null; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. */ availableFeatures?: string[] | null; /** @@ -8324,7 +8324,7 @@ export namespace compute_alpha { */ location?: string | null; /** - * Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + * Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. */ macsec?: Schema$InterconnectMacsec; /** @@ -8356,7 +8356,7 @@ export namespace compute_alpha { */ remoteLocation?: string | null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. */ requestedFeatures?: string[] | null; /** @@ -8958,7 +8958,7 @@ export namespace compute_alpha { region?: string | null; } /** - * Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. + * Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router. */ export interface Schema$InterconnectMacsec { /** @@ -8966,7 +8966,7 @@ export namespace compute_alpha { */ failOpen?: boolean | null; /** - * Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + * Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. */ preSharedKeys?: Schema$InterconnectMacsecPreSharedKey[]; } @@ -9950,6 +9950,10 @@ export namespace compute_alpha { * [Output Only] Preserved state generated based on stateful policy for this instance. */ preservedStateFromPolicy?: Schema$PreservedState; + /** + * [Output Only] Instance properties selected for this instance resulting from InstanceFlexibilityPolicy. + */ + propertiesFromFlexibilityPolicy?: Schema$ManagedInstancePropertiesFromFlexibilityPolicy; /** * [Output Only] Tag describing the version. */ @@ -10011,6 +10015,12 @@ export namespace compute_alpha { }>; } | null; } + export interface Schema$ManagedInstancePropertiesFromFlexibilityPolicy { + /** + * The machine type to be used for this instance. + */ + machineType?: string | null; + } export interface Schema$ManagedInstanceVersion { /** * [Output Only] The intended template of the instance. This field is empty when current_action is one of { DELETING, ABANDONING \}. @@ -11073,6 +11083,10 @@ export namespace compute_alpha { * The BGP best path selection algorithm to be employed within this network for dynamic routes learned by Cloud Routers. Can be LEGACY (default) or STANDARD. */ bgpBestPathSelectionMode?: string | null; + /** + * Allows to define a preferred approach for handling inter-region cost in the selection process when using the STANDARD BGP best path selection algorithm. Can be DEFAULT or ADD_COST_TO_MED. + */ + bgpInterRegionCost?: string | null; /** * The network-wide routing mode to use. If set to REGIONAL, this network's Cloud Routers will only advertise routes with subnets of this network in the same region as the router. If set to GLOBAL, this network's Cloud Routers will advertise routes with all subnets of this network, across regions. */ @@ -16611,12 +16625,16 @@ export namespace compute_alpha { * The URL of a forwarding rule with loadBalancingScheme INTERNAL* that is serving the endpoint identified by this service attachment. */ producerForwardingRule?: string | null; + /** + * The number of VPCs to which this endpoint is allowed to be propagated per accept list resource (project or network). For ACCEPT_AUTOMATIC service attachment, this limit is default to per project. + */ + propagatedConnectionLimit?: number | null; /** * [Output Only] An 128-bit global unique ID of the PSC service attachment. */ pscServiceAttachmentId?: Schema$Uint128; /** - * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. + * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false. */ reconcileConnections?: boolean | null; /** @@ -17705,6 +17723,10 @@ export namespace compute_alpha { * Represents a zonal storage pool resource. */ export interface Schema$StoragePool { + /** + * Provisioning type of the byte capacity of the pool. + */ + capacityProvisioningType?: string | null; /** * [Output Only] Creation timestamp in RFC3339 text format. */ @@ -17733,6 +17755,10 @@ export namespace compute_alpha { * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ name?: string | null; + /** + * Provisioning type of the performance-related parameters of the pool, such as throughput and IOPS. + */ + performanceProvisioningType?: string | null; /** * Provsioned IOPS of the storage pool. */ @@ -18514,7 +18540,7 @@ export namespace compute_alpha { } | null; } /** - * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/alpha/targetHttpProxies) * [Regional](/compute/docs/reference/rest/alpha/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. */ export interface Schema$TargetHttpProxy { /** @@ -19693,7 +19719,7 @@ export namespace compute_alpha { latestWindowStartTime?: string | null; maintenanceStatus?: string | null; /** - * [Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. + * [Output Only] The start time window of the maintenance disruption. DEPRECATED: Use window_start_time instead. TimeWindow is a container for two strings that represent timestamps in "yyyy-MM-dd'T'HH:mm:ssZ" text format. */ startTimeWindow?: Schema$UpcomingMaintenanceTimeWindow; /** @@ -19714,7 +19740,7 @@ export namespace compute_alpha { windowStartTime?: string | null; } /** - * Represents a window of time using two timestamps: `earliest` and `latest`. This timestamp values are in RFC3339 text format. + * Represents a window of time using two timestamps: `earliest` and `latest`. */ export interface Schema$UpcomingMaintenanceTimeWindow { earliest?: string | null; @@ -21076,6 +21102,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Acceleratortypes$Get extends StandardParameters { @@ -21865,6 +21895,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Addresses$Delete extends StandardParameters { /** @@ -22760,6 +22794,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Autoscalers$Delete extends StandardParameters { @@ -25676,6 +25714,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Backendservices$Delete extends StandardParameters { @@ -27572,6 +27614,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disks$Bulkinsert extends StandardParameters { /** @@ -28446,6 +28492,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disktypes$Get extends StandardParameters { /** @@ -32570,6 +32620,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Forwardingrules$Delete extends StandardParameters { @@ -33416,6 +33470,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Futurereservations$Cancel extends StandardParameters { @@ -36516,6 +36574,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Globaloperations$Delete extends StandardParameters { @@ -38179,6 +38241,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Healthchecks$Delete extends StandardParameters { @@ -44254,6 +44320,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances extends StandardParameters { @@ -45844,6 +45914,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroups$Delete extends StandardParameters { @@ -50808,6 +50882,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instances$Attachdisk extends StandardParameters { @@ -52933,6 +53011,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancetemplates$Delete extends StandardParameters { @@ -53985,6 +54067,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instantsnapshots$Delete extends StandardParameters { @@ -55115,6 +55201,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Interconnectattachments$Delete extends StandardParameters { @@ -59362,6 +59452,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** @@ -60253,6 +60347,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkattachments$Delete extends StandardParameters { @@ -60912,6 +61010,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkedgesecurityservices$Delete extends StandardParameters { @@ -61866,6 +61968,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints extends StandardParameters { @@ -66834,6 +66940,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodegroups$Delete extends StandardParameters { @@ -67883,6 +67993,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetemplates$Delete extends StandardParameters { @@ -68331,6 +68445,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** @@ -70601,6 +70719,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Packetmirrorings$Delete extends StandardParameters { @@ -73791,6 +73913,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Publicdelegatedprefixes$Announce extends StandardParameters { @@ -76902,6 +77028,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Regioncommitments$Calculatecancellationfee extends StandardParameters { @@ -80865,6 +80995,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Regionhealthcheckservices$Delete extends StandardParameters { @@ -89659,6 +89793,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Regionnotificationendpoints$Delete extends StandardParameters { @@ -97822,6 +97960,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Reservations$Delete extends StandardParameters { @@ -98862,6 +99004,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Resourcepolicies$Delete extends StandardParameters { @@ -100611,6 +100757,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Routers$Delete extends StandardParameters { /** @@ -102753,6 +102903,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Securitypolicies$Delete extends StandardParameters { @@ -103817,6 +103971,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Serviceattachments$Delete extends StandardParameters { @@ -105607,6 +105765,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslcertificates$Delete extends StandardParameters { @@ -106446,6 +106608,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslpolicies$Delete extends StandardParameters { @@ -107592,6 +107758,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Storagepools$Delete extends StandardParameters { @@ -108134,6 +108304,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Storagepooltypes$Get extends StandardParameters { @@ -109286,6 +109460,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { @@ -110934,6 +111112,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpproxies$Delete extends StandardParameters { @@ -112163,6 +112345,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpsproxies$Delete extends StandardParameters { @@ -113035,6 +113221,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetinstances$Delete extends StandardParameters { @@ -114401,6 +114591,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetpools$Delete extends StandardParameters { @@ -116451,6 +116645,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targettcpproxies$Delete extends StandardParameters { @@ -117245,6 +117443,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetvpngateways$Delete extends StandardParameters { @@ -118294,6 +118496,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** @@ -119204,6 +119410,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpngateways$Delete extends StandardParameters { @@ -120006,6 +120216,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpntunnels$Delete extends StandardParameters { @@ -121136,6 +121350,10 @@ export namespace compute_alpha { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Zonequeuedresources$Cancel extends StandardParameters { diff --git a/src/apis/compute/beta.ts b/src/apis/compute/beta.ts index 2b3ffd8458..485bf47e1c 100644 --- a/src/apis/compute/beta.ts +++ b/src/apis/compute/beta.ts @@ -1386,7 +1386,7 @@ export namespace compute_beta { */ schedule?: string | null; /** - * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty. + * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty. */ timeZone?: string | null; } @@ -1716,6 +1716,10 @@ export namespace compute_beta { * [Output Only] The unique identifier for the resource. This identifier is defined by the server. */ id?: string | null; + /** + * Specifies preference of traffic to the backend (from the proxy and from the client for proxyless gRPC). The possible values are: - IPV4_ONLY: Only send IPv4 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv4 health-checks are used to check the health of the backends. This is the default setting. - PREFER_IPV6: Prioritize the connection to the endpoints IPv6 address over its IPv4 address (provided there is a healthy IPv6 address). - IPV6_ONLY: Only send IPv6 traffic to the backends of the Backend Service (Instance Group, Managed Instance Group, Network Endpoint Group) regardless of traffic from the client to the proxy. Only IPv6 health-checks are used to check the health of the backends. This field is applicable to either: - Advanced Global External HTTPS Load Balancing (load balancing scheme EXTERNAL_MANAGED), - Regional External HTTPS Load Balancing, - Internal TCP Proxy (load balancing scheme INTERNAL_MANAGED), - Regional Internal HTTPS Load Balancing (load balancing scheme INTERNAL_MANAGED), - Traffic Director with Envoy proxies and proxyless gRPC (load balancing scheme INTERNAL_SELF_MANAGED). + */ + ipAddressSelectionPolicy?: string | null; /** * [Output Only] Type of resource. Always compute#backendService for backend services. */ @@ -1729,7 +1733,7 @@ export namespace compute_beta { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -4235,7 +4239,7 @@ export namespace compute_beta { */ autoCreatedReservationsDuration?: Schema$Duration; /** - * Setting for enabling or disabling automatic deletion for auto-created reservation. If omitted or set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. + * Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false. */ autoDeleteAutoCreatedReservations?: boolean | null; /** @@ -4622,7 +4626,7 @@ export namespace compute_beta { type?: string | null; } /** - * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/beta/healthChecks) * [Regional](/compute/docs/reference/rest/beta/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview. + * Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/beta/regionHealthChecks) * [Global](/compute/docs/reference/rest/beta/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview. */ export interface Schema$HealthCheck { /** @@ -6230,6 +6234,10 @@ export namespace compute_beta { * The service account to be used as credentials for all operations performed by the managed instance group on instances. The service accounts needs all permissions required to create and delete instances. By default, the service account {projectNumber\}@cloudservices.gserviceaccount.com is used. */ serviceAccount?: string | null; + /** + * Standby policy for stopped and suspended instances. + */ + standbyPolicy?: Schema$InstanceGroupManagerStandbyPolicy; /** * Stateful configuration for this Instanced Group Manager */ @@ -6246,6 +6254,14 @@ export namespace compute_beta { * The target number of running instances for this managed instance group. You can reduce this number by using the instanceGroupManager deleteInstances or abandonInstances methods. Resizing the group also changes this number. */ targetSize?: number | null; + /** + * The target number of stopped instances for this managed instance group. This number changes when you: - Stop instance using the stopInstances method or start instances using the startInstances method. - Manually change the targetStoppedSize using the update method. + */ + targetStoppedSize?: number | null; + /** + * The target number of suspended instances for this managed instance group. This number changes when you: - Suspend instance using the suspendInstances method or resume instances using the resumeInstances method. - Manually change the targetSuspendedSize using the update method. + */ + targetSuspendedSize?: number | null; /** * The update policy for this managed instance group. */ @@ -6644,6 +6660,12 @@ export namespace compute_beta { */ targetSize?: number | null; } + export interface Schema$InstanceGroupManagersResumeInstancesRequest { + /** + * The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } export interface Schema$InstanceGroupManagersScopedList { /** * [Output Only] The list of managed instance groups that are contained in the specified project and zone. @@ -6677,6 +6699,39 @@ export namespace compute_beta { */ targetPools?: string[] | null; } + export interface Schema$InstanceGroupManagersStartInstancesRequest { + /** + * The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } + export interface Schema$InstanceGroupManagersStopInstancesRequest { + /** + * If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them. + */ + forceStop?: boolean | null; + /** + * The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } + export interface Schema$InstanceGroupManagersSuspendInstancesRequest { + /** + * If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them. + */ + forceSuspend?: boolean | null; + /** + * The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } + export interface Schema$InstanceGroupManagerStandbyPolicy { + initialDelaySec?: number | null; + /** + * Defines behaviour of using instances from standby pool to resize MIG. + */ + mode?: string | null; + } export interface Schema$InstanceGroupManagerStatus { /** * [Output only] Status of all-instances configuration on the group. @@ -7290,7 +7345,7 @@ export namespace compute_beta { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. + * Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/beta/instanceTemplates) * [Regional](/compute/docs/reference/rest/beta/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates. */ export interface Schema$InstanceTemplate { /** @@ -7614,7 +7669,7 @@ export namespace compute_beta { */ adminEnabled?: boolean | null; /** - * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the interconnect was created on MACsec capable hardware ports. If not present then the interconnect is provisioned on non-MACsec capable ports and MACsec enablement will fail. + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. */ availableFeatures?: string[] | null; /** @@ -7678,7 +7733,7 @@ export namespace compute_beta { */ location?: string | null; /** - * Configuration to enable Media Access Control security (MACsec) on the Interconnect connection between Google and your on-premises router. + * Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. */ macsec?: Schema$InterconnectMacsec; /** @@ -7710,7 +7765,7 @@ export namespace compute_beta { */ remoteLocation?: string | null; /** - * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the interconnect will be created on MACsec capable hardware ports. If not specified, the default value is false, which will allocate non-MACsec capable ports first if available. This parameter can only be provided during interconnect INSERT and cannot be changed using interconnect PATCH. + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. */ requestedFeatures?: string[] | null; /** @@ -8300,7 +8355,7 @@ export namespace compute_beta { region?: string | null; } /** - * Configuration information for enabling Media Access Control security (MACsec) on this Interconnect connection between Google and your on-premises router. + * Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router. */ export interface Schema$InterconnectMacsec { /** @@ -8308,7 +8363,7 @@ export namespace compute_beta { */ failOpen?: boolean | null; /** - * Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK will be generated for each key in the key chain. Google router will automatically pick the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + * Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. */ preSharedKeys?: Schema$InterconnectMacsecPreSharedKey[]; } @@ -9099,6 +9154,10 @@ export namespace compute_beta { * [Output Only] The URL of the instance. The URL can exist even if the instance has not yet been created. */ instance?: string | null; + /** + * [Output Only] The overrides to instance properties resulting from InstanceFlexibilityPolicy. + */ + instanceFlexibilityOverride?: Schema$ManagedInstanceInstanceFlexibilityOverride; /** * [Output Only] Health state of the instance per health-check. */ @@ -9134,6 +9193,12 @@ export namespace compute_beta { */ revision?: string | null; } + export interface Schema$ManagedInstanceInstanceFlexibilityOverride { + /** + * The machine type to be used for this instance. + */ + machineType?: string | null; + } export interface Schema$ManagedInstanceInstanceHealth { /** * [Output Only] The current detailed instance health state. @@ -10227,6 +10292,10 @@ export namespace compute_beta { * An opaque location hint used to place the Node close to other resources. This field is for use by internal tools that use the public API. The location hint here on the NodeGroup overrides any location_hint present in the NodeTemplate. */ locationHint?: string | null; + /** + * Specifies the frequency of planned maintenance events. The accepted values are: `AS_NEEDED` and `RECURRENT`. + */ + maintenanceInterval?: string | null; /** * Specifies how to handle instances when a node in the group undergoes maintenance. Set to one of: DEFAULT, RESTART_IN_PLACE, or MIGRATE_WITHIN_NODE_GROUP. The default value is DEFAULT. For more information, see Maintenance policies. */ @@ -10402,6 +10471,10 @@ export namespace compute_beta { * Total amount of available resources on the node. */ totalResources?: Schema$InstanceConsumptionInfo; + /** + * [Output Only] The information about an upcoming maintenance event. + */ + upcomingMaintenance?: Schema$UpcomingMaintenance; } export interface Schema$NodeGroupsAddNodesRequest { /** @@ -10445,6 +10518,16 @@ export namespace compute_beta { message?: string; } | null; } + export interface Schema$NodeGroupsPerformMaintenanceRequest { + /** + * [Required] List of nodes affected by the call. + */ + nodes?: string[] | null; + /** + * The start time of the schedule. The timestamp is an RFC3339 string. + */ + startTime?: string | null; + } export interface Schema$NodeGroupsScopedList { /** * [Output Only] A list of node groups contained in this scope. @@ -12312,6 +12395,12 @@ export namespace compute_beta { */ targetSize?: number | null; } + export interface Schema$RegionInstanceGroupManagersResumeInstancesRequest { + /** + * The URLs of one or more instances to resume. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } export interface Schema$RegionInstanceGroupManagersSetAutoHealingRequest { autoHealingPolicies?: Schema$InstanceGroupManagerAutoHealingPolicy[]; } @@ -12331,6 +12420,32 @@ export namespace compute_beta { */ instanceTemplate?: string | null; } + export interface Schema$RegionInstanceGroupManagersStartInstancesRequest { + /** + * The URLs of one or more instances to start. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } + export interface Schema$RegionInstanceGroupManagersStopInstancesRequest { + /** + * If this flag is set to true, the Instance Group Manager will proceed to stop the instances, skipping initialization on them. + */ + forceStop?: boolean | null; + /** + * The URLs of one or more instances to stop. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } + export interface Schema$RegionInstanceGroupManagersSuspendInstancesRequest { + /** + * If this flag is set to true, the Instance Group Manager will proceed to suspend the instances, skipping initialization on them. + */ + forceSuspend?: boolean | null; + /** + * The URLs of one or more instances to suspend. This can be a full URL or a partial URL, such as zones/[ZONE]/instances/[INSTANCE_NAME]. + */ + instances?: string[] | null; + } /** * RegionInstanceGroupManagers.updatePerInstanceConfigs */ @@ -14801,7 +14916,7 @@ export namespace compute_beta { */ pscServiceAttachmentId?: Schema$Uint128; /** - * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. + * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false. */ reconcileConnections?: boolean | null; /** @@ -16180,7 +16295,7 @@ export namespace compute_beta { } | null; } /** - * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/beta/targetHttpProxies) * [Regional](/compute/docs/reference/rest/beta/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. */ export interface Schema$TargetHttpProxy { /** @@ -17247,6 +17362,32 @@ export namespace compute_beta { high?: string | null; low?: string | null; } + /** + * Upcoming Maintenance notification information. + */ + export interface Schema$UpcomingMaintenance { + /** + * Indicates if the maintenance can be customer triggered. + */ + canReschedule?: boolean | null; + /** + * The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format. + */ + latestWindowStartTime?: string | null; + maintenanceStatus?: string | null; + /** + * Defines the type of maintenance. + */ + type?: string | null; + /** + * The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format. + */ + windowEndTime?: string | null; + /** + * The current start time of the maintenance window. This timestamp value is in RFC3339 text format. + */ + windowStartTime?: string | null; + } /** * Represents a URL Map resource. Compute Engine has two URL Map resources: * [Global](/compute/docs/reference/rest/beta/urlMaps) * [Regional](/compute/docs/reference/rest/beta/regionUrlMaps) A URL map resource is a component of certain types of cloud load balancers and Traffic Director: * urlMaps are used by global external Application Load Balancers, classic Application Load Balancers, and cross-region internal Application Load Balancers. * regionUrlMaps are used by internal Application Load Balancers, regional external Application Load Balancers and regional internal Application Load Balancers. For a list of supported URL map features by the load balancer type, see the Load balancing features: Routing and traffic management table. For a list of supported URL map features for Traffic Director, see the Traffic Director features: Routing and traffic management table. This resource defines mappings from hostnames and URL paths to either a backend service or a backend bucket. To use the global urlMaps resource, the backend service must have a loadBalancingScheme of either EXTERNAL or INTERNAL_SELF_MANAGED. To use the regionUrlMaps resource, the backend service must have a loadBalancingScheme of INTERNAL_MANAGED. For more information, read URL Map Concepts. */ @@ -18595,6 +18736,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Acceleratortypes$Get extends StandardParameters { @@ -19384,6 +19529,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Addresses$Delete extends StandardParameters { /** @@ -20279,6 +20428,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Autoscalers$Delete extends StandardParameters { @@ -23193,6 +23346,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Backendservices$Delete extends StandardParameters { @@ -25089,6 +25246,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disks$Bulkinsert extends StandardParameters { /** @@ -25748,6 +25909,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disktypes$Get extends StandardParameters { /** @@ -29872,6 +30037,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Forwardingrules$Delete extends StandardParameters { @@ -30718,6 +30887,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Futurereservations$Cancel extends StandardParameters { @@ -33712,6 +33885,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Globaloperations$Delete extends StandardParameters { @@ -35375,6 +35552,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Healthchecks$Delete extends StandardParameters { @@ -38263,6 +38444,104 @@ export namespace compute_beta { this.context = context; } + /** + * Cancels the specified resize request and removes it from the queue. Cancelled resize request does no longer wait for the resources to be provisioned. Cancel is only possible for requests that are accepted in the queue. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions + ): GaxiosPromise; + cancel( + params?: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options?: MethodOptions + ): GaxiosPromise; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + cancel( + params: Params$Resource$Instancegroupmanagerresizerequests$Cancel, + callback: BodyResponseCallback + ): void; + cancel(callback: BodyResponseCallback): void; + cancel( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagerresizerequests$Cancel + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagerresizerequests$Cancel; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resizeRequests/{resizeRequest}/cancel' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [ + 'project', + 'zone', + 'instanceGroupManager', + 'resizeRequest', + ], + pathParams: [ + 'instanceGroupManager', + 'project', + 'resizeRequest', + 'zone', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified, inactive resize request. Requests that are still active cannot be deleted. Deleting request does not delete instances that were provisioned previously. * @@ -38652,6 +38931,29 @@ export namespace compute_beta { } } + export interface Params$Resource$Instancegroupmanagerresizerequests$Cancel + extends StandardParameters { + /** + * The name of the managed instance group. The name should conform to RFC1035 or be a resource ID. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the resize request to cancel. The name should conform to RFC1035 or be a resource ID. + */ + resizeRequest?: string; + /** + * The name of the zone where the managed instance group is located. The name should conform to RFC1035. + */ + zone?: string; + } export interface Params$Resource$Instancegroupmanagerresizerequests$Delete extends StandardParameters { /** @@ -40384,41 +40686,39 @@ export namespace compute_beta { } /** - * Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead. + * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: StreamMethodOptions ): GaxiosPromise; - setAutoHealingPolicies( - params?: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + resumeInstances( + params?: Params$Resource$Instancegroupmanagers$Resumeinstances, options?: MethodOptions ): GaxiosPromise; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, + resumeInstances( + params: Params$Resource$Instancegroupmanagers$Resumeinstances, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - callback: BodyResponseCallback - ): void; - setAutoHealingPolicies( + resumeInstances(callback: BodyResponseCallback): void; + resumeInstances( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Setautohealingpolicies + | Params$Resource$Instancegroupmanagers$Resumeinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -40431,13 +40731,12 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Instancegroupmanagers$Resumeinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; + params = {} as Params$Resource$Instancegroupmanagers$Resumeinstances; options = {}; } @@ -40452,7 +40751,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -40474,39 +40773,41 @@ export namespace compute_beta { } /** - * Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. + * Motifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use instanceGroupManagers.patch instead. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions ): GaxiosPromise; - setInstanceTemplate( - params?: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + setAutoHealingPolicies( + params?: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options?: MethodOptions ): GaxiosPromise; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + setAutoHealingPolicies( + params: Params$Resource$Instancegroupmanagers$Setautohealingpolicies, callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( paramsOrCallback?: - | Params$Resource$Instancegroupmanagers$Setinstancetemplate + | Params$Resource$Instancegroupmanagers$Setautohealingpolicies | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -40519,13 +40820,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + {} as Params$Resource$Instancegroupmanagers$Setautohealingpolicies; options = {}; } @@ -40540,7 +40841,95 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Specifies the instance template to use when creating new instances in this group. The templates for existing instances in the group do not change unless you run recreateInstances, run applyUpdatesToInstances, or set the group's updatePolicy.type to PROACTIVE. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options: StreamMethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params?: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options?: MethodOptions + ): GaxiosPromise; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setInstanceTemplate( + params: Params$Resource$Instancegroupmanagers$Setinstancetemplate, + callback: BodyResponseCallback + ): void; + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Setinstancetemplate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Instancegroupmanagers$Setinstancetemplate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -40648,6 +41037,267 @@ export namespace compute_beta { } } + /** + * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + options: StreamMethodOptions + ): GaxiosPromise; + startInstances( + params?: Params$Resource$Instancegroupmanagers$Startinstances, + options?: MethodOptions + ): GaxiosPromise; + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + startInstances( + params: Params$Resource$Instancegroupmanagers$Startinstances, + callback: BodyResponseCallback + ): void; + startInstances(callback: BodyResponseCallback): void; + startInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Startinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Startinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Startinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/startInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, + options: StreamMethodOptions + ): GaxiosPromise; + stopInstances( + params?: Params$Resource$Instancegroupmanagers$Stopinstances, + options?: MethodOptions + ): GaxiosPromise; + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + stopInstances( + params: Params$Resource$Instancegroupmanagers$Stopinstances, + callback: BodyResponseCallback + ): void; + stopInstances(callback: BodyResponseCallback): void; + stopInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Stopinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Stopinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Stopinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/stopInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + options: StreamMethodOptions + ): GaxiosPromise; + suspendInstances( + params?: Params$Resource$Instancegroupmanagers$Suspendinstances, + options?: MethodOptions + ): GaxiosPromise; + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + suspendInstances( + params: Params$Resource$Instancegroupmanagers$Suspendinstances, + callback: BodyResponseCallback + ): void; + suspendInstances(callback: BodyResponseCallback): void; + suspendInstances( + paramsOrCallback?: + | Params$Resource$Instancegroupmanagers$Suspendinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Instancegroupmanagers$Suspendinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instancegroupmanagers$Suspendinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns permissions that a caller has on the specified resource. * @@ -40974,6 +41624,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances extends StandardParameters { @@ -41372,6 +42026,30 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersResizeAdvancedRequest; } + export interface Params$Resource$Instancegroupmanagers$Resumeinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersResumeInstancesRequest; + } export interface Params$Resource$Instancegroupmanagers$Setautohealingpolicies extends StandardParameters { /** @@ -41444,6 +42122,78 @@ export namespace compute_beta { */ requestBody?: Schema$InstanceGroupManagersSetTargetPoolsRequest; } + export interface Params$Resource$Instancegroupmanagers$Startinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersStartInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Stopinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersStopInstancesRequest; + } + export interface Params$Resource$Instancegroupmanagers$Suspendinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone where the managed instance group is located. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InstanceGroupManagersSuspendInstancesRequest; + } export interface Params$Resource$Instancegroupmanagers$Testiampermissions extends StandardParameters { /** @@ -42468,6 +43218,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroups$Delete extends StandardParameters { @@ -47167,6 +47921,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instances$Attachdisk extends StandardParameters { @@ -49214,6 +49972,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancetemplates$Delete extends StandardParameters { @@ -50171,6 +50933,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instantsnapshots$Delete extends StandardParameters { @@ -51103,6 +51869,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Interconnectattachments$Delete extends StandardParameters { @@ -54680,6 +55450,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** @@ -55571,6 +56345,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkattachments$Delete extends StandardParameters { @@ -56230,6 +57008,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkedgesecurityservices$Delete extends StandardParameters { @@ -57184,6 +57966,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints extends StandardParameters { @@ -61279,6 +62065,93 @@ export namespace compute_beta { } } + /** + * Perform maintenance on a subset of nodes in the node group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, + options: StreamMethodOptions + ): GaxiosPromise; + performMaintenance( + params?: Params$Resource$Nodegroups$Performmaintenance, + options?: MethodOptions + ): GaxiosPromise; + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + performMaintenance( + params: Params$Resource$Nodegroups$Performmaintenance, + callback: BodyResponseCallback + ): void; + performMaintenance(callback: BodyResponseCallback): void; + performMaintenance( + paramsOrCallback?: + | Params$Resource$Nodegroups$Performmaintenance + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Nodegroups$Performmaintenance; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Nodegroups$Performmaintenance; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/zones/{zone}/nodeGroups/{nodeGroup}/performMaintenance' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'zone', 'nodeGroup'], + pathParams: ['nodeGroup', 'project', 'zone'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Sets the access control policy on the specified resource. Replaces any existing policy. * @@ -61691,6 +62564,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodegroups$Delete extends StandardParameters { @@ -61880,6 +62757,30 @@ export namespace compute_beta { */ requestBody?: Schema$NodeGroup; } + export interface Params$Resource$Nodegroups$Performmaintenance + extends StandardParameters { + /** + * Name of the node group scoping this request. + */ + nodeGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * The name of the zone for this request. + */ + zone?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NodeGroupsPerformMaintenanceRequest; + } export interface Params$Resource$Nodegroups$Setiampolicy extends StandardParameters { /** @@ -62716,6 +63617,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetemplates$Delete extends StandardParameters { @@ -63164,6 +64069,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** @@ -65434,6 +66343,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Packetmirrorings$Delete extends StandardParameters { @@ -68140,6 +69053,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Publicdelegatedprefixes$Delete extends StandardParameters { @@ -71036,6 +71953,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Regioncommitments$Get extends StandardParameters { @@ -76112,39 +77033,392 @@ export namespace compute_beta { } /** - * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Changes the intended size of the managed instance group. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: StreamMethodOptions + ): GaxiosPromise; + resize( + params?: Params$Resource$Regioninstancegroupmanagers$Resize, + options?: MethodOptions + ): GaxiosPromise; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resize( + params: Params$Resource$Regioninstancegroupmanagers$Resize, + callback: BodyResponseCallback + ): void; + resize(callback: BodyResponseCallback): void; + resize( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Resize + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + options: StreamMethodOptions + ): GaxiosPromise; + resizeAdvanced( + params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + options?: MethodOptions + ): GaxiosPromise; + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resizeAdvanced( + params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + callback: BodyResponseCallback + ): void; + resizeAdvanced(callback: BodyResponseCallback): void; + resizeAdvanced( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Flags the specified instances in the managed instance group to be resumed. This method increases the targetSize and decreases the targetSuspendedSize of the managed instance group by the number of instances that you resume. The resumeInstances operation is marked DONE if the resumeInstances request is successful. The underlying actions take additional time. You must separately verify the status of the RESUMING action with the listmanagedinstances method. In this request, you can only specify instances that are suspended. For example, if an instance was previously suspended using the suspendInstances method, it can be resumed using the resumeInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are resumed. You can specify a maximum of 1000 instances with this method per request. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + options: StreamMethodOptions + ): GaxiosPromise; + resumeInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + options?: MethodOptions + ): GaxiosPromise; + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resumeInstances( + params: Params$Resource$Regioninstancegroupmanagers$Resumeinstances, + callback: BodyResponseCallback + ): void; + resumeInstances(callback: BodyResponseCallback): void; + resumeInstances( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Resumeinstances + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Resumeinstances; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resumeInstances' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: StreamMethodOptions + ): GaxiosPromise; + setAutoHealingPolicies( + params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options?: MethodOptions + ): GaxiosPromise; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + callback: BodyResponseCallback + ): void; + setAutoHealingPolicies( + paramsOrCallback?: + | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'instanceGroupManager'], + pathParams: ['instanceGroupManager', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions ): GaxiosPromise; - resize( - params?: Params$Resource$Regioninstancegroupmanagers$Resize, + setInstanceTemplate( + params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options?: MethodOptions ): GaxiosPromise; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resize( - params: Params$Resource$Regioninstancegroupmanagers$Resize, + setInstanceTemplate( + params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, callback: BodyResponseCallback ): void; - resize(callback: BodyResponseCallback): void; - resize( + setInstanceTemplate(callback: BodyResponseCallback): void; + setInstanceTemplate( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resize + | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76157,12 +77431,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resize; + {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Regioninstancegroupmanagers$Resize; + params = + {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; options = {}; } @@ -76177,14 +77452,14 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resize' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, options ), params, - requiredParams: ['project', 'region', 'instanceGroupManager', 'size'], + requiredParams: ['project', 'region', 'instanceGroupManager'], pathParams: ['instanceGroupManager', 'project', 'region'], context: this.context, }; @@ -76199,39 +77474,39 @@ export namespace compute_beta { } /** - * Resizes the regional managed instance group with advanced configuration options like disabling creation retries. This is an extended version of the resize method. If you increase the size, the group creates new instances using the current instance template. If you decrease the size, the group deletes one or more instances. The resize operation is marked DONE if the resize request is successful. The underlying actions take additional time. You must separately verify the status of the creating or deleting actions with the get or listmanagedinstances method. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is removed or deleted. + * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options: StreamMethodOptions ): GaxiosPromise; - resizeAdvanced( - params?: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + setTargetPools( + params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options?: MethodOptions ): GaxiosPromise; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - resizeAdvanced( - params: Params$Resource$Regioninstancegroupmanagers$Resizeadvanced, + setTargetPools( + params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, callback: BodyResponseCallback ): void; - resizeAdvanced(callback: BodyResponseCallback): void; - resizeAdvanced( + setTargetPools(callback: BodyResponseCallback): void; + setTargetPools( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Resizeadvanced + | Params$Resource$Regioninstancegroupmanagers$Settargetpools | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76244,13 +77519,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Resizeadvanced; + {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; options = {}; } @@ -76265,7 +77540,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/resizeAdvanced' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -76287,41 +77562,39 @@ export namespace compute_beta { } /** - * Modifies the autohealing policy for the instances in this managed instance group. [Deprecated] This method is deprecated. Use regionInstanceGroupManagers.patch instead. + * Flags the specified instances in the managed instance group to be started. This method increases the targetSize and decreases the targetStoppedSize of the managed instance group by the number of instances that you start. The startInstances operation is marked DONE if the startInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STARTING action with the listmanagedinstances method. In this request, you can only specify instances that are stopped. For example, if an instance was previously stopped using the stopInstances method, it can be started using the startInstances method. If a health check is attached to the managed instance group, the specified instances will be verified as healthy after they are started. You can specify a maximum of 1000 instances with this method per request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: StreamMethodOptions ): GaxiosPromise; - setAutoHealingPolicies( - params?: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + startInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Startinstances, options?: MethodOptions ): GaxiosPromise; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - params: Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies, + startInstances( + params: Params$Resource$Regioninstancegroupmanagers$Startinstances, callback: BodyResponseCallback ): void; - setAutoHealingPolicies( - callback: BodyResponseCallback - ): void; - setAutoHealingPolicies( + startInstances(callback: BodyResponseCallback): void; + startInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies + | Params$Resource$Regioninstancegroupmanagers$Startinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76334,13 +77607,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {}) as Params$Resource$Regioninstancegroupmanagers$Startinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies; + {} as Params$Resource$Regioninstancegroupmanagers$Startinstances; options = {}; } @@ -76355,7 +77628,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setAutoHealingPolicies' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/startInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -76377,39 +77650,39 @@ export namespace compute_beta { } /** - * Sets the instance template to use when creating new instances or recreating instances in this group. Existing instances are not affected. + * Flags the specified instances in the managed instance group to be immediately stopped. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetStoppedSize of the managed instance group by the number of instances that you stop. The stopInstances operation is marked DONE if the stopInstances request is successful. The underlying actions take additional time. You must separately verify the status of the STOPPING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays stopping the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is stopped. Stopped instances can be started using the startInstances method. You can specify a maximum of 1000 instances with this method per request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: StreamMethodOptions ): GaxiosPromise; - setInstanceTemplate( - params?: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + stopInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options?: MethodOptions ): GaxiosPromise; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setInstanceTemplate( - params: Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate, + stopInstances( + params: Params$Resource$Regioninstancegroupmanagers$Stopinstances, callback: BodyResponseCallback ): void; - setInstanceTemplate(callback: BodyResponseCallback): void; - setInstanceTemplate( + stopInstances(callback: BodyResponseCallback): void; + stopInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate + | Params$Resource$Regioninstancegroupmanagers$Stopinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76422,13 +77695,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {}) as Params$Resource$Regioninstancegroupmanagers$Stopinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Setinstancetemplate; + {} as Params$Resource$Regioninstancegroupmanagers$Stopinstances; options = {}; } @@ -76443,7 +77716,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setInstanceTemplate' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/stopInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -76465,39 +77738,39 @@ export namespace compute_beta { } /** - * Modifies the target pools to which all new instances in this group are assigned. Existing instances in the group are not affected. + * Flags the specified instances in the managed instance group to be immediately suspended. You can only specify instances that are running in this request. This method reduces the targetSize and increases the targetSuspendedSize of the managed instance group by the number of instances that you suspend. The suspendInstances operation is marked DONE if the suspendInstances request is successful. The underlying actions take additional time. You must separately verify the status of the SUSPENDING action with the listmanagedinstances method. If the standbyPolicy.initialDelaySec field is set, the group delays suspension of the instances until initialDelaySec have passed from instance.creationTimestamp (that is, when the instance was created). This delay gives your application time to set itself up and initialize on the instance. If more than initialDelaySec seconds have passed since instance.creationTimestamp when this method is called, there will be zero delay. If the group is part of a backend service that has enabled connection draining, it can take up to 60 seconds after the connection draining duration has elapsed before the VM instance is suspended. Suspended instances can be resumed using the resumeInstances method. You can specify a maximum of 1000 instances with this method per request. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: StreamMethodOptions ): GaxiosPromise; - setTargetPools( - params?: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + suspendInstances( + params?: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options?: MethodOptions ): GaxiosPromise; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - setTargetPools( - params: Params$Resource$Regioninstancegroupmanagers$Settargetpools, + suspendInstances( + params: Params$Resource$Regioninstancegroupmanagers$Suspendinstances, callback: BodyResponseCallback ): void; - setTargetPools(callback: BodyResponseCallback): void; - setTargetPools( + suspendInstances(callback: BodyResponseCallback): void; + suspendInstances( paramsOrCallback?: - | Params$Resource$Regioninstancegroupmanagers$Settargetpools + | Params$Resource$Regioninstancegroupmanagers$Suspendinstances | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -76510,13 +77783,13 @@ export namespace compute_beta { | BodyResponseCallback ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {}) as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; params = - {} as Params$Resource$Regioninstancegroupmanagers$Settargetpools; + {} as Params$Resource$Regioninstancegroupmanagers$Suspendinstances; options = {}; } @@ -76531,7 +77804,7 @@ export namespace compute_beta { { url: ( rootUrl + - '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/setTargetPools' + '/compute/beta/projects/{project}/regions/{region}/instanceGroupManagers/{instanceGroupManager}/suspendInstances' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', }, @@ -77246,6 +78519,30 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersResizeAdvancedRequest; } + export interface Params$Resource$Regioninstancegroupmanagers$Resumeinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersResumeInstancesRequest; + } export interface Params$Resource$Regioninstancegroupmanagers$Setautohealingpolicies extends StandardParameters { /** @@ -77318,6 +78615,78 @@ export namespace compute_beta { */ requestBody?: Schema$RegionInstanceGroupManagersSetTargetPoolsRequest; } + export interface Params$Resource$Regioninstancegroupmanagers$Startinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersStartInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Stopinstances + extends StandardParameters { + /** + * The name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersStopInstancesRequest; + } + export interface Params$Resource$Regioninstancegroupmanagers$Suspendinstances + extends StandardParameters { + /** + * Name of the managed instance group. + */ + instanceGroupManager?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionInstanceGroupManagersSuspendInstancesRequest; + } export interface Params$Resource$Regioninstancegroupmanagers$Testiampermissions extends StandardParameters { /** @@ -89877,6 +91246,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Reservations$Delete extends StandardParameters { @@ -90917,6 +92290,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Resourcepolicies$Delete extends StandardParameters { @@ -92204,6 +93581,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Routers$Delete extends StandardParameters { /** @@ -94188,6 +95569,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Securitypolicies$Delete extends StandardParameters { @@ -95248,6 +96633,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Serviceattachments$Delete extends StandardParameters { @@ -97038,6 +98427,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslcertificates$Delete extends StandardParameters { @@ -97877,6 +99270,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslpolicies$Delete extends StandardParameters { @@ -99113,6 +100510,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { @@ -100761,6 +102162,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpproxies$Delete extends StandardParameters { @@ -101990,6 +103395,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpsproxies$Delete extends StandardParameters { @@ -102862,6 +104271,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetinstances$Delete extends StandardParameters { @@ -104228,6 +105641,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetpools$Delete extends StandardParameters { @@ -106278,6 +107695,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targettcpproxies$Delete extends StandardParameters { @@ -107072,6 +108493,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetvpngateways$Delete extends StandardParameters { @@ -108121,6 +109546,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** @@ -109031,6 +110460,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpngateways$Delete extends StandardParameters { @@ -109832,6 +111265,10 @@ export namespace compute_beta { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpntunnels$Delete extends StandardParameters { diff --git a/src/apis/compute/v1.ts b/src/apis/compute/v1.ts index 69fc0f1fdf..6b290d3579 100644 --- a/src/apis/compute/v1.ts +++ b/src/apis/compute/v1.ts @@ -1283,7 +1283,7 @@ export namespace compute_v1 { */ schedule?: string | null; /** - * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of “UTC” if left empty. + * The time zone to use when interpreting the schedule. The value of this field must be a time zone name from the tz database: https://en.wikipedia.org/wiki/Tz_database. This field is assigned a default value of "UTC" if left empty. */ timeZone?: string | null; } @@ -1622,7 +1622,7 @@ export namespace compute_v1 { */ localityLbPolicies?: Schema$BackendServiceLocalityLoadBalancingPolicyConfig[]; /** - * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. + * The load balancing algorithm used within the scope of the locality. The possible values are: - ROUND_ROBIN: This is a simple policy in which each healthy backend is selected in round robin order. This is the default. - LEAST_REQUEST: An O(1) algorithm which selects two random healthy hosts and picks the host which has fewer active requests. - RING_HASH: The ring/modulo hash load balancer implements consistent hashing to backends. The algorithm has the property that the addition/removal of a host from a set of N hosts only affects 1/N of the requests. - RANDOM: The load balancer selects a random healthy host. - ORIGINAL_DESTINATION: Backend host is selected based on the client connection metadata, i.e., connections are opened to the same address as the destination address of the incoming connection before the connection was redirected to the load balancer. - MAGLEV: used as a drop in replacement for the ring hash load balancer. Maglev is not as stable as ring hash but has faster table lookup build times and host selection times. For more information about Maglev, see https://ai.google/research/pubs/pub44824 This field is applicable to either: - A regional backend service with the service_protocol set to HTTP, HTTPS, or HTTP2, and load_balancing_scheme set to INTERNAL_MANAGED. - A global backend service with the load_balancing_scheme set to INTERNAL_SELF_MANAGED, INTERNAL_MANAGED, or EXTERNAL_MANAGED. If sessionAffinity is not NONE, and this field is not set to MAGLEV or RING_HASH, session affinity settings will not take effect. Only ROUND_ROBIN and RING_HASH are supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. */ localityLbPolicy?: string | null; /** @@ -1690,6 +1690,7 @@ export namespace compute_v1 { * The backend service timeout has a different meaning depending on the type of load balancer. For more information see, Backend service settings. The default is 30 seconds. The full range of timeout values allowed goes from 1 through 2,147,483,647 seconds. This value can be overridden in the PathMatcher configuration of the UrlMap that references this backend service. Not supported when the backend service is referenced by a URL map that is bound to target gRPC proxy that has validateForProxyless field set to true. Instead, use maxStreamDuration. */ timeoutSec?: number | null; + usedBy?: Schema$BackendServiceUsedBy[]; } /** * Contains a list of BackendServicesScopedList. @@ -1909,6 +1910,39 @@ export namespace compute_v1 { message?: string; } | null; } + /** + * Contains a list of usable BackendService resources. + */ + export interface Schema$BackendServiceListUsable { + /** + * [Output Only] Unique identifier for the resource; defined by the server. + */ + id?: string | null; + /** + * A list of BackendService resources. + */ + items?: Schema$BackendService[]; + /** + * [Output Only] Type of resource. Always compute#usableBackendServiceList for lists of usable backend services. + */ + kind?: string | null; + /** + * [Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger than maxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results. + */ + nextPageToken?: string | null; + /** + * [Output Only] Server-defined URL for this resource. + */ + selfLink?: string | null; + /** + * [Output Only] Informational warning message. + */ + warning?: { + code?: string; + data?: Array<{key?: string; value?: string}>; + message?: string; + } | null; + } /** * Container for either a built-in LB policy supported by gRPC or Envoy or a custom one implemented by the end user. */ @@ -1976,6 +2010,9 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$BackendServiceUsedBy { + reference?: string | null; + } export interface Schema$BfdPacket { /** * The Authentication Present bit of the BFD packet. This is specified in section 4.1 of RFC5880 @@ -4113,7 +4150,7 @@ export namespace compute_v1 { type?: string | null; } /** - * Represents a Health Check resource. Google Compute Engine has two Health Check resources: * [Global](/compute/docs/reference/rest/v1/healthChecks) * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) Internal HTTP(S) load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Traffic Director must use global health checks (`compute.v1.healthChecks`). Internal TCP/UDP load balancers can use either regional or global health checks (`compute.v1.regionHealthChecks` or `compute.v1.healthChecks`). External HTTP(S), TCP proxy, and SSL proxy load balancers as well as managed instance group auto-healing must use global health checks (`compute.v1.healthChecks`). Backend service-based network load balancers must use regional health checks (`compute.v1.regionHealthChecks`). Target pool-based network load balancers must use legacy HTTP health checks (`compute.v1.httpHealthChecks`). For more information, see Health checks overview. + * Represents a health check resource. Google Compute Engine has two health check resources: * [Regional](/compute/docs/reference/rest/v1/regionHealthChecks) * [Global](/compute/docs/reference/rest/v1/healthChecks) These health check resources can be used for load balancing and for autohealing VMs in a managed instance group (MIG). **Load balancing** The following load balancer can use either regional or global health check: * Internal TCP/UDP load balancer The following load balancers require regional health check: * Internal HTTP(S) load balancer * Backend service-based network load balancer Traffic Director and the following load balancers require global health check: * External HTTP(S) load balancer * TCP proxy load balancer * SSL proxy load balancer The following load balancer require [legacy HTTP health checks](/compute/docs/reference/rest/v1/httpHealthChecks): * Target pool-based network load balancer **Autohealing in MIGs** The health checks that you use for autohealing VMs in a MIG can be either regional or global. For more information, see Set up an application health check and autohealing. For more information, see Health checks overview. */ export interface Schema$HealthCheck { /** @@ -6448,7 +6485,7 @@ export namespace compute_v1 { disks?: Schema$CustomerEncryptionKeyProtectedDisk[]; } /** - * Represents an Instance Template resource. You can use instance templates to create VM instances and managed instance groups. For more information, read Instance Templates. + * Represents an Instance Template resource. Google Compute Engine has two Instance Template resources: * [Global](/compute/docs/reference/rest/v1/instanceTemplates) * [Regional](/compute/docs/reference/rest/v1/regionInstanceTemplates) You can reuse a global instance template in different regions whereas you can use a regional instance template in a specified region only. If you want to reduce cross-region dependency or achieve data residency, use a regional instance template. To create VMs, managed instance groups, and reservations, you can use either global or regional instance templates. For more information, read Instance Templates. */ export interface Schema$InstanceTemplate { /** @@ -6607,6 +6644,10 @@ export namespace compute_v1 { * Administrative status of the interconnect. When this is set to true, the Interconnect is functional and can carry traffic. When set to false, no packets can be carried over the interconnect and no BGP routes are exchanged over it. By default, the status is set to true. */ adminEnabled?: boolean | null; + /** + * [Output only] List of features available for this Interconnect connection, which can take one of the following values: - MACSEC If present then the Interconnect connection is provisioned on MACsec capable hardware ports. If not present then the Interconnect connection is provisioned on non-MACsec capable ports and MACsec isn't supported and enabling MACsec fails. + */ + availableFeatures?: string[] | null; /** * [Output Only] A list of CircuitInfo objects, that describe the individual circuits in this LAG. */ @@ -6667,6 +6708,14 @@ export namespace compute_v1 { * URL of the InterconnectLocation object that represents where this connection is to be provisioned. */ location?: string | null; + /** + * Configuration that enables Media Access Control security (MACsec) on the Cloud Interconnect connection between Google and your on-premises router. + */ + macsec?: Schema$InterconnectMacsec; + /** + * Enable or disable MACsec on this Interconnect connection. MACsec enablement fails if the MACsec object is not specified. + */ + macsecEnabled?: boolean | null; /** * Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. */ @@ -6691,6 +6740,10 @@ export namespace compute_v1 { * Indicates that this is a Cross-Cloud Interconnect. This field specifies the location outside of Google's network that the interconnect is connected to. */ remoteLocation?: string | null; + /** + * Optional. List of features requested for this Interconnect connection, which can take one of the following values: - MACSEC If specified then the connection is created on MACsec capable hardware ports. If not specified, the default value is false, which allocates non-MACsec capable ports first if available. This parameter can be provided only with Interconnect INSERT. It isn't valid for Interconnect PATCH. + */ + requestedFeatures?: string[] | null; /** * Target number of physical links in the link bundle, as requested by the customer. */ @@ -7087,6 +7140,10 @@ export namespace compute_v1 { */ googleDemarc?: string | null; lacpStatus?: Schema$InterconnectDiagnosticsLinkLACPStatus; + /** + * Describes the status of MACsec encryption on this link. + */ + macsec?: Schema$InterconnectDiagnosticsMacsecStatus; /** * The operational status of the link. */ @@ -7100,6 +7157,19 @@ export namespace compute_v1 { */ transmittingOpticalPower?: Schema$InterconnectDiagnosticsLinkOpticalPower; } + /** + * Describes the status of MACsec encryption on the link. + */ + export interface Schema$InterconnectDiagnosticsMacsecStatus { + /** + * Indicates the Connectivity Association Key Name (CKN) currently being used if MACsec is operational. + */ + ckn?: string | null; + /** + * Indicates whether or not MACsec is operational on this link. + */ + operational?: boolean | null; + } /** * Response to the list request, and contains a list of interconnects. */ @@ -7145,6 +7215,14 @@ export namespace compute_v1 { * [Output Only] Availability zone for this InterconnectLocation. Within a metropolitan area (metro), maintenance will not be simultaneously scheduled in more than one availability zone. Example: "zone1" or "zone2". */ availabilityZone?: string | null; + /** + * [Output only] List of features available at this InterconnectLocation, which can take one of the following values: - MACSEC + */ + availableFeatures?: string[] | null; + /** + * [Output only] List of link types available at this InterconnectLocation, which can take one of the following values: - LINK_TYPE_ETHERNET_10G_LR - LINK_TYPE_ETHERNET_100G_LR + */ + availableLinkTypes?: string[] | null; /** * [Output Only] Metropolitan area designator that indicates which city an interconnect is located. For example: "Chicago, IL", "Amsterdam, Netherlands". */ @@ -7252,6 +7330,62 @@ export namespace compute_v1 { */ region?: string | null; } + /** + * Configuration information for enabling Media Access Control security (MACsec) on this Cloud Interconnect connection between Google and your on-premises router. + */ + export interface Schema$InterconnectMacsec { + /** + * If set to true, the Interconnect connection is configured with a should-secure MACsec security policy, that allows the Google router to fallback to cleartext traffic if the MKA session cannot be established. By default, the Interconnect connection is configured with a must-secure security policy that drops all traffic if the MKA session cannot be established with your router. + */ + failOpen?: boolean | null; + /** + * Required. A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + */ + preSharedKeys?: Schema$InterconnectMacsecPreSharedKey[]; + } + /** + * MACsec configuration information for the Interconnect connection. Contains the generated Connectivity Association Key Name (CKN) and the key (CAK) for this Interconnect connection. + */ + export interface Schema$InterconnectMacsecConfig { + /** + * A keychain placeholder describing a set of named key objects along with their start times. A MACsec CKN/CAK is generated for each key in the key chain. Google router automatically picks the key with the most recent startTime when establishing or re-establishing a MACsec secure link. + */ + preSharedKeys?: Schema$InterconnectMacsecConfigPreSharedKey[]; + } + /** + * Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + */ + export interface Schema$InterconnectMacsecConfigPreSharedKey { + /** + * An auto-generated Connectivity Association Key (CAK) for this key. + */ + cak?: string | null; + /** + * An auto-generated Connectivity Association Key Name (CKN) for this key. + */ + ckn?: string | null; + /** + * User provided name for this pre-shared key. + */ + name?: string | null; + /** + * User provided timestamp on or after which this key is valid. + */ + startTime?: string | null; + } + /** + * Describes a pre-shared key used to setup MACsec in static connectivity association key (CAK) mode. + */ + export interface Schema$InterconnectMacsecPreSharedKey { + /** + * Required. A name for this pre-shared key. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. + */ + name?: string | null; + /** + * A RFC3339 timestamp on or after which the key is valid. startTime can be in the future. If the keychain has a single key, startTime can be omitted. If the keychain has multiple keys, startTime is mandatory for each key. The start times of keys must be in increasing order. The start times of two consecutive keys must be at least 6 hours apart. + */ + startTime?: string | null; + } /** * Description of a planned outage on this Interconnect. */ @@ -7437,6 +7571,16 @@ export namespace compute_v1 { export interface Schema$InterconnectsGetDiagnosticsResponse { result?: Schema$InterconnectDiagnostics; } + /** + * Response for the InterconnectsGetMacsecConfigRequest. + */ + export interface Schema$InterconnectsGetMacsecConfigResponse { + /** + * end_interface: MixerGetResponseWithEtagBuilder + */ + etag?: string | null; + result?: Schema$InterconnectMacsecConfig; + } /** * Represents a License resource. A License represents billing and aggregate usage data for public and marketplace images. *Caution* This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. */ @@ -11175,6 +11319,18 @@ export namespace compute_v1 { message?: string; } | null; } + export interface Schema$RegionNetworkEndpointGroupsAttachEndpointsRequest { + /** + * The list of network endpoints to be attached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } + export interface Schema$RegionNetworkEndpointGroupsDetachEndpointsRequest { + /** + * The list of network endpoints to be detached. + */ + networkEndpoints?: Schema$NetworkEndpoint[]; + } export interface Schema$RegionNetworkFirewallPoliciesGetEffectiveFirewallsResponse { /** * Effective firewalls from firewall policy. @@ -13343,7 +13499,7 @@ export namespace compute_v1 { */ pscServiceAttachmentId?: Schema$Uint128; /** - * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to true. + * This flag determines whether a consumer accept/reject list change can reconcile the statuses of existing ACCEPTED or REJECTED PSC endpoints. - If false, connection policy update will only affect existing PENDING PSC endpoints. Existing ACCEPTED/REJECTED endpoints will remain untouched regardless how the connection policy is modified . - If true, update will affect both PENDING and ACCEPTED/REJECTED PSC endpoints. For example, an ACCEPTED PSC endpoint will be moved to REJECTED if its project is added to the reject list. For newly created service attachment, this boolean defaults to false. */ reconcileConnections?: boolean | null; /** @@ -14568,7 +14724,7 @@ export namespace compute_v1 { } | null; } /** - * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of GCP HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. + * Represents a Target HTTP Proxy resource. Google Compute Engine has two Target HTTP Proxy resources: * [Global](/compute/docs/reference/rest/v1/targetHttpProxies) * [Regional](/compute/docs/reference/rest/v1/regionTargetHttpProxies) A target HTTP proxy is a component of Google Cloud HTTP load balancers. * targetHttpProxies are used by global external Application Load Balancers, classic Application Load Balancers, cross-region internal Application Load Balancers, and Traffic Director. * regionTargetHttpProxies are used by regional internal Application Load Balancers and regional external Application Load Balancers. Forwarding rules reference a target HTTP proxy, and the target proxy then references a URL map. For more information, read Using Target Proxies and Forwarding rule concepts. */ export interface Schema$TargetHttpProxy { /** @@ -16947,6 +17103,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Acceleratortypes$Get extends StandardParameters { @@ -17642,6 +17802,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Addresses$Delete extends StandardParameters { /** @@ -18422,6 +18586,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Autoscalers$Delete extends StandardParameters { @@ -20323,6 +20491,100 @@ export namespace compute_v1 { } } + /** + * Retrieves an aggregated list of all usable backend services in the specified project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listUsable( + params: Params$Resource$Backendservices$Listusable, + options: StreamMethodOptions + ): GaxiosPromise; + listUsable( + params?: Params$Resource$Backendservices$Listusable, + options?: MethodOptions + ): GaxiosPromise; + listUsable( + params: Params$Resource$Backendservices$Listusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Backendservices$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Backendservices$Listusable, + callback: BodyResponseCallback + ): void; + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( + paramsOrCallback?: + | Params$Resource$Backendservices$Listusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Backendservices$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Backendservices$Listusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/backendServices/listUsable' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project'], + pathParams: ['project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Patches the specified BackendService resource with the data included in the request. For more information, see Backend services overview. This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @@ -20811,6 +21073,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Backendservices$Delete extends StandardParameters { @@ -20931,6 +21197,33 @@ export namespace compute_v1 { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Backendservices$Listusable + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + */ + returnPartialSuccess?: boolean; + } export interface Params$Resource$Backendservices$Patch extends StandardParameters { /** @@ -22664,6 +22957,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disks$Bulkinsert extends StandardParameters { /** @@ -23322,6 +23619,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Disktypes$Get extends StandardParameters { /** @@ -27242,6 +27543,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Forwardingrules$Delete extends StandardParameters { @@ -30035,6 +30340,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Globaloperations$Delete extends StandardParameters { @@ -31604,6 +31913,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Healthchecks$Delete extends StandardParameters { @@ -36110,6 +36423,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroupmanagers$Applyupdatestoinstances extends StandardParameters { @@ -37418,6 +37735,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancegroups$Delete extends StandardParameters { @@ -41825,6 +42146,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instances$Attachdisk extends StandardParameters { @@ -43587,6 +43912,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Instancetemplates$Delete extends StandardParameters { @@ -44372,6 +44701,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Interconnectattachments$Delete extends StandardParameters { @@ -45253,6 +45586,102 @@ export namespace compute_v1 { } } + /** + * Returns the interconnectMacsecConfig for the specified Interconnect. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getMacsecConfig( + params?: Params$Resource$Interconnects$Getmacsecconfig, + options?: MethodOptions + ): GaxiosPromise; + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getMacsecConfig( + params: Params$Resource$Interconnects$Getmacsecconfig, + callback: BodyResponseCallback + ): void; + getMacsecConfig( + callback: BodyResponseCallback + ): void; + getMacsecConfig( + paramsOrCallback?: + | Params$Resource$Interconnects$Getmacsecconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Interconnects$Getmacsecconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Interconnects$Getmacsecconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/global/interconnects/{interconnect}/getMacsecConfig' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'interconnect'], + pathParams: ['interconnect', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Creates an Interconnect in the specified project using the data included in the request. * @@ -45637,6 +46066,17 @@ export namespace compute_v1 { */ project?: string; } + export interface Params$Resource$Interconnects$Getmacsecconfig + extends StandardParameters { + /** + * Name of the interconnect resource to query. + */ + interconnect?: string; + /** + * Project ID for this request. + */ + project?: string; + } export interface Params$Resource$Interconnects$Insert extends StandardParameters { /** @@ -47711,6 +48151,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Machinetypes$Get extends StandardParameters { /** @@ -48515,6 +48959,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkattachments$Delete extends StandardParameters { @@ -49150,6 +49598,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkedgesecurityservices$Delete extends StandardParameters { @@ -50104,6 +50556,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Networkendpointgroups$Attachnetworkendpoints extends StandardParameters { @@ -54497,6 +54953,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodegroups$Delete extends StandardParameters { @@ -55522,6 +55982,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetemplates$Delete extends StandardParameters { @@ -55969,6 +56433,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Nodetypes$Get extends StandardParameters { /** @@ -56680,6 +57148,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Packetmirrorings$Delete extends StandardParameters { @@ -59282,6 +59754,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Publicdelegatedprefixes$Delete extends StandardParameters { @@ -60599,6 +61075,100 @@ export namespace compute_v1 { } } + /** + * Retrieves an aggregated list of all usable backend services in the specified project in the given region. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + options: StreamMethodOptions + ): GaxiosPromise; + listUsable( + params?: Params$Resource$Regionbackendservices$Listusable, + options?: MethodOptions + ): GaxiosPromise; + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listUsable( + params: Params$Resource$Regionbackendservices$Listusable, + callback: BodyResponseCallback + ): void; + listUsable( + callback: BodyResponseCallback + ): void; + listUsable( + paramsOrCallback?: + | Params$Resource$Regionbackendservices$Listusable + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionbackendservices$Listusable; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionbackendservices$Listusable; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/backendServices/listUsable' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region'], + pathParams: ['project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Updates the specified regional BackendService resource with the data included in the request. For more information, see Understanding backend services This method supports PATCH semantics and uses the JSON merge patch format and processing rules. * @@ -61072,6 +61642,37 @@ export namespace compute_v1 { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Regionbackendservices$Listusable + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. It must be a string that meets the requirements in RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + */ + returnPartialSuccess?: boolean; + } export interface Params$Resource$Regionbackendservices$Patch extends StandardParameters { /** @@ -61643,6 +62244,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Regioncommitments$Get extends StandardParameters { @@ -68314,6 +68919,96 @@ export namespace compute_v1 { this.context = context; } + /** + * Attach a list of network endpoints to the specified network endpoint group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + options: StreamMethodOptions + ): GaxiosPromise; + attachNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints, + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + attachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/attachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified network endpoint group. Note that the NEG cannot be deleted if it is configured as a backend of a backend service. * @@ -68401,6 +69096,96 @@ export namespace compute_v1 { } } + /** + * Detach the network endpoint from the specified network endpoint group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + options: StreamMethodOptions + ): GaxiosPromise; + detachNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints, + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + callback: BodyResponseCallback + ): void; + detachNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/detachNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the specified network endpoint group. * @@ -68671,8 +69456,129 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Lists the network endpoints in the specified network endpoint group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + options: StreamMethodOptions + ): GaxiosPromise; + listNetworkEndpoints( + params?: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + options?: MethodOptions + ): GaxiosPromise; + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listNetworkEndpoints( + params: Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints, + callback: BodyResponseCallback + ): void; + listNetworkEndpoints( + callback: BodyResponseCallback + ): void; + listNetworkEndpoints( + paramsOrCallback?: + | Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/networkEndpointGroups/{networkEndpointGroup}/listNetworkEndpoints' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'networkEndpointGroup'], + pathParams: ['networkEndpointGroup', 'project', 'region'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } + export interface Params$Resource$Regionnetworkendpointgroups$Attachnetworkendpoints + extends StandardParameters { + /** + * The name of the network endpoint group where you are attaching network endpoints to. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where you want to create the network endpoint group. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionNetworkEndpointGroupsAttachEndpointsRequest; + } export interface Params$Resource$Regionnetworkendpointgroups$Delete extends StandardParameters { /** @@ -68692,6 +69598,30 @@ export namespace compute_v1 { */ requestId?: string; } + export interface Params$Resource$Regionnetworkendpointgroups$Detachnetworkendpoints + extends StandardParameters { + /** + * The name of the network endpoint group you are detaching network endpoints from. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000). end_interface: MixerMutationRequestBuilder + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$RegionNetworkEndpointGroupsDetachEndpointsRequest; + } export interface Params$Resource$Regionnetworkendpointgroups$Get extends StandardParameters { /** @@ -68758,6 +69688,41 @@ export namespace compute_v1 { */ returnPartialSuccess?: boolean; } + export interface Params$Resource$Regionnetworkendpointgroups$Listnetworkendpoints + extends StandardParameters { + /** + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. + */ + filter?: string; + /** + * The maximum number of results per page that should be returned. If the number of available results is larger than `maxResults`, Compute Engine returns a `nextPageToken` that can be used to get the next page of results in subsequent list requests. Acceptable values are `0` to `500`, inclusive. (Default: `500`) + */ + maxResults?: number; + /** + * The name of the network endpoint group from which you want to generate a list of included network endpoints. It should comply with RFC1035. + */ + networkEndpointGroup?: string; + /** + * Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using `orderBy="creationTimestamp desc"`. This sorts results based on the `creationTimestamp` field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by `name` or `creationTimestamp desc` is supported. + */ + orderBy?: string; + /** + * Specifies a page token to use. Set `pageToken` to the `nextPageToken` returned by a previous list request to get the next page of results. + */ + pageToken?: string; + /** + * Project ID for this request. + */ + project?: string; + /** + * The name of the region where the network endpoint group is located. It should comply with RFC1035. + */ + region?: string; + /** + * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. + */ + returnPartialSuccess?: boolean; + } export class Resource$Regionnetworkfirewallpolicies { context: APIRequestContext; @@ -71762,6 +72727,93 @@ export namespace compute_v1 { this.context = context; } + /** + * Inserts a rule into a security policy. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addRule( + params: Params$Resource$Regionsecuritypolicies$Addrule, + options: StreamMethodOptions + ): GaxiosPromise; + addRule( + params?: Params$Resource$Regionsecuritypolicies$Addrule, + options?: MethodOptions + ): GaxiosPromise; + addRule( + params: Params$Resource$Regionsecuritypolicies$Addrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Regionsecuritypolicies$Addrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addRule( + params: Params$Resource$Regionsecuritypolicies$Addrule, + callback: BodyResponseCallback + ): void; + addRule(callback: BodyResponseCallback): void; + addRule( + paramsOrCallback?: + | Params$Resource$Regionsecuritypolicies$Addrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsecuritypolicies$Addrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsecuritypolicies$Addrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/addRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'securityPolicy'], + pathParams: ['project', 'region', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Deletes the specified policy. * @@ -71936,6 +72988,96 @@ export namespace compute_v1 { } } + /** + * Gets a rule at the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getRule( + params: Params$Resource$Regionsecuritypolicies$Getrule, + options: StreamMethodOptions + ): GaxiosPromise; + getRule( + params?: Params$Resource$Regionsecuritypolicies$Getrule, + options?: MethodOptions + ): GaxiosPromise; + getRule( + params: Params$Resource$Regionsecuritypolicies$Getrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Regionsecuritypolicies$Getrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getRule( + params: Params$Resource$Regionsecuritypolicies$Getrule, + callback: BodyResponseCallback + ): void; + getRule(callback: BodyResponseCallback): void; + getRule( + paramsOrCallback?: + | Params$Resource$Regionsecuritypolicies$Getrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsecuritypolicies$Getrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsecuritypolicies$Getrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/getRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['project', 'region', 'securityPolicy'], + pathParams: ['project', 'region', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Creates a new policy in the specified project using the data included in the request. * @@ -72199,8 +73341,206 @@ export namespace compute_v1 { return createAPIRequest(parameters); } } + + /** + * Patches a rule at the specified priority. To clear fields in the rule, leave the fields empty and specify them in the updateMask. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patchRule( + params: Params$Resource$Regionsecuritypolicies$Patchrule, + options: StreamMethodOptions + ): GaxiosPromise; + patchRule( + params?: Params$Resource$Regionsecuritypolicies$Patchrule, + options?: MethodOptions + ): GaxiosPromise; + patchRule( + params: Params$Resource$Regionsecuritypolicies$Patchrule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Regionsecuritypolicies$Patchrule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patchRule( + params: Params$Resource$Regionsecuritypolicies$Patchrule, + callback: BodyResponseCallback + ): void; + patchRule(callback: BodyResponseCallback): void; + patchRule( + paramsOrCallback?: + | Params$Resource$Regionsecuritypolicies$Patchrule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsecuritypolicies$Patchrule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsecuritypolicies$Patchrule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/patchRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'securityPolicy'], + pathParams: ['project', 'region', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a rule at the specified priority. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + removeRule( + params: Params$Resource$Regionsecuritypolicies$Removerule, + options: StreamMethodOptions + ): GaxiosPromise; + removeRule( + params?: Params$Resource$Regionsecuritypolicies$Removerule, + options?: MethodOptions + ): GaxiosPromise; + removeRule( + params: Params$Resource$Regionsecuritypolicies$Removerule, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Regionsecuritypolicies$Removerule, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + removeRule( + params: Params$Resource$Regionsecuritypolicies$Removerule, + callback: BodyResponseCallback + ): void; + removeRule(callback: BodyResponseCallback): void; + removeRule( + paramsOrCallback?: + | Params$Resource$Regionsecuritypolicies$Removerule + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Regionsecuritypolicies$Removerule; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Regionsecuritypolicies$Removerule; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://compute.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/compute/v1/projects/{project}/regions/{region}/securityPolicies/{securityPolicy}/removeRule' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['project', 'region', 'securityPolicy'], + pathParams: ['project', 'region', 'securityPolicy'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } } + export interface Params$Resource$Regionsecuritypolicies$Addrule + extends StandardParameters { + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } export interface Params$Resource$Regionsecuritypolicies$Delete extends StandardParameters { /** @@ -72235,6 +73575,25 @@ export namespace compute_v1 { */ securityPolicy?: string; } + export interface Params$Resource$Regionsecuritypolicies$Getrule + extends StandardParameters { + /** + * The priority of the rule to get from the security policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the security policy to which the queried rule belongs. + */ + securityPolicy?: string; + } export interface Params$Resource$Regionsecuritypolicies$Insert extends StandardParameters { /** @@ -72308,12 +73667,67 @@ export namespace compute_v1 { * Name of the security policy to update. */ securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * Request body metadata */ requestBody?: Schema$SecurityPolicy; } + export interface Params$Resource$Regionsecuritypolicies$Patchrule + extends StandardParameters { + /** + * The priority of the rule to patch. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; + /** + * If true, the request will not be committed. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$SecurityPolicyRule; + } + export interface Params$Resource$Regionsecuritypolicies$Removerule + extends StandardParameters { + /** + * The priority of the rule to remove from the security policy. + */ + priority?: number; + /** + * Project ID for this request. + */ + project?: string; + /** + * Name of the region scoping this request. + */ + region?: string; + /** + * Name of the security policy to update. + */ + securityPolicy?: string; + } export class Resource$Regionsslcertificates { context: APIRequestContext; @@ -76913,6 +78327,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Reservations$Delete extends StandardParameters { @@ -77953,6 +79371,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Resourcepolicies$Delete extends StandardParameters { @@ -79146,6 +80568,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Routers$Delete extends StandardParameters { /** @@ -80904,6 +82330,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Securitypolicies$Delete extends StandardParameters { @@ -81034,6 +82464,10 @@ export namespace compute_v1 { * Name of the security policy to update. */ securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * Request body metadata @@ -81054,6 +82488,10 @@ export namespace compute_v1 { * Name of the security policy to update. */ securityPolicy?: string; + /** + * Indicates fields to be cleared as part of this request. + */ + updateMask?: string; /** * If true, the request will not be committed. */ @@ -81940,6 +83378,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Serviceattachments$Delete extends StandardParameters { @@ -83425,6 +84867,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslcertificates$Delete extends StandardParameters { @@ -84153,6 +85599,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Sslpolicies$Delete extends StandardParameters { @@ -85372,6 +86822,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Subnetworks$Delete extends StandardParameters { @@ -86812,6 +88266,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpproxies$Delete extends StandardParameters { @@ -87931,6 +89389,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targethttpsproxies$Delete extends StandardParameters { @@ -88693,6 +90155,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetinstances$Delete extends StandardParameters { @@ -89944,6 +91410,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetpools$Delete extends StandardParameters { @@ -91766,6 +93236,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targettcpproxies$Delete extends StandardParameters { @@ -92450,6 +93924,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Targetvpngateways$Delete extends StandardParameters { @@ -93381,6 +94859,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Urlmaps$Delete extends StandardParameters { /** @@ -94274,6 +95756,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpngateways$Delete extends StandardParameters { @@ -94981,6 +96467,10 @@ export namespace compute_v1 { * Opt-in for partial success behavior which provides partial results in case of failure. The default value is false. */ returnPartialSuccess?: boolean; + /** + * + */ + serviceProjectNumber?: string; } export interface Params$Resource$Vpntunnels$Delete extends StandardParameters { diff --git a/src/apis/connectors/v1.ts b/src/apis/connectors/v1.ts index 061ff0c9df..5abea682ee 100644 --- a/src/apis/connectors/v1.ts +++ b/src/apis/connectors/v1.ts @@ -548,6 +548,10 @@ export namespace connectors_v1 { * This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version */ export interface Schema$ConnectorInfraConfig { + /** + * The window used for ratelimiting runtime requests to connections. + */ + connectionRatelimitWindowSeconds?: string | null; /** * HPA autoscaling config. */ @@ -659,6 +663,10 @@ export namespace connectors_v1 { * This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version */ export interface Schema$ConnectorVersionInfraConfig { + /** + * Output only. The window used for ratelimiting runtime requests to connections. + */ + connectionRatelimitWindowSeconds?: string | null; /** * Output only. HPA autoscaling config. */ diff --git a/src/apis/contactcenterinsights/v1.ts b/src/apis/contactcenterinsights/v1.ts index c807cb3d0d..31f6f757f0 100644 --- a/src/apis/contactcenterinsights/v1.ts +++ b/src/apis/contactcenterinsights/v1.ts @@ -945,10 +945,6 @@ export namespace contactcenterinsights_v1 { * Response for an export insights operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportInsightsDataResponse {} - /** - * Response from export issue model - */ - export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ExportIssueModelResponse {} /** * Agent Assist frequently-asked-question answer data. */ @@ -995,10 +991,6 @@ export namespace contactcenterinsights_v1 { * The data for a hold annotation. */ export interface Schema$GoogleCloudContactcenterinsightsV1alpha1HoldData {} - /** - * Response from import issue model - */ - export interface Schema$GoogleCloudContactcenterinsightsV1alpha1ImportIssueModelResponse {} /** * The metadata for an IngestConversations operation. */ @@ -1396,6 +1388,15 @@ export namespace contactcenterinsights_v1 { */ reply?: string | null; } + /** + * Speech-to-Text configuration. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1alpha1SpeechConfig { + /** + * The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id\}/locations/{location\}/recognizer/{recognizer\}` + */ + speechRecognizer?: string | null; + } /** * Metadata for undeploying an issue model. */ @@ -1471,6 +1472,10 @@ export namespace contactcenterinsights_v1 { * Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */ redactionConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1RedactionConfig; + /** + * Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings. + */ + speechConfig?: Schema$GoogleCloudContactcenterinsightsV1alpha1SpeechConfig; } /** * The analysis resource. @@ -2374,10 +2379,6 @@ export namespace contactcenterinsights_v1 { * Response for an export insights operation. */ export interface Schema$GoogleCloudContactcenterinsightsV1ExportInsightsDataResponse {} - /** - * Response from export issue model - */ - export interface Schema$GoogleCloudContactcenterinsightsV1ExportIssueModelResponse {} /** * Agent Assist frequently-asked-question answer data. */ @@ -2424,10 +2425,6 @@ export namespace contactcenterinsights_v1 { * The data for a hold annotation. */ export interface Schema$GoogleCloudContactcenterinsightsV1HoldData {} - /** - * Response from import issue model - */ - export interface Schema$GoogleCloudContactcenterinsightsV1ImportIssueModelResponse {} /** * The metadata for an IngestConversations operation. */ @@ -2994,6 +2991,10 @@ export namespace contactcenterinsights_v1 { * Default DLP redaction resources to be applied while ingesting conversations. */ redactionConfig?: Schema$GoogleCloudContactcenterinsightsV1RedactionConfig; + /** + * Optional. Default Speech-to-Text resources to be used while ingesting audio files. Optional, CCAI Insights will create a default if not provided. + */ + speechConfig?: Schema$GoogleCloudContactcenterinsightsV1SpeechConfig; /** * Output only. The time at which the settings were last updated. */ @@ -3062,6 +3063,15 @@ export namespace contactcenterinsights_v1 { */ reply?: string | null; } + /** + * Speech-to-Text configuration. + */ + export interface Schema$GoogleCloudContactcenterinsightsV1SpeechConfig { + /** + * The fully-qualified Speech Recognizer resource name. Format: `projects/{project_id\}/locations/{location\}/recognizer/{recognizer\}` + */ + speechRecognizer?: string | null; + } /** * Metadata for undeploying an issue model. */ @@ -3137,6 +3147,10 @@ export namespace contactcenterinsights_v1 { * Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings. */ redactionConfig?: Schema$GoogleCloudContactcenterinsightsV1RedactionConfig; + /** + * Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings. + */ + speechConfig?: Schema$GoogleCloudContactcenterinsightsV1SpeechConfig; } /** * The View resource. diff --git a/src/apis/container/v1.ts b/src/apis/container/v1.ts index 4d07313dc5..ec0f7ea1ff 100644 --- a/src/apis/container/v1.ts +++ b/src/apis/container/v1.ts @@ -730,6 +730,10 @@ export namespace container_v1 { * Notification configuration of the cluster. */ notificationConfig?: Schema$NotificationConfig; + /** + * The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster. + */ + parentProductConfig?: Schema$ParentProductConfig; /** * Configuration for private cluster. */ @@ -973,6 +977,10 @@ export namespace container_v1 { * The desired notification configuration. */ desiredNotificationConfig?: Schema$NotificationConfig; + /** + * The desired parent product config for the cluster. + */ + desiredParentProductConfig?: Schema$ParentProductConfig; /** * The desired private cluster configuration. */ @@ -1199,11 +1207,11 @@ export namespace container_v1 { */ export interface Schema$Empty {} /** - * EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSD. + * EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. */ export interface Schema$EphemeralStorageLocalSsdConfig { /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1645,11 +1653,11 @@ export namespace container_v1 { subnetworks?: Schema$UsableSubnetwork[]; } /** - * LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSD. + * LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs */ export interface Schema$LocalNvmeSsdBlockConfig { /** - * The number of raw-block local NVMe SSD disks to be attached to the node. Each local SSD is 375 GB in size. If zero, it means no raw-block local NVMe SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -2465,6 +2473,19 @@ export namespace container_v1 { */ status?: string | null; } + /** + * ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster. + */ + export interface Schema$ParentProductConfig { + /** + * Labels contain the configuration of the parent product. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the parent product associated with the cluster. + */ + productName?: string | null; + } /** * PlacementPolicy defines the placement policy used by the node pool. */ diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 88e5213f69..02f86be9a6 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -771,6 +771,10 @@ export namespace container_v1beta1 { * Notification configuration of the cluster. */ notificationConfig?: Schema$NotificationConfig; + /** + * The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster. + */ + parentProductConfig?: Schema$ParentProductConfig; /** * Configuration for the PodSecurityPolicy feature. */ @@ -987,6 +991,10 @@ export namespace container_v1beta1 { * The desired config of Intra-node visibility. */ desiredIntraNodeVisibilityConfig?: Schema$IntraNodeVisibilityConfig; + /** + * Specify the details of in-transit encryption. + */ + desiredInTransitEncryptionConfig?: string | null; /** * Beta APIs enabled for cluster. */ @@ -1059,6 +1067,10 @@ export namespace container_v1beta1 { * The desired notification configuration. */ desiredNotificationConfig?: Schema$NotificationConfig; + /** + * The desired parent product config for the cluster. + */ + desiredParentProductConfig?: Schema$ParentProductConfig; /** * The desired configuration options for the PodSecurityPolicy feature. */ @@ -1326,7 +1338,7 @@ export namespace container_v1beta1 { */ export interface Schema$EphemeralStorageConfig { /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1335,7 +1347,7 @@ export namespace container_v1beta1 { */ export interface Schema$EphemeralStorageLocalSsdConfig { /** - * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. Each local SSD is 375 GB in size. If zero, it means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + * Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -1829,7 +1841,7 @@ export namespace container_v1beta1 { */ export interface Schema$LocalNvmeSsdBlockConfig { /** - * The number of raw-block local NVMe SSD disks to be attached to the node. Each local SSD is 375 GB in size. If zero, it means no raw-block local NVMe SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. + * Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info. */ localSsdCount?: number | null; } @@ -2073,6 +2085,10 @@ export namespace container_v1beta1 { * GatewayAPIConfig contains the desired config of Gateway API on this cluster. */ gatewayApiConfig?: Schema$GatewayAPIConfig; + /** + * Specify the details of in-transit encryption. + */ + inTransitEncryptionConfig?: string | null; /** * Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network */ @@ -2683,6 +2699,19 @@ export namespace container_v1beta1 { */ status?: string | null; } + /** + * ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster. + */ + export interface Schema$ParentProductConfig { + /** + * Labels contain the configuration of the parent product. + */ + labels?: {[key: string]: string} | null; + /** + * Name of the parent product associated with the cluster. + */ + productName?: string | null; + } /** * PlacementPolicy defines the placement policy used by the node pool. */ diff --git a/src/apis/containeranalysis/v1.ts b/src/apis/containeranalysis/v1.ts index e724f64b0d..7e94cd50bd 100644 --- a/src/apis/containeranalysis/v1.ts +++ b/src/apis/containeranalysis/v1.ts @@ -1317,6 +1317,10 @@ export namespace containeranalysis_v1 { * Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; + /** + * Optional. Option to specify the tool to fetch the source file for the build. + */ + sourceFetcher?: string | null; } /** * Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). @@ -3100,10 +3104,6 @@ export namespace containeranalysis_v1 { * Details of all known distros and packages affected by this vulnerability. */ details?: Schema$Detail[]; - /** - * Occurrence-specific extra details about the vulnerability. - */ - extraDetails?: string | null; /** * The note provider assigned severity of this vulnerability. */ @@ -3141,6 +3141,10 @@ export namespace containeranalysis_v1 { * The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. */ effectiveSeverity?: string | null; + /** + * Occurrence-specific extra details about the vulnerability. + */ + extraDetails?: string | null; /** * Output only. Whether at least one of the affected packages has a fix available. */ diff --git a/src/apis/containeranalysis/v1alpha1.ts b/src/apis/containeranalysis/v1alpha1.ts index 6932de6a17..80e63e3558 100644 --- a/src/apis/containeranalysis/v1alpha1.ts +++ b/src/apis/containeranalysis/v1alpha1.ts @@ -1298,6 +1298,10 @@ export namespace containeranalysis_v1alpha1 { * Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; + /** + * Optional. Option to specify the tool to fetch the source file for the build. + */ + sourceFetcher?: string | null; } /** * Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). @@ -3647,6 +3651,10 @@ export namespace containeranalysis_v1alpha1 { * The distro assigned severity for this vulnerability when that is available and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple package issues for this vulnerability, they can have different effective severities because some might come from the distro and some might come from installed language packs (e.g. Maven JARs or Go binaries). For this reason, it is advised to use the effective severity on the PackageIssue level, as this field may eventually be deprecated. In the case where multiple PackageIssues have different effective severities, the one set here will be the highest severity of any of the PackageIssues. */ effectiveSeverity?: string | null; + /** + * Occurrence-specific extra details about the vulnerability. + */ + extraDetails?: string | null; /** * The set of affected locations and their fixes (if available) within the associated resource. */ diff --git a/src/apis/containeranalysis/v1beta1.ts b/src/apis/containeranalysis/v1beta1.ts index 2ecd1965e9..a21538f456 100644 --- a/src/apis/containeranalysis/v1beta1.ts +++ b/src/apis/containeranalysis/v1beta1.ts @@ -1250,6 +1250,10 @@ export namespace containeranalysis_v1beta1 { * Cloud Storage object containing the source. This object must be a zipped (`.zip`) or gzipped archive file (`.tar.gz`) containing source to build. */ object?: string | null; + /** + * Optional. Option to specify the tool to fetch the source file for the build. + */ + sourceFetcher?: string | null; } /** * Location of the source manifest in Cloud Storage. This feature is in Preview; see description [here](https://github.com/GoogleCloudPlatform/cloud-builders/tree/master/gcs-fetcher). @@ -2034,6 +2038,10 @@ export namespace containeranalysis_v1beta1 { * The distro assigned severity for this vulnerability when it is available, and note provider assigned severity when distro has not yet assigned a severity for this vulnerability. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. */ effectiveSeverity?: string | null; + /** + * Occurrence-specific extra details about the vulnerability. + */ + extraDetails?: string | null; /** * Output only. A detailed description of this vulnerability. */ @@ -3215,10 +3223,6 @@ export namespace containeranalysis_v1beta1 { * All information about the package to specifically identify this vulnerability. One entry per (version range and cpe_uri) the package vulnerability has manifested in. */ details?: Schema$Detail[]; - /** - * Occurrence-specific extra details about the vulnerability. - */ - extraDetails?: string | null; /** * Note provider assigned impact of the vulnerability. */ diff --git a/src/apis/content/v2.1.ts b/src/apis/content/v2.1.ts index 8e52573af6..a015af2315 100644 --- a/src/apis/content/v2.1.ts +++ b/src/apis/content/v2.1.ts @@ -15768,7 +15768,7 @@ export namespace content_v2_1 { } /** - * Requests a review of free listings in a specific region. This method is only available to selected merchants. + * Requests a review of free listings in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16946,7 +16946,7 @@ export namespace content_v2_1 { } /** - * Sets the omnichannel experience for the specified country. + * Sets the omnichannel experience for the specified country. Only supported for merchants whose POS data provider is trusted to enable the corresponding experience. For more context, see these help articles [about LFP](https://support.google.com/merchants/answer/7676652) and [how to get started](https://support.google.com/merchants/answer/7676578) with it. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -28801,7 +28801,7 @@ export namespace content_v2_1 { } /** - * Requests a review of Shopping ads in a specific region. This method is only available to selected merchants. + * Requests a review of Shopping ads in a specific region. This method deprecated. Use the `MerchantSupportService` to view product and account issues and request a review. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/contentwarehouse/v1.ts b/src/apis/contentwarehouse/v1.ts index 0e89c2063b..4be03af82c 100644 --- a/src/apis/contentwarehouse/v1.ts +++ b/src/apis/contentwarehouse/v1.ts @@ -2250,7 +2250,13 @@ export namespace contentwarehouse_v1 { * Reminder to connect with a Contact (part of go/people-prompts). Also contains contact-level prompts settings. Each Contact can have a single `connection_reminder` (but can have multiple Prompts inside of it). Field is repeated per PeopleAPI data model go/people-api-concepts#repeated. Only supported for CONTACT container. */ connectionReminder?: Schema$AppsPeopleOzExternalMergedpeopleapiConnectionReminder[]; + /** + * ContactCreateContextInfo has a timestamp timestamp and additional metadata (e.g. the source of the creation) for when the contact was created. See also `ContactEditContextInfo`. + */ contactCreateContextInfo?: Schema$AppsPeopleOzExternalMergedpeopleapiContactCreateContextInfo[]; + /** + * ContactEditContextInfo is a timestamp and additional metadata (e.g. the source of the edit) for the last 'human initiated edit'. See also `ContactCreateContextInfo`. + */ contactEditContextInfo?: Schema$AppsPeopleOzExternalMergedpeopleapiContactEditContextInfo[]; /** * Contact groups that this person is a member of. @@ -2570,7 +2576,7 @@ export namespace contentwarehouse_v1 { */ edgeKeyInfo?: Schema$AppsPeopleOzExternalMergedpeopleapiEdgeKeyInfo[]; /** - * The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query. + * The encoded id of the data source. The id is only unique within a single container type. This field correlates to person.metadata.identity_info.source_id.id. This field may not be populated in some special cases, where the id is not visible to the querying user. e.g. ListAutocompletions with full phone number query. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id */ encodedContainerId?: string | null; /** @@ -3068,7 +3074,7 @@ export namespace contentwarehouse_v1 { */ googleContactId?: string | null; /** - * The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id. + * The base64 serialized social.graph.peopleapi.proto.internal.RawDeviceContactId. This id should be used to correlate to field.metadata.encoded_container_id when the field.metadata.container_type is RAW_DEVICE_CONTACT The id also correlates to person.metadata.identity_info.source_id.id. For value format, see google3/social/graph/api/proto/main_merged_person.proto?q=symbol:SourceIdentity.id */ id?: string | null; /** @@ -8087,7 +8093,7 @@ export namespace contentwarehouse_v1 { surfaceType?: string | null; } /** - * The states of the device. They are dynamic and may change based on the current context. Next ID: 10 + * The states of the device. They are dynamic and may change based on the current context. Next ID: 13 */ export interface Schema$AssistantGroundingRankerDeviceTargetingFeaturesStates { /** @@ -8107,9 +8113,21 @@ export namespace contentwarehouse_v1 { */ hasPlayingMediaSession?: boolean | null; /** - * Indicates whether or not the device is in the same structure as any local or hearing devices. + * Indicates whether or not the device is in the same room as any hearing devices. Does not consider the device itself or the local device as a hearing device. If no valid hearing devices, this field is not set. + */ + inSameRoomAsHearingDevice?: boolean | null; + /** + * Indicates whether or not the device is in the same room as the local device. If the device is the local device, this field is not set. + */ + inSameRoomAsLocalDevice?: boolean | null; + /** + * Indicates whether or not the device is in the same structure as any hearing devices. Does not consider the device itself or the local device as a hearing device. If no valid hearing devices, this field is not set. + */ + inSameStructureAsHearingDevice?: boolean | null; + /** + * Indicates whether or not the device is in the same structure as the local device. If the device is the local device, this field is not set. */ - hasSameStructure?: boolean | null; + inSameStructureAsLocalDevice?: boolean | null; /** * Indicate whether the device is docked on a base. */ @@ -9010,7 +9028,7 @@ export namespace contentwarehouse_v1 { sortedNameString?: string | null; } /** - * Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 65 + * Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 66 */ export interface Schema$AssistantPrefulfillmentRankerPrefulfillmentSignals { /** @@ -9129,6 +9147,10 @@ export namespace contentwarehouse_v1 { * Whether this intent was generated by Sage. */ isSageIntent?: boolean | null; + /** + * Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent. + */ + isScoreBasedIntent?: boolean | null; /** * Whether the intent is a media object tvm intent. */ @@ -10136,10 +10158,6 @@ export namespace contentwarehouse_v1 { * This field is only filled for the CSAI vertical. */ csaiClassification?: string | null; - /** - * DO NOT USE: This field is temporary and should be used only for the CSAI Onebox. This field is the result of the regular expression classifier alone as opposed to a combination with Seti classifier as in csai_classification field. - */ - csaiRegexpHighConfidenceClassification?: string | null; /** * Human-readable debug information about the classification. This field is only set if output_debug is set in the classification input. */ @@ -13460,12 +13478,12 @@ export namespace contentwarehouse_v1 { /** * Offset of each vertex in the new coordinate system relative to the old coordinate system. */ - translate?: Schema$GeostoreCityJsonProtoTransformXyzVector; + translate?: Schema$GeostoreCityJsonProtoTransformTranslate; } /** - * Vector of length three whose values respectively correspond to the x, y, and z axes. + * How the object will be moved along the x, y, and z axes, respectively. */ - export interface Schema$GeostoreCityJsonProtoTransformXyzVector { + export interface Schema$GeostoreCityJsonProtoTransformTranslate { x?: number | null; y?: number | null; z?: number | null; @@ -14038,7 +14056,7 @@ export namespace contentwarehouse_v1 { */ displayData?: Schema$GeostoreDisplayDataProto; /** - * RESERVED + * Represents information about disputed areas. Only TYPE_DISPUTED_AREA features should have the field set. */ disputedArea?: Schema$GeostoreDisputedAreaProto; /** @@ -14075,9 +14093,6 @@ export namespace contentwarehouse_v1 { * If set, the feature's actual location can be assumed to be somewhere within a circle of this radius, centered on the feature's location. More information on this field at go/gpm-definition-update. NOTE: Only applicable to features with 'point' geometry. Please contact geo-schema-team@ if you have non-point use cases for which this field would be useful. */ geometryPrecisionMeters?: number | null; - /** - * RESERVED - */ geopolitical?: Schema$GeostoreGeopoliticalProto; /** * Geopolitical (unsimplified) polygons for a feature for different geopolitical use cases. @@ -14252,9 +14267,6 @@ export namespace contentwarehouse_v1 { * RESERVED */ transitLineVariant?: Schema$GeostoreTransitLineVariantProto; - /** - * RESERVED - */ transitStation?: Schema$GeostoreTransitStationProto; /** * The type of this feature -- see comments above. @@ -14322,7 +14334,7 @@ export namespace contentwarehouse_v1 { */ export interface Schema$GeostoreFlowLineProto { /** - * RESERVED + * Curvature of the flowline. Note that, curvature can be present even if the flowline doesn't have a track. In which case, curvature will be derived from the segment polyline. */ curvature?: Schema$GeostoreCurvatureProto; track?: Schema$GeostoreTrackProto; @@ -14551,11 +14563,11 @@ export namespace contentwarehouse_v1 { */ export interface Schema$GeostoreInternalSegmentProto { /** - * RESERVED + * A list of lane connections that are explicitly not allowed to be added. NOTE: This should never reference existing lane connections on this segment. */ disallowedConnections?: Schema$GeostoreInternalSegmentProtoLaneConnectionReference[]; /** - * RESERVED + * A list of lane connections which cannot have the primary_connection bit set. */ disallowedPrimaryConnection?: Schema$GeostoreInternalSegmentProtoLaneConnectionReference[]; /** @@ -15198,7 +15210,7 @@ export namespace contentwarehouse_v1 { */ capital?: Schema$GeostoreFeatureIdProto; /** - * RESERVED + * Feature IDs of the features claimed by this feature's government that are not necessarily included in the feature's geometry. */ claim?: Schema$GeostoreFeatureIdProto[]; /** @@ -15693,7 +15705,7 @@ export namespace contentwarehouse_v1 { */ travelMode?: string[] | null; /** - * clang-format on The type of restriction. This is not a condition, but rather tells you what kind of restriction it is. This field should always be set. + * LINT.ThenChange(//depot/google3/google/geo/entities/v1/fields/segment.proto) clang-format on The type of restriction. This is not a condition, but rather tells you what kind of restriction it is. This field should always be set. */ type?: string | null; /** @@ -17559,7 +17571,7 @@ export namespace contentwarehouse_v1 { surfaceIdentity?: Schema$GoogleAssistantEmbeddedV1SurfaceIdentity; } /** - * Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 11 + * Information about the state of the device. This contains any state that Assistant may need to know about in order to fulfill requests, for example which timers and alarms are set. Next ID: 13 */ export interface Schema$GoogleAssistantAccessoryV1DeviceState { /** @@ -17586,6 +17598,14 @@ export namespace contentwarehouse_v1 { * Information about on-device fitness activities. For devices that support fitness activities, all on-device fitness activities must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them. */ fitnessActivitiesState?: Schema$GoogleAssistantEmbeddedV1FitnessActivities; + /** + * Information about apps currently installed on device. + */ + installedApps?: Schema$GoogleAssistantAccessoryV1DeviceStateInstalledAppsState; + /** + * This contains a zlib-compressed binary-encoded `InstalledAppsState` proto message. + */ + installedAppsZlib?: string | null; /** * *Optional* Information about on-device timers. For devices that support timers, all on-device timers must be sent up with the DeviceState in order for Assistant Server to be able to perform operations on them. */ @@ -17595,6 +17615,15 @@ export namespace contentwarehouse_v1 { */ unavailableSettings?: string[] | null; } + /** + * State of the apps currently installed on the device. + */ + export interface Schema$GoogleAssistantAccessoryV1DeviceStateInstalledAppsState { + /** + * List of apps currently installed on the device. + */ + apps?: Schema$AssistantApiCoreTypesProvider[]; + } /** * Configuration for the response. Next Id: 11 */ @@ -19329,6 +19358,10 @@ export namespace contentwarehouse_v1 { * Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information. */ document?: Schema$GoogleCloudContentwarehouseV1Document; + /** + * Return the 1-based page indices where those pages have one or more matched tokens. + */ + matchedTokenPageIndices?: string[] | null; /** * Experimental. Additional result info if the question-answering feature is enabled. */ @@ -27037,6 +27070,15 @@ export namespace contentwarehouse_v1 { export interface Schema$KnowledgeAnswersIntentQueryConceptInfo { id?: Schema$ConceptsConceptId; } + /** + * Signal data for associated Concepts (go/concept-roofshot). + */ + export interface Schema$KnowledgeAnswersIntentQueryConceptSignals { + /** + * Concepts data epoch used to annotate the queries. + */ + dataEpochId?: number | null; + } /** * A message representing a coreferenced value defined elsewhere in the meaning struct. */ @@ -27117,7 +27159,7 @@ export namespace contentwarehouse_v1 { unexplainedTokens?: Schema$KnowledgeAnswersIntentQueryTokens[]; } /** - * Next ID: 38 + * Next ID: 39 */ export interface Schema$KnowledgeAnswersIntentQueryFunctionCallSignals { /** @@ -27132,6 +27174,10 @@ export namespace contentwarehouse_v1 { * An entity that represents the concept of an entity-attribute intent by being composed of an intent equivalent MID and the argument MID. */ conceptEntityMid?: string | null; + /** + * Information about the corresponding Concept attached to the FunctionCall. go/concept-roofshot. + */ + conceptSignals?: Schema$KnowledgeAnswersIntentQueryConceptSignals; confidenceLevel?: string | null; /** * FunctionCall-s that this funcall was deduped against. @@ -38042,6 +38088,9 @@ export namespace contentwarehouse_v1 { */ version?: number | null; } + /** + * These scores are for image scores *in the context of a landing page*, which is now a discouraged path of building image classifications. See go/orbit-for-images-v2 for an alternative. + */ export interface Schema$QualityOrbitAsteroidBeltImageIntentScores { /** * The unique identifier for an Asteroid Belt document intent is being reused here @@ -38142,7 +38191,7 @@ export namespace contentwarehouse_v1 { snippetInfo?: Schema$QualityPreviewChosenSnippetInfo; } /** - * A collection of data corresponding to a single title candidate. This will be used as: - a collection of signals to score and select titles in production - an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 67 + * A collection of data corresponding to a single title candidate. This will be used as: - a collection of signals to score and select titles in production - an input for training title models NOTE: When adding a floating point value for Ranklab purposes, use float32 instead of float64, because some of the Ranklab library still does not fully support float64. Next ID: 68 */ export interface Schema$QualityPreviewRanklabTitle { /** @@ -38255,6 +38304,7 @@ export namespace contentwarehouse_v1 { * Deprecated experimental features. */ queryRelevance?: number | null; + sourceGeneratedTitle?: boolean | null; sourceGeometry?: boolean | null; sourceHeadingTag?: boolean | null; sourceLocalTitle?: boolean | null; @@ -40676,19 +40726,11 @@ export namespace contentwarehouse_v1 { * --------------------------------------------------------------------------- Enums defining the available modifier options. */ export interface Schema$RepositoryWebrefFprintModifierProto { - capitalization?: string | null; - enclosing?: string | null; /** * i18.languages.Language enum defined in i18n/languages/proto/languages.proto UNKNOWN_LANGUAGE */ language?: number | null; namespaceType?: string | null; - punctuation?: string | null; - sentence?: string | null; - sourceType?: string | null; - stemming?: string | null; - style?: string | null; - tokenType?: string | null; } /** * The Freebase type information. @@ -41330,6 +41372,13 @@ export namespace contentwarehouse_v1 { taskData?: Schema$RepositoryWebrefTaskData; topicMentionedInResult?: string[] | null; } + /** + * Identifies the source of the Meta Content Tag segment in the Cdoc https://www.w3schools.com/tags/tag_meta.asp + */ + export interface Schema$RepositoryWebrefMetaTagIndices { + index?: number | null; + metaName?: string | null; + } /** * Collects signals from one query used for prior learning. */ @@ -42059,6 +42108,10 @@ export namespace contentwarehouse_v1 { * Pointer to the proto in the cdoc and index within the proto for Spore. */ jgnIndex?: Schema$RepositoryWebrefJuggernautIndices; + /** + * Informs about the 'name' attribute of the referenced tag. + */ + metaTagIndex?: Schema$RepositoryWebrefMetaTagIndices; /** * Pointer to the exact set of queries in the cdoc. */ @@ -46237,6 +46290,10 @@ export namespace contentwarehouse_v1 { * Affinity score for the cloud contact. */ cloudScore?: number | null; + /** + * Indicator of the confidence in suggestion relevance. + */ + suggestionConfidence?: string | null; } export interface Schema$SocialGraphWireProtoPeopleapiAffinityMetadataClientInteractionInfo { /** @@ -46321,7 +46378,7 @@ export namespace contentwarehouse_v1 { hideType?: string | null; } /** - * NEXT_ID: 5 + * NEXT_ID: 6 */ export interface Schema$SocialGraphWireProtoPeopleapiExtensionPeopleStackPersonExtendedData { /** @@ -46340,6 +46397,7 @@ export namespace contentwarehouse_v1 { * If this field is not set, the person is visible (implicit). */ hideType?: string | null; + suggestionConfidence?: string | null; } export interface Schema$SocialPersonalizationKnexAnnotation { item?: Schema$SocialPersonalizationKnexAnnotationItem[]; diff --git a/src/apis/datalabeling/v1beta1.ts b/src/apis/datalabeling/v1beta1.ts index 17a30b01f2..cbb9c932b7 100644 --- a/src/apis/datalabeling/v1beta1.ts +++ b/src/apis/datalabeling/v1beta1.ts @@ -3196,7 +3196,7 @@ export namespace datalabeling_v1beta1 { */ name?: string | null; /** - * 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`. + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: {[key: string]: any} | null; } diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index e49d056e6b..e9df2350f9 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -944,10 +944,23 @@ export namespace dataplex_v1 { */ fieldNames?: string[] | null; } + /** + * A dimension captures data quality intent about a defined subset of the rules specified. + */ + export interface Schema$GoogleCloudDataplexV1DataQualityDimension { + /** + * The dimension name a rule belongs to. Supported dimensions are "COMPLETENESS", "ACCURACY", "CONSISTENCY", "VALIDITY", "UNIQUENESS", "INTEGRITY" + */ + name?: string | null; + } /** * DataQualityDimensionResult provides a more detailed, per-dimension view of the results. */ export interface Schema$GoogleCloudDataplexV1DataQualityDimensionResult { + /** + * Output only. The dimension config specified in the DataQualitySpec, as is. + */ + dimension?: Schema$GoogleCloudDataplexV1DataQualityDimension; /** * Whether the dimension passed or failed. */ @@ -1968,6 +1981,36 @@ export namespace dataplex_v1 { */ active?: boolean | null; } + /** + * Payload associated with Governance related log events. + */ + export interface Schema$GoogleCloudDataplexV1GovernanceEvent { + /** + * Entity resource information if the log event is associated with a specific entity. + */ + entity?: Schema$GoogleCloudDataplexV1GovernanceEventEntity; + /** + * The type of the event. + */ + eventType?: string | null; + /** + * The log message. + */ + message?: string | null; + } + /** + * Information about Entity resource that the log event is associated with. + */ + export interface Schema$GoogleCloudDataplexV1GovernanceEventEntity { + /** + * The Entity resource the log event is associated with. Format: projects/{project_number\}/locations/{location_id\}/lakes/{lake_id\}/zones/{zone_id\}/entities/{entity_id\} + */ + entity?: string | null; + /** + * Type of entity. + */ + entityType?: string | null; + } /** * A job represents an instance of a task. */ diff --git a/src/apis/dataproc/v1.ts b/src/apis/dataproc/v1.ts index 24c75cc204..951da3900b 100644 --- a/src/apis/dataproc/v1.ts +++ b/src/apis/dataproc/v1.ts @@ -1194,6 +1194,10 @@ export namespace dataproc_v1 { * Optional. Specifies the preemptibility of the instance group.The default value for master and worker groups is NON_PREEMPTIBLE. This default cannot be changed.The default value for secondary instances is PREEMPTIBLE. */ preemptibility?: string | null; + /** + * Optional. Configuration to handle the startup of instances during cluster create and update process. + */ + startupConfig?: Schema$StartupConfig; } /** * A reference to a Compute Engine instance. @@ -2205,6 +2209,10 @@ export namespace dataproc_v1 { * Optional. Timeout for graceful YARN decommissioning. Graceful decommissioning (https://cloud.google.com/dataproc/docs/concepts/configuring-clusters/scaling-clusters#graceful_decommissioning) allows the removal of nodes from the Compute Engine node group without interrupting jobs in progress. This timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day. (see JSON representation of Duration (https://developers.google.com/protocol-buffers/docs/proto3#json)).Only supported on Dataproc image versions 1.2 and higher. */ gracefulDecommissionTimeout?: string | null; + /** + * Optional. operation id of the parent operation sending the resize request + */ + parentOperationId?: string | null; /** * Optional. A unique ID used to identify the request. If the server receives two ResizeNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.ResizeNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ @@ -2659,6 +2667,10 @@ export namespace dataproc_v1 { * Required. Timeout for Spark graceful decommissioning of spark workers. Specifies the duration to wait for spark worker to complete spark decommissioning tasks before forcefully removing workers. Only applicable to downscaling operations.Bounds: 0s, 1d. */ gracefulDecommissionTimeout?: string | null; + /** + * Optional. Remove only idle workers when scaling down cluster + */ + removeOnlyIdleWorkers?: boolean | null; /** * Required. Fraction of required executors to remove from Spark Serverless clusters. A scale-down factor of 1.0 will result in scaling down so that there are no more executors for the Spark Job.(more aggressive scaling). A scale-down factor closer to 0 will result in a smaller magnitude of scaling donw (less aggressive scaling).Bounds: 0.0, 1.0. */ @@ -2689,6 +2701,15 @@ export namespace dataproc_v1 { */ requestId?: string | null; } + /** + * Configuration to handle the startup of instances during cluster create and update process. + */ + export interface Schema$StartupConfig { + /** + * Optional. The config setting to enable cluster creation/ updation to be successful only after required_registration_fraction of instances are up and running. This configuration is applicable to only secondary workers for now. The cluster will fail if required_registration_fraction of instances are not available. This will include instance creation, agent registration, and service registration (if enabled). + */ + requiredRegistrationFraction?: number | null; + } /** * Historical state information. */ @@ -9271,6 +9292,10 @@ export namespace dataproc_v1 { * Required. The parent resource where this node group will be created. Format: projects/{project\}/regions/{region\}/clusters/{cluster\} */ parent?: string; + /** + * Optional. operation id of the parent operation sending the create request + */ + parentOperationId?: string; /** * Optional. A unique ID used to identify the request. If the server receives two CreateNodeGroupRequest (https://cloud.google.com/dataproc/docs/reference/rpc/google.cloud.dataproc.v1#google.cloud.dataproc.v1.CreateNodeGroupRequests) with the same ID, the second request is ignored and the first google.longrunning.Operation created and stored in the backend is returned.Recommendation: Set this value to a UUID (https://en.wikipedia.org/wiki/Universally_unique_identifier).The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 40 characters. */ diff --git a/src/apis/deploymentmanager/v2.ts b/src/apis/deploymentmanager/v2.ts index 955130967c..45c0ca3ab5 100644 --- a/src/apis/deploymentmanager/v2.ts +++ b/src/apis/deploymentmanager/v2.ts @@ -1840,7 +1840,7 @@ export namespace deploymentmanager_v2 { } export interface Params$Resource$Deployments$List extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** @@ -2170,7 +2170,7 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** @@ -2389,7 +2389,7 @@ export namespace deploymentmanager_v2 { } export interface Params$Resource$Operations$List extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** @@ -2616,7 +2616,7 @@ export namespace deploymentmanager_v2 { */ deployment?: string; /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** @@ -2735,7 +2735,7 @@ export namespace deploymentmanager_v2 { export interface Params$Resource$Types$List extends StandardParameters { /** - * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:` operator can be used with string fields to match substrings. For non-string fields it is equivalent to the `=` operator. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. + * A filter expression that filters resources listed in the response. Most Compute resources support two types of filter expressions: expressions that support regular expressions and expressions that follow API improvement proposal AIP-160. These two types of filter expressions cannot be mixed in one request. If you want to use AIP-160, your expression must specify the field name, an operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The operator must be either `=`, `!=`, `\>`, `<`, `<=`, `\>=` or `:`. For example, if you are filtering Compute Engine instances, you can exclude instances named `example-instance` by specifying `name != example-instance`. The `:*` comparison can be used to test whether a key has been defined. For example, to find all objects with `owner` label use: ``` labels.owner:* ``` You can also filter nested fields. For example, you could specify `scheduling.automaticRestart = false` to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true) ``` If you want to use a regular expression, use the `eq` (equal) or `ne` (not equal) operator against a single un-parenthesized expression with or without quotes or against multiple parenthesized expressions. Examples: `fieldname eq unquoted literal` `fieldname eq 'single quoted literal'` `fieldname eq "double quoted literal"` `(fieldname1 eq literal) (fieldname2 ne "literal")` The literal value is interpreted as a regular expression using Google RE2 library syntax. The literal value must match the entire field. For example, to filter for instances that do not end with name "instance", you would use `name ne .*instance`. You cannot combine constraints on multiple fields using regular expressions. */ filter?: string; /** diff --git a/src/apis/dialogflow/v2.ts b/src/apis/dialogflow/v2.ts index 083c197f8b..fbc2f9d6ee 100644 --- a/src/apis/dialogflow/v2.ts +++ b/src/apis/dialogflow/v2.ts @@ -584,6 +584,23 @@ export namespace dialogflow_v2 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3beta1InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -790,6 +807,36 @@ export namespace dialogflow_v2 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -808,6 +855,15 @@ export namespace dialogflow_v2 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -2058,6 +2114,23 @@ export namespace dialogflow_v2 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -2264,6 +2337,36 @@ export namespace dialogflow_v2 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -2282,6 +2385,15 @@ export namespace dialogflow_v2 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ diff --git a/src/apis/dialogflow/v2beta1.ts b/src/apis/dialogflow/v2beta1.ts index 3febcd7120..97f73e0874 100644 --- a/src/apis/dialogflow/v2beta1.ts +++ b/src/apis/dialogflow/v2beta1.ts @@ -584,6 +584,23 @@ export namespace dialogflow_v2beta1 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3beta1InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -790,6 +807,36 @@ export namespace dialogflow_v2beta1 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -808,6 +855,15 @@ export namespace dialogflow_v2beta1 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -2058,6 +2114,23 @@ export namespace dialogflow_v2beta1 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -2264,6 +2337,36 @@ export namespace dialogflow_v2beta1 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -2282,6 +2385,15 @@ export namespace dialogflow_v2beta1 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ diff --git a/src/apis/dialogflow/v3.ts b/src/apis/dialogflow/v3.ts index ece116212d..4ece986e72 100644 --- a/src/apis/dialogflow/v3.ts +++ b/src/apis/dialogflow/v3.ts @@ -735,6 +735,23 @@ export namespace dialogflow_v3 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3beta1InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -941,6 +958,36 @@ export namespace dialogflow_v3 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -959,6 +1006,15 @@ export namespace dialogflow_v3 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -2654,6 +2710,44 @@ export namespace dialogflow_v3 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsMetadata {} + /** + * The request message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsRequest { + /** + * Optional. The data format of the exported intents. If not specified, `BLOB` is assumed. + */ + dataFormat?: string | null; + /** + * Required. The name of the intents to export. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + /** + * Optional. The option to return the serialized intents inline. + */ + intentsContentInline?: boolean | null; + /** + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the intents to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + intentsUri?: string | null; + } + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -3083,6 +3177,53 @@ export namespace dialogflow_v3 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsMetadata {} + /** + * The request message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsRequest { + /** + * Uncompressed byte content of intents. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3InlineSource; + /** + * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import intents from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + intentsUri?: string | null; + /** + * Merge option for importing intents. If not specified, `REJECT` is assumed. + */ + mergeOption?: string | null; + } + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -3114,6 +3255,24 @@ export namespace dialogflow_v3 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } + /** + * Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3InlineSource { + /** + * The uncompressed byte content for the objects. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -16586,6 +16745,100 @@ export namespace dialogflow_v3 { } } + /** + * Exports the selected intents. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Agents$Intents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Intents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Intents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Intents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/intents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Retrieves the specified intent. * @@ -16679,6 +16932,100 @@ export namespace dialogflow_v3 { } } + /** + * Imports the specified intents into the agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Agents$Intents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Intents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Intents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Intents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+parent}/intents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the list of all intents in the specified agent. * @@ -16892,6 +17239,18 @@ export namespace dialogflow_v3 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Intents$Export + extends StandardParameters { + /** + * Required. The name of the parent agent to export intents. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ExportIntentsRequest; + } export interface Params$Resource$Projects$Locations$Agents$Intents$Get extends StandardParameters { /** @@ -16903,6 +17262,18 @@ export namespace dialogflow_v3 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Intents$Import + extends StandardParameters { + /** + * Required. The agent to import the intents into. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3ImportIntentsRequest; + } export interface Params$Resource$Projects$Locations$Agents$Intents$List extends StandardParameters { /** diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index cb39d486c7..90bd15947f 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -1180,6 +1180,44 @@ export namespace dialogflow_v3beta1 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsMetadata {} + /** + * The request message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsRequest { + /** + * Optional. The data format of the exported intents. If not specified, `BLOB` is assumed. + */ + dataFormat?: string | null; + /** + * Required. The name of the intents to export. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + /** + * Optional. The option to return the serialized intents inline. + */ + intentsContentInline?: boolean | null; + /** + * Optional. The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to export the intents to. The format of this URI must be `gs:///`. Dialogflow performs a write operation for the Cloud Storage object on the caller's behalf, so your request authentication must have write permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + intentsUri?: string | null; + } + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3beta1InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -1609,6 +1647,53 @@ export namespace dialogflow_v3beta1 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsMetadata {} + /** + * The request message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsRequest { + /** + * Uncompressed byte content of intents. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3beta1InlineSource; + /** + * The [Google Cloud Storage](https://cloud.google.com/storage/docs/) URI to import intents from. The format of this URI must be `gs:///`. Dialogflow performs a read operation for the Cloud Storage object on the caller's behalf, so your request authentication must have read permissions for the object. For more information, see [Dialogflow access control](https://cloud.google.com/dialogflow/cx/docs/concept/access-control#storage). + */ + intentsUri?: string | null; + /** + * Merge option for importing intents. If not specified, `REJECT` is assumed. + */ + mergeOption?: string | null; + } + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -1640,6 +1725,24 @@ export namespace dialogflow_v3beta1 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } + /** + * Inline source for a Dialogflow operation that reads or imports objects (e.g. intents) into Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1InlineSource { + /** + * The uncompressed byte content for the objects. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -3930,6 +4033,23 @@ export namespace dialogflow_v3beta1 { */ flowUri?: string | null; } + /** + * Metadata returned for the Intents.ExportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsMetadata {} + /** + * The response message for Intents.ExportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ExportIntentsResponse { + /** + * Uncompressed byte content for intents. This field is populated only if `intents_content_inline` is set to true in ExportIntentsRequest. + */ + intentsContent?: Schema$GoogleCloudDialogflowCxV3InlineDestination; + /** + * The URI to a file containing the exported intents. This field is populated only if `intents_uri` is specified in ExportIntentsRequest. + */ + intentsUri?: string | null; + } /** * Metadata returned for the TestCases.ExportTestCases long running operation. This message currently has no fields. */ @@ -4136,6 +4256,36 @@ export namespace dialogflow_v3beta1 { */ flow?: string | null; } + /** + * Metadata returned for the Intents.ImportIntents long running operation. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsMetadata {} + /** + * The response message for Intents.ImportIntents. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponse { + /** + * Info which resources have conflicts when REPORT_CONFLICT merge_option is set in ImportIntentsRequest. + */ + conflictingResources?: Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources; + /** + * The unique identifier of the imported intents. Format: `projects//locations//agents//intents/`. + */ + intents?: string[] | null; + } + /** + * Conflicting resources detected during the import process. Only filled when REPORT_CONFLICT is set in the request and there are conflicts in the display names. + */ + export interface Schema$GoogleCloudDialogflowCxV3ImportIntentsResponseConflictingResources { + /** + * Display names of conflicting entities. + */ + entityDisplayNames?: string[] | null; + /** + * Display names of conflicting intents. + */ + intentDisplayNames?: string[] | null; + } /** * Metadata returned for the TestCases.ImportTestCases long running operation. */ @@ -4154,6 +4304,15 @@ export namespace dialogflow_v3beta1 { */ names?: string[] | null; } + /** + * Inline destination for a Dialogflow operation that writes or exports objects (e.g. intents) outside of Dialogflow. + */ + export interface Schema$GoogleCloudDialogflowCxV3InlineDestination { + /** + * Output only. The uncompressed byte content for the objects. Only populated in responses. + */ + content?: string | null; + } /** * Instructs the speech recognizer on how to process the audio content. */ @@ -16604,6 +16763,100 @@ export namespace dialogflow_v3beta1 { } } + /** + * Exports the selected intents. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ExportIntentsMetadata - `response`: ExportIntentsResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: StreamMethodOptions + ): GaxiosPromise; + export( + params?: Params$Resource$Projects$Locations$Agents$Intents$Export, + options?: MethodOptions + ): GaxiosPromise; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + export( + params: Params$Resource$Projects$Locations$Agents$Intents$Export, + callback: BodyResponseCallback + ): void; + export( + callback: BodyResponseCallback + ): void; + export( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Intents$Export + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Intents$Export; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Intents$Export; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+parent}/intents:export').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Retrieves the specified intent. * @@ -16697,6 +16950,100 @@ export namespace dialogflow_v3beta1 { } } + /** + * Imports the specified intents into the agent. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: ImportIntentsMetadata - `response`: ImportIntentsResponse + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: StreamMethodOptions + ): GaxiosPromise; + import( + params?: Params$Resource$Projects$Locations$Agents$Intents$Import, + options?: MethodOptions + ): GaxiosPromise; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + import( + params: Params$Resource$Projects$Locations$Agents$Intents$Import, + callback: BodyResponseCallback + ): void; + import( + callback: BodyResponseCallback + ): void; + import( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Agents$Intents$Import + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Agents$Intents$Import; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Agents$Intents$Import; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://dialogflow.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3beta1/{+parent}/intents:import').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Returns the list of all intents in the specified agent. * @@ -16910,6 +17257,18 @@ export namespace dialogflow_v3beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Intents$Export + extends StandardParameters { + /** + * Required. The name of the parent agent to export intents. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1ExportIntentsRequest; + } export interface Params$Resource$Projects$Locations$Agents$Intents$Get extends StandardParameters { /** @@ -16921,6 +17280,18 @@ export namespace dialogflow_v3beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Agents$Intents$Import + extends StandardParameters { + /** + * Required. The agent to import the intents into. Format: `projects//locations//agents/`. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDialogflowCxV3beta1ImportIntentsRequest; + } export interface Params$Resource$Projects$Locations$Agents$Intents$List extends StandardParameters { /** diff --git a/src/apis/discoveryengine/v1alpha.ts b/src/apis/discoveryengine/v1alpha.ts index 11485a5996..6c332bcdab 100644 --- a/src/apis/discoveryengine/v1alpha.ts +++ b/src/apis/discoveryengine/v1alpha.ts @@ -305,7 +305,7 @@ export namespace discoveryengine_v1alpha { */ query?: string | null; /** - * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores. + * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */ queryModel?: string | null; /** @@ -1093,6 +1093,87 @@ export namespace discoveryengine_v1alpha { */ metadata?: {[key: string]: any} | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. + */ + invalidUris?: string[] | null; + /** + * Total number of URIs that have yet to be crawled. + */ + pendingCount?: number | null; + /** + * Total number of URIs that were rejected due to insufficient indexing resources. + */ + quotaExceededCount?: number | null; + /** + * Total number of URIs that have been crawled so far. + */ + successCount?: number | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + /** + * Total number of unique URIs in the request that are not in invalid_uris. + */ + validUrisCount?: number | null; + } + /** + * Request message for SiteSearchEngineService.RecrawlUris method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest { + /** + * Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in `site_search_engine`. + */ + uris?: string[] | null; + } + /** + * Response message for SiteSearchEngineService.RecrawlUris method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse { + /** + * URIs that were not crawled before the LRO terminated. + */ + failedUris?: string[] | null; + /** + * Details for a sample of up to 10 `failed_uris`. + */ + failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[]; + } + /** + * Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo { + /** + * List of failure reasons by corpus type (e.g. desktop, mobile). + */ + failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[]; + /** + * URI that failed to be crawled. + */ + uri?: string | null; + } + /** + * Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason { + /** + * DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. + */ + corpusType?: string | null; + /** + * Reason why the URI was not crawled. + */ + errorMessage?: string | null; + } /** * Defines a reply message to user. */ @@ -1487,6 +1568,7 @@ export namespace discoveryengine_v1alpha { * Results of facets requested by user. */ facets?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseFacet[]; + geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo[]; /** * Guided search result. */ @@ -1550,6 +1632,19 @@ export namespace discoveryengine_v1alpha { */ value?: string | null; } + /** + * Debug information specifically related to forward geocoding issues arising from Geolocation Search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaSearchResponseGeoSearchDebugInfo { + /** + * The error produced. + */ + errorMessage?: string | null; + /** + * The address from which forward geocoding ingestion produced issues. + */ + originalAddressQuery?: string | null; + } /** * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. */ @@ -1964,10 +2059,18 @@ export namespace discoveryengine_v1alpha { * Output only. Whether LLM is enabled in the corresponding data store. */ llmEnabled?: boolean | null; + /** + * Output only. Whether the customer accepted data use terms. + */ + minimumDataTermAccepted?: boolean | null; /** * Immutable. The full resource name of the widget config. Format: `projects/{project\}/locations/{location\}/collections/{collection_id\}/dataStores/{data_store_id\}/widgetConfigs/{widget_config_id\}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */ name?: string | null; + /** + * The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. + */ + resultDisplayType?: string | null; /** * Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */ @@ -3154,7 +3257,7 @@ export namespace discoveryengine_v1alpha { */ query?: string; /** - * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores. + * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */ queryModel?: string; /** @@ -6302,6 +6405,115 @@ export namespace discoveryengine_v1alpha { this.context ); } + + /** + * Request on-demand recrawl for a list of URIs. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + options: StreamMethodOptions + ): GaxiosPromise; + recrawlUris( + params?: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + options?: MethodOptions + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recrawlUris( + params: Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback + ): void; + recrawlUris( + callback: BodyResponseCallback + ): void; + recrawlUris( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; } export class Resource$Projects$Locations$Collections$Datastores$Sitesearchengine$Operations { @@ -7214,12 +7426,17 @@ export namespace discoveryengine_v1alpha { export class Resource$Projects$Locations$Collections$Engines { context: APIRequestContext; operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Projects$Locations$Collections$Engines$Operations( this.context ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); } } @@ -7448,6 +7665,234 @@ export namespace discoveryengine_v1alpha { pageToken?: string; } + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Makes a recommendation, which requires a contextual user event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions + ): GaxiosPromise; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; + } + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -7681,6 +8126,7 @@ export namespace discoveryengine_v1alpha { operations: Resource$Projects$Locations$Datastores$Operations; schemas: Resource$Projects$Locations$Datastores$Schemas; servingConfigs: Resource$Projects$Locations$Datastores$Servingconfigs; + siteSearchEngine: Resource$Projects$Locations$Datastores$Sitesearchengine; userEvents: Resource$Projects$Locations$Datastores$Userevents; constructor(context: APIRequestContext) { this.context = context; @@ -7700,6 +8146,10 @@ export namespace discoveryengine_v1alpha { ); this.servingConfigs = new Resource$Projects$Locations$Datastores$Servingconfigs(this.context); + this.siteSearchEngine = + new Resource$Projects$Locations$Datastores$Sitesearchengine( + this.context + ); this.userEvents = new Resource$Projects$Locations$Datastores$Userevents( this.context ); @@ -7819,7 +8269,7 @@ export namespace discoveryengine_v1alpha { */ query?: string; /** - * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores. + * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */ queryModel?: string; /** @@ -10722,6 +11172,122 @@ export namespace discoveryengine_v1alpha { requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaSearchRequest; } + export class Resource$Projects$Locations$Datastores$Sitesearchengine { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Request on-demand recrawl for a list of URIs. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + options: StreamMethodOptions + ): GaxiosPromise; + recrawlUris( + params?: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + options?: MethodOptions + ): GaxiosPromise; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recrawlUris( + params: Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris, + callback: BodyResponseCallback + ): void; + recrawlUris( + callback: BodyResponseCallback + ): void; + recrawlUris( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+siteSearchEngine}:recrawlUris').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['siteSearchEngine'], + pathParams: ['siteSearchEngine'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datastores$Sitesearchengine$Recrawluris + extends StandardParameters { + /** + * Required. Full resource name of the SiteSearchEngine, such as `projects/x/locations/x/collections/x/dataStores/x/siteSearchEngine`. + */ + siteSearchEngine?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisRequest; + } + export class Resource$Projects$Locations$Datastores$Userevents { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/discoveryengine/v1beta.ts b/src/apis/discoveryengine/v1beta.ts index 320a192e22..70e48fd364 100644 --- a/src/apis/discoveryengine/v1beta.ts +++ b/src/apis/discoveryengine/v1beta.ts @@ -464,6 +464,78 @@ export namespace discoveryengine_v1beta { */ purgeCount?: string | null; } + /** + * Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisMetadata { + /** + * Operation create time. + */ + createTime?: string | null; + /** + * Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE. + */ + invalidUris?: string[] | null; + /** + * Total number of URIs that have yet to be crawled. + */ + pendingCount?: number | null; + /** + * Total number of URIs that were rejected due to insufficient indexing resources. + */ + quotaExceededCount?: number | null; + /** + * Total number of URIs that have been crawled so far. + */ + successCount?: number | null; + /** + * Operation last update time. If the operation is done, this is also the finish time. + */ + updateTime?: string | null; + /** + * Total number of unique URIs in the request that are not in invalid_uris. + */ + validUrisCount?: number | null; + } + /** + * Response message for SiteSearchEngineService.RecrawlUris method. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponse { + /** + * URIs that were not crawled before the LRO terminated. + */ + failedUris?: string[] | null; + /** + * Details for a sample of up to 10 `failed_uris`. + */ + failureSamples?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo[]; + } + /** + * Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfo { + /** + * List of failure reasons by corpus type (e.g. desktop, mobile). + */ + failureReasons?: Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason[]; + /** + * URI that failed to be crawled. + */ + uri?: string | null; + } + /** + * Details about why crawling failed for a particular CorpusType, e.g. DESKTOP and MOBILE crawling may fail for different reasons. + */ + export interface Schema$GoogleCloudDiscoveryengineV1alphaRecrawlUrisResponseFailureInfoFailureReason { + /** + * DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED. + */ + corpusType?: string | null; + /** + * Reason why the URI was not crawled. + */ + errorMessage?: string | null; + } /** * Defines the structure and layout of a type of document data. */ @@ -1651,6 +1723,7 @@ export namespace discoveryengine_v1beta { * Results of facets requested by user. */ facets?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseFacet[]; + geoSearchDebugInfo?: Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo[]; /** * Guided search result. */ @@ -1714,6 +1787,19 @@ export namespace discoveryengine_v1beta { */ value?: string | null; } + /** + * Debug information specifically related to forward geocoding issues arising from Geolocation Search. + */ + export interface Schema$GoogleCloudDiscoveryengineV1betaSearchResponseGeoSearchDebugInfo { + /** + * The error produced. + */ + errorMessage?: string | null; + /** + * The address from which forward geocoding ingestion produced issues. + */ + originalAddressQuery?: string | null; + } /** * Guided search result. The guided search helps user to refine the search results and narrow down to the real needs from a broaded search results. */ @@ -2410,7 +2496,7 @@ export namespace discoveryengine_v1beta { */ query?: string; /** - * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores. + * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */ queryModel?: string; /** @@ -6362,12 +6448,17 @@ export namespace discoveryengine_v1beta { export class Resource$Projects$Locations$Collections$Engines { context: APIRequestContext; operations: Resource$Projects$Locations$Collections$Engines$Operations; + servingConfigs: Resource$Projects$Locations$Collections$Engines$Servingconfigs; constructor(context: APIRequestContext) { this.context = context; this.operations = new Resource$Projects$Locations$Collections$Engines$Operations( this.context ); + this.servingConfigs = + new Resource$Projects$Locations$Collections$Engines$Servingconfigs( + this.context + ); } } @@ -6596,6 +6687,234 @@ export namespace discoveryengine_v1beta { pageToken?: string; } + export class Resource$Projects$Locations$Collections$Engines$Servingconfigs { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Makes a recommendation, which requires a contextual user event. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions + ): GaxiosPromise; + recommend( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options?: MethodOptions + ): GaxiosPromise; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + recommend( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend, + callback: BodyResponseCallback + ): void; + recommend( + callback: BodyResponseCallback + ): void; + recommend( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:recommend').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Performs a search. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://discoveryengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+servingConfig}:search').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['servingConfig'], + pathParams: ['servingConfig'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Recommend + extends StandardParameters { + /** + * Required. Full resource name of the format: `projects/x/locations/global/collections/x/dataStores/x/servingConfigs/x` Before you can request recommendations from your model, you must create at least one serving config for it. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaRecommendRequest; + } + export interface Params$Resource$Projects$Locations$Collections$Engines$Servingconfigs$Search + extends StandardParameters { + /** + * Required. The resource name of the Search serving config, such as `projects/x/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. + */ + servingConfig?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDiscoveryengineV1betaSearchRequest; + } + export class Resource$Projects$Locations$Collections$Operations { context: APIRequestContext; constructor(context: APIRequestContext) { @@ -6967,7 +7286,7 @@ export namespace discoveryengine_v1beta { */ query?: string; /** - * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for IndustryVertical.SITE_SEARCH dataStores. + * Selects data model of query suggestions for serving. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */ queryModel?: string; /** diff --git a/src/apis/displayvideo/index.ts b/src/apis/displayvideo/index.ts index 901d1e456b..f3847eacff 100644 --- a/src/apis/displayvideo/index.ts +++ b/src/apis/displayvideo/index.ts @@ -19,6 +19,7 @@ import {displayvideo_v1beta} from './v1beta'; import {displayvideo_v1beta2} from './v1beta2'; import {displayvideo_v1dev} from './v1dev'; import {displayvideo_v2} from './v2'; +import {displayvideo_v3} from './v3'; export const VERSIONS = { v1: displayvideo_v1.Displayvideo, @@ -26,6 +27,7 @@ export const VERSIONS = { v1beta2: displayvideo_v1beta2.Displayvideo, v1dev: displayvideo_v1dev.Displayvideo, v2: displayvideo_v2.Displayvideo, + v3: displayvideo_v3.Displayvideo, }; export function displayvideo(version: 'v1'): displayvideo_v1.Displayvideo; @@ -52,13 +54,18 @@ export function displayvideo(version: 'v2'): displayvideo_v2.Displayvideo; export function displayvideo( options: displayvideo_v2.Options ): displayvideo_v2.Displayvideo; +export function displayvideo(version: 'v3'): displayvideo_v3.Displayvideo; +export function displayvideo( + options: displayvideo_v3.Options +): displayvideo_v3.Displayvideo; export function displayvideo< T = | displayvideo_v1.Displayvideo | displayvideo_v1beta.Displayvideo | displayvideo_v1beta2.Displayvideo | displayvideo_v1dev.Displayvideo - | displayvideo_v2.Displayvideo, + | displayvideo_v2.Displayvideo + | displayvideo_v3.Displayvideo, >( this: GoogleConfigurable, versionOrOptions: @@ -72,6 +79,8 @@ export function displayvideo< | displayvideo_v1dev.Options | 'v2' | displayvideo_v2.Options + | 'v3' + | displayvideo_v3.Options ) { return getAPI('displayvideo', versionOrOptions, VERSIONS, this); } @@ -83,6 +92,7 @@ export {displayvideo_v1beta}; export {displayvideo_v1beta2}; export {displayvideo_v1dev}; export {displayvideo_v2}; +export {displayvideo_v3}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/displayvideo/v1.ts b/src/apis/displayvideo/v1.ts index 9e0b2dee30..7fbd9ae588 100644 --- a/src/apis/displayvideo/v1.ts +++ b/src/apis/displayvideo/v1.ts @@ -339,7 +339,7 @@ export namespace displayvideo_v1 { */ export interface Schema$AgeRangeAssignedTargetingOptionDetails { /** - * 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. + * Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. */ ageRange?: string | null; /** @@ -447,7 +447,7 @@ export namespace displayvideo_v1 { name?: string | null; } /** - * An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. + * An assignment between a location list and a relevant targeting option. */ export interface Schema$AssignedLocation { /** @@ -459,7 +459,7 @@ export namespace displayvideo_v1 { */ name?: string | null; /** - * Required. The ID of the targeting option assigned to the location list. Assigned locations can only be modified in TARGETING_LOCATION_TYPE_REGIONAL location lists. When creating or deleting assigned locations, this value must be of type TARGETING_TYPE_GEO_REGION. + * Required. The ID of the targeting option assigned to the location list. */ targetingOptionId?: string | null; } @@ -719,7 +719,7 @@ export namespace displayvideo_v1 { */ export interface Schema$AudioContentTypeAssignedTargetingOptionDetails { /** - * The audio content type. Output only in v1. Required in v2. + * Required. The audio content type. */ audioContentType?: string | null; /** @@ -930,17 +930,14 @@ export namespace displayvideo_v1 { */ export interface Schema$BulkEditAssignedLocationsRequest { /** - * The assigned locations to create in bulk, specified as a list of AssignedLocations. + * The assigned locations to create in bulk, specified as a list of AssignedLocation resources. */ createdAssignedLocations?: Schema$AssignedLocation[]; /** - * The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids. + * The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values. */ deletedAssignedLocations?: string[] | null; } - /** - * Response message for AssignedLocationService.BulkEditAssignedLocations. - */ export interface Schema$BulkEditAssignedLocationsResponse { /** * The list of assigned locations that have been successfully created. This list will be absent if empty. @@ -1537,7 +1534,7 @@ export namespace displayvideo_v1 { */ adType?: string | null; /** - * The content instream position for video or audio ads. Output only in v1. Required in v2. + * Required. The content instream position for video or audio ads. */ contentInstreamPosition?: string | null; /** @@ -1563,7 +1560,7 @@ export namespace displayvideo_v1 { */ adType?: string | null; /** - * The content outstream position. Output only in v1. Required in v2. + * Required. The content outstream position. */ contentOutstreamPosition?: string | null; /** @@ -1977,7 +1974,7 @@ export namespace displayvideo_v1 { */ customBiddingScriptId?: string | null; /** - * Output only. Error details of a rejected custom bidding script. This field will only be populated when Script.state is REJECTED. + * Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. */ errors?: Schema$ScriptError[]; /** @@ -2136,7 +2133,7 @@ export namespace displayvideo_v1 { */ export interface Schema$DeviceTypeAssignedTargetingOptionDetails { /** - * The display name of the device type. Output only in v1. Required in v2. + * Required. The display name of the device type. */ deviceType?: string | null; /** @@ -2390,7 +2387,7 @@ export namespace displayvideo_v1 { */ export interface Schema$EnvironmentAssignedTargetingOptionDetails { /** - * The serving environment. Output only in v1. Required in v2. + * Required. The serving environment. */ environment?: string | null; /** @@ -2656,7 +2653,7 @@ export namespace displayvideo_v1 { */ export interface Schema$GenderAssignedTargetingOptionDetails { /** - * The gender of the audience. Output only in v1. Required in v2. + * Required. The gender of the audience. */ gender?: string | null; /** @@ -2868,7 +2865,7 @@ export namespace displayvideo_v1 { */ export interface Schema$HouseholdIncomeAssignedTargetingOptionDetails { /** - * The household income of the audience. Output only in v1. Required in v2. + * Required. The household income of the audience. */ householdIncome?: string | null; /** @@ -4064,7 +4061,7 @@ export namespace displayvideo_v1 { */ export interface Schema$NativeContentPositionAssignedTargetingOptionDetails { /** - * The content position. Output only in v1. Required in v2. + * Required. The content position. */ contentPosition?: string | null; /** @@ -4170,7 +4167,7 @@ export namespace displayvideo_v1 { */ export interface Schema$OmidAssignedTargetingOptionDetails { /** - * The type of Open Measurement enabled inventory. Output only in v1. Required in v2. + * Required. The type of Open Measurement enabled inventory. */ omid?: string | null; /** @@ -4277,7 +4274,7 @@ export namespace displayvideo_v1 { */ dailyMaxMicros?: string | null; /** - * 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`. + * Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. */ pacingPeriod?: string | null; /** @@ -4290,7 +4287,7 @@ export namespace displayvideo_v1 { */ export interface Schema$ParentalStatusAssignedTargetingOptionDetails { /** - * The parental status of the audience. Output only in v1. Required in v2. + * Required. The parental status of the audience. */ parentalStatus?: string | null; /** @@ -4435,7 +4432,7 @@ export namespace displayvideo_v1 { markupType?: string | null; } /** - * Settings that control the performance goal of a campaign or insertion order. + * Settings that control the performance goal of a campaign. */ export interface Schema$PerformanceGoal { /** @@ -5233,7 +5230,7 @@ export namespace displayvideo_v1 { */ targetingOptionId?: string | null; /** - * The video player size. Output only in v1. Required in v2. + * Required. The video player size. */ videoPlayerSize?: string | null; } @@ -5255,7 +5252,7 @@ export namespace displayvideo_v1 { */ targetingOptionId?: string | null; /** - * The predicted viewability percentage. Output only in v1. Required in v2. + * Required. The predicted viewability percentage. */ viewability?: string | null; } @@ -11659,7 +11656,7 @@ export namespace displayvideo_v1 { } /** - * 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. + * Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/displayvideo/v2.ts b/src/apis/displayvideo/v2.ts index eac0a20fb5..1ff55c9c24 100644 --- a/src/apis/displayvideo/v2.ts +++ b/src/apis/displayvideo/v2.ts @@ -221,7 +221,7 @@ export namespace displayvideo_v2 { */ advertiserId?: string | null; /** - * Billing related settings of the advertiser. + * Required. Billing related settings of the advertiser. */ billingConfig?: Schema$AdvertiserBillingConfig; /** @@ -287,7 +287,7 @@ export namespace displayvideo_v2 { */ export interface Schema$AdvertiserBillingConfig { /** - * The ID of a billing profile assigned to the advertiser. This field will default to the default billing profile ID of the advertiser's parent partner if a value is not provided. + * The ID of a billing profile assigned to the advertiser. */ billingProfileId?: string | null; } @@ -365,7 +365,7 @@ export namespace displayvideo_v2 { */ export interface Schema$AgeRangeAssignedTargetingOptionDetails { /** - * 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. + * Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. */ ageRange?: string | null; } @@ -469,7 +469,7 @@ export namespace displayvideo_v2 { name?: string | null; } /** - * An assignment between a location list and a relevant targeting option. Currently, geo region targeting options are the only supported option for assignment. + * An assignment between a location list and a relevant targeting option. */ export interface Schema$AssignedLocation { /** @@ -481,7 +481,7 @@ export namespace displayvideo_v2 { */ name?: string | null; /** - * Required. The ID of the targeting option assigned to the location list. Assigned locations can only be modified in TARGETING_LOCATION_TYPE_REGIONAL location lists. When creating or deleting assigned locations, this value must be of type TARGETING_TYPE_GEO_REGION. + * Required. The ID of the targeting option assigned to the location list. */ targetingOptionId?: string | null; } @@ -778,7 +778,7 @@ export namespace displayvideo_v2 { */ export interface Schema$AudioContentTypeAssignedTargetingOptionDetails { /** - * The audio content type. Output only in v1. Required in v2. + * Required. The audio content type. */ audioContentType?: string | null; } @@ -985,17 +985,14 @@ export namespace displayvideo_v2 { */ export interface Schema$BulkEditAssignedLocationsRequest { /** - * The assigned locations to create in bulk, specified as a list of AssignedLocations. + * The assigned locations to create in bulk, specified as a list of AssignedLocation resources. */ createdAssignedLocations?: Schema$AssignedLocation[]; /** - * The IDs of the assigned locations to delete in bulk, specified as a list of assigned_location_ids. + * The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values. */ deletedAssignedLocations?: string[] | null; } - /** - * Response message for AssignedLocationService.BulkEditAssignedLocations. - */ export interface Schema$BulkEditAssignedLocationsResponse { /** * The list of assigned locations that have been successfully created. This list will be absent if empty. @@ -1125,7 +1122,7 @@ export namespace displayvideo_v2 { } export interface Schema$BulkListAdGroupAssignedTargetingOptionsResponse { /** - * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more youtube_ad_group_assigned_targeting_options or ad_group_assigned_targeting_options to return. + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return. */ nextPageToken?: string | null; /** @@ -1694,7 +1691,7 @@ export namespace displayvideo_v2 { */ adType?: string | null; /** - * The content instream position for video or audio ads. Output only in v1. Required in v2. + * Required. The content instream position for video or audio ads. */ contentInstreamPosition?: string | null; } @@ -1716,7 +1713,7 @@ export namespace displayvideo_v2 { */ adType?: string | null; /** - * The content outstream position. Output only in v1. Required in v2. + * Required. The content outstream position. */ contentOutstreamPosition?: string | null; } @@ -2126,7 +2123,7 @@ export namespace displayvideo_v2 { */ customBiddingScriptId?: string | null; /** - * Output only. Error details of a rejected custom bidding script. This field will only be populated when Script.state is REJECTED. + * Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. */ errors?: Schema$ScriptError[]; /** @@ -2298,7 +2295,7 @@ export namespace displayvideo_v2 { */ export interface Schema$DeviceTypeAssignedTargetingOptionDetails { /** - * The display name of the device type. Output only in v1. Required in v2. + * Required. The display name of the device type. */ deviceType?: string | null; /** @@ -2572,7 +2569,7 @@ export namespace displayvideo_v2 { */ export interface Schema$EnvironmentAssignedTargetingOptionDetails { /** - * The serving environment. Output only in v1. Required in v2. + * Required. The serving environment. */ environment?: string | null; } @@ -2838,7 +2835,7 @@ export namespace displayvideo_v2 { */ export interface Schema$GenderAssignedTargetingOptionDetails { /** - * The gender of the audience. Output only in v1. Required in v2. + * Required. The gender of the audience. */ gender?: string | null; } @@ -3046,7 +3043,7 @@ export namespace displayvideo_v2 { */ export interface Schema$HouseholdIncomeAssignedTargetingOptionDetails { /** - * The household income of the audience. Output only in v1. Required in v2. + * Required. The household income of the audience. */ householdIncome?: string | null; } @@ -4359,7 +4356,7 @@ export namespace displayvideo_v2 { */ export interface Schema$NativeContentPositionAssignedTargetingOptionDetails { /** - * The content position. Output only in v1. Required in v2. + * Required. The content position. */ contentPosition?: string | null; } @@ -4474,7 +4471,7 @@ export namespace displayvideo_v2 { */ export interface Schema$OmidAssignedTargetingOptionDetails { /** - * The type of Open Measurement enabled inventory. Output only in v1. Required in v2. + * Required. The type of Open Measurement enabled inventory. */ omid?: string | null; } @@ -4577,7 +4574,7 @@ export namespace displayvideo_v2 { */ dailyMaxMicros?: string | null; /** - * 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`. + * Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. */ pacingPeriod?: string | null; /** @@ -4590,7 +4587,7 @@ export namespace displayvideo_v2 { */ export interface Schema$ParentalStatusAssignedTargetingOptionDetails { /** - * The parental status of the audience. Output only in v1. Required in v2. + * Required. The parental status of the audience. */ parentalStatus?: string | null; } @@ -4731,7 +4728,7 @@ export namespace displayvideo_v2 { markupType?: string | null; } /** - * Settings that control the performance goal of a campaign or insertion order. + * Settings that control the performance goal of a campaign. */ export interface Schema$PerformanceGoal { /** @@ -5706,7 +5703,7 @@ export namespace displayvideo_v2 { */ export interface Schema$VideoPlayerSizeAssignedTargetingOptionDetails { /** - * The video player size. Output only in v1. Required in v2. + * Required. The video player size. */ videoPlayerSize?: string | null; } @@ -5724,7 +5721,7 @@ export namespace displayvideo_v2 { */ export interface Schema$ViewabilityAssignedTargetingOptionDetails { /** - * The predicted viewability percentage. Output only in v1. Required in v2. + * Required. The predicted viewability percentage. */ viewability?: string | null; } @@ -5852,7 +5849,7 @@ export namespace displayvideo_v2 { videoPerformanceAd?: Schema$VideoPerformanceAd; } /** - * Wrapper object associating an assigned_targeting_option resource and the youtube ad group it is assigned to. + * Wrapper object associating an AssignedTargetingOption resource and the youtube ad group it is assigned to. */ export interface Schema$YoutubeAdGroupAssignedTargetingOption { /** @@ -5869,11 +5866,11 @@ export namespace displayvideo_v2 { */ export interface Schema$YoutubeAndPartnersBiddingStrategy { /** - * Output only. Source of the effective targetCpa value for AdGroup. + * Output only. Source of the effective target CPA value for ad group. */ adGroupEffectiveTargetCpaSource?: string | null; /** - * Output only. The effective targetCpa for AdGroup, in micros of advertiser's currency. + * Output only. The effective target CPA for ad group, in micros of advertiser's currency. */ adGroupEffectiveTargetCpaValue?: string | null; /** @@ -12851,7 +12848,7 @@ export namespace displayvideo_v2 { } /** - * 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. + * Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -15751,7 +15748,7 @@ export namespace displayvideo_v2 { } /** - * Lists assigned targeting options for multiple YouTube ad groups across targeting types. Inherieted assigned targeting options are not included. + * Lists assigned targeting options for multiple YouTube ad groups across targeting types. Inherited assigned targeting options are not included. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -16039,7 +16036,7 @@ export namespace displayvideo_v2 { */ filter?: string; /** - * Optional. Field by which to sort the list. Acceptable values are: * `youtubeAdGroupId` (acceptable in v2) * `adGroupId` (acceptable in v3) * `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`. + * Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. */ orderBy?: string; /** diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts new file mode 100644 index 0000000000..3d5db246ff --- /dev/null +++ b/src/apis/displayvideo/v3.ts @@ -0,0 +1,24049 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace displayvideo_v3 { + export interface Options extends GlobalOptions { + version: 'v3'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Display & Video 360 API + * + * 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. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const displayvideo = google.displayvideo('v3'); + * ``` + */ + export class Displayvideo { + context: APIRequestContext; + advertisers: Resource$Advertisers; + combinedAudiences: Resource$Combinedaudiences; + customBiddingAlgorithms: Resource$Custombiddingalgorithms; + customLists: Resource$Customlists; + firstAndThirdPartyAudiences: Resource$Firstandthirdpartyaudiences; + floodlightGroups: Resource$Floodlightgroups; + googleAudiences: Resource$Googleaudiences; + guaranteedOrders: Resource$Guaranteedorders; + inventorySourceGroups: Resource$Inventorysourcegroups; + inventorySources: Resource$Inventorysources; + media: Resource$Media; + partners: Resource$Partners; + sdfdownloadtasks: Resource$Sdfdownloadtasks; + targetingTypes: Resource$Targetingtypes; + users: Resource$Users; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.advertisers = new Resource$Advertisers(this.context); + this.combinedAudiences = new Resource$Combinedaudiences(this.context); + this.customBiddingAlgorithms = new Resource$Custombiddingalgorithms( + this.context + ); + this.customLists = new Resource$Customlists(this.context); + this.firstAndThirdPartyAudiences = + new Resource$Firstandthirdpartyaudiences(this.context); + this.floodlightGroups = new Resource$Floodlightgroups(this.context); + this.googleAudiences = new Resource$Googleaudiences(this.context); + this.guaranteedOrders = new Resource$Guaranteedorders(this.context); + this.inventorySourceGroups = new Resource$Inventorysourcegroups( + this.context + ); + this.inventorySources = new Resource$Inventorysources(this.context); + this.media = new Resource$Media(this.context); + this.partners = new Resource$Partners(this.context); + this.sdfdownloadtasks = new Resource$Sdfdownloadtasks(this.context); + this.targetingTypes = new Resource$Targetingtypes(this.context); + this.users = new Resource$Users(this.context); + } + } + + /** + * Configuration for custom Active View video viewability metrics. + */ + export interface Schema$ActiveViewVideoViewabilityMetricConfig { + /** + * Required. The display name of the custom metric. + */ + displayName?: string | null; + /** + * 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). + */ + minimumDuration?: string | null; + /** + * 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). + */ + minimumQuartile?: string | null; + /** + * Required. The minimum percentage of the video ad's pixels visible on the screen in order for an impression to be recorded. + */ + minimumViewability?: string | null; + /** + * Required. The minimum percentage of the video ad's volume required in order for an impression to be recorded. + */ + minimumVolume?: string | null; + } + /** + * A single ad group associated with a line item. + */ + export interface Schema$AdGroup { + /** + * The format of the ads in the ad group. + */ + adGroupFormat?: string | null; + /** + * The unique ID of the ad group. Assigned by the system. + */ + adGroupId?: string | null; + /** + * The unique ID of the advertiser the ad group belongs to. + */ + advertiserId?: string | null; + /** + * The bidding strategy used by the ad group. Only the youtubeAndPartnersBid field can be used in the bidding strategy. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * The display name of the ad group. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Controls whether or not the ad group can spend its budget and bid on inventory. If the ad group's parent line item is not active, the ad group can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`. + */ + entityStatus?: string | null; + /** + * The unique ID of the line item that the ad group belongs to. + */ + lineItemId?: string | null; + /** + * The resource name of the ad group. + */ + name?: string | null; + /** + * The settings of the product feed in this ad group. + */ + productFeedData?: Schema$ProductFeedData; + /** + * The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group. + */ + targetingExpansion?: Schema$TargetingExpansionConfig; + } + /** + * A single ad associated with an ad group. + */ + export interface Schema$AdGroupAd { + /** + * The unique ID of the ad. Assigned by the system. + */ + adGroupAdId?: string | null; + /** + * The unique ID of the ad group that the ad belongs to. + */ + adGroupId?: string | null; + /** + * List of URLs used by the ad. + */ + adUrls?: Schema$AdUrl[]; + /** + * The unique ID of the advertiser the ad belongs to. + */ + advertiserId?: string | null; + /** + * Details of an [audio ad](//support.google.com/displayvideo/answer/6274216) used for reach marketing objectives. + */ + audioAd?: Schema$AudioAd; + /** + * Details of a [non-skippable short video ad](//support.google.com/displayvideo/answer/6274216), equal to or less than 6 seconds, used for reach. + */ + bumperAd?: Schema$BumperAd; + /** + * The display name of the ad. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Details of an ad sourced from a Display & Video 360 creative. + */ + displayVideoSourceAd?: Schema$DisplayVideoSourceAd; + /** + * The entity status of the ad. + */ + entityStatus?: string | null; + /** + * Details of an [in-stream ad skippable after 5 seconds](//support.google.com/displayvideo/answer/6274216), used for brand awareness or reach marketing objectives. + */ + inStreamAd?: Schema$InStreamAd; + /** + * Details of an [ad served on the YouTube Home feed](//support.google.com/google-ads/answer/9709826). + */ + mastheadAd?: Schema$MastheadAd; + /** + * The resource name of the ad. + */ + name?: string | null; + /** + * Details of a [non-skippable short in-stream video ad](//support.google.com/displayvideo/answer/6274216), between 6 and 15 seconds, used for reach marketing objectives. + */ + nonSkippableAd?: Schema$NonSkippableAd; + /** + * Details of an [ad promoting a video](//support.google.com/displayvideo/answer/6274216) that shows in places of discovery. + */ + videoDiscoverAd?: Schema$VideoDiscoveryAd; + /** + * Details of an [ad used in a video action campaign](//support.google.com/google-ads/answer/10147229) to drive actions to the business, service or product. + */ + videoPerformanceAd?: Schema$VideoPerformanceAd; + } + /** + * Wrapper object associating an AssignedTargetingOption resource and the ad group it is assigned to. + */ + export interface Schema$AdGroupAssignedTargetingOption { + /** + * The ID of the ad group the assigned targeting option is assigned to. + */ + adGroupId?: string | null; + /** + * The assigned targeting option resource. + */ + assignedTargetingOption?: Schema$AssignedTargetingOption; + } + /** + * Details of Adloox settings. + */ + export interface Schema$Adloox { + /** + * Adloox's brand safety settings. + */ + excludedAdlooxCategories?: string[] | null; + } + /** + * Additional URLs related to the ad, including beacons. + */ + export interface Schema$AdUrl { + /** + * The type of the Ad URL. + */ + type?: string | null; + /** + * The URL string value. + */ + url?: string | null; + } + /** + * A single advertiser in Display & Video 360 (DV360). + */ + export interface Schema$Advertiser { + /** + * Required. Immutable. Ad server related settings of the advertiser. + */ + adServerConfig?: Schema$AdvertiserAdServerConfig; + /** + * Output only. The unique ID of the advertiser. Assigned by the system. + */ + advertiserId?: string | null; + /** + * Required. Billing related settings of the advertiser. + */ + billingConfig?: Schema$AdvertiserBillingConfig; + /** + * Required. Creative related settings of the advertiser. + */ + creativeConfig?: Schema$AdvertiserCreativeConfig; + /** + * Settings that control how advertiser data may be accessed. + */ + dataAccessConfig?: Schema$AdvertiserDataAccessConfig; + /** + * Required. The display name of the advertiser. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * 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. + */ + entityStatus?: string | null; + /** + * Required. General settings of the advertiser. + */ + generalConfig?: Schema$AdvertiserGeneralConfig; + /** + * 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. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The resource name of the advertiser. + */ + name?: string | null; + /** + * Required. Immutable. The unique ID of the partner that the advertiser belongs to. + */ + partnerId?: string | null; + /** + * 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. + */ + prismaEnabled?: boolean | null; + /** + * Targeting settings related to ad serving of the advertiser. + */ + servingConfig?: Schema$AdvertiserTargetingConfig; + /** + * Output only. The timestamp when the advertiser was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Ad server related settings of an advertiser. + */ + export interface Schema$AdvertiserAdServerConfig { + /** + * The configuration for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. + */ + cmHybridConfig?: Schema$CmHybridConfig; + /** + * The configuration for advertisers that use third-party ad servers only. + */ + thirdPartyOnlyConfig?: Schema$ThirdPartyOnlyConfig; + } + /** + * Billing related settings of an advertiser. + */ + export interface Schema$AdvertiserBillingConfig { + /** + * The ID of a billing profile assigned to the advertiser. + */ + billingProfileId?: string | null; + } + /** + * Creatives related settings of an advertiser. + */ + export interface Schema$AdvertiserCreativeConfig { + /** + * Whether or not the advertiser is enabled for dynamic creatives. + */ + dynamicCreativeEnabled?: boolean | null; + /** + * 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. + */ + iasClientId?: string | null; + /** + * 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. + */ + obaComplianceDisabled?: boolean | null; + /** + * 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. + */ + videoCreativeDataSharingAuthorized?: boolean | null; + } + /** + * Settings that control how advertiser related data may be accessed. + */ + export interface Schema$AdvertiserDataAccessConfig { + /** + * Structured Data Files (SDF) settings for the advertiser. If not specified, the SDF settings of the parent partner are used. + */ + sdfConfig?: Schema$AdvertiserSdfConfig; + } + /** + * General settings of an advertiser. + */ + export interface Schema$AdvertiserGeneralConfig { + /** + * 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 + */ + currencyCode?: string | null; + /** + * 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 + */ + domainUrl?: string | null; + /** + * 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. + */ + timeZone?: string | null; + } + /** + * Structured Data Files (SDF) settings of an advertiser. + */ + export interface Schema$AdvertiserSdfConfig { + /** + * 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. + */ + overridePartnerSdfConfig?: boolean | null; + /** + * The SDF configuration for the advertiser. * Required when overridePartnerSdfConfig is `true`. * Output only when overridePartnerSdfConfig is `false`. + */ + sdfConfig?: Schema$SdfConfig; + } + /** + * Targeting settings related to ad serving of an advertiser. + */ + export interface Schema$AdvertiserTargetingConfig { + /** + * Whether or not connected TV devices are exempt from viewability targeting for all video line items under the advertiser. + */ + exemptTvFromViewabilityTargeting?: boolean | null; + } + /** + * Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + export interface Schema$AgeRangeAssignedTargetingOptionDetails { + /** + * Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age. + */ + ageRange?: string | null; + } + /** + * Represents a targetable age range. This will be populated in the age_range_details field when targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + export interface Schema$AgeRangeTargetingOptionDetails { + /** + * Output only. The age range of an audience. + */ + ageRange?: string | null; + } + /** + * Rule-based algorithm. + */ + export interface Schema$AlgorithmRules { + /** + * Rules for the impression signals. + */ + impressionSignalRuleset?: Schema$AlgorithmRulesRuleset; + } + /** + * A value to compare the signal to. + */ + export interface Schema$AlgorithmRulesComparisonValue { + /** + * Boolean value. + */ + boolValue?: boolean | null; + /** + * Creative dimension value. + */ + creativeDimensionValue?: Schema$Dimensions; + /** + * Day and time value. Only `TIME_ZONE_RESOLUTION_END_USER` is supported. + */ + dayAndTimeValue?: Schema$DayAndTime; + /** + * Device type value. + */ + deviceTypeValue?: string | null; + /** + * Double value. + */ + doubleValue?: number | null; + /** + * Environment value. + */ + environmentValue?: string | null; + /** + * Exchange value. + */ + exchangeValue?: string | null; + /** + * Integer value. + */ + int64Value?: string | null; + /** + * Ad position value. + */ + onScreenPositionValue?: string | null; + /** + * String value. + */ + stringValue?: string | null; + } + /** + * Set of conditions. The return value of the rule is either: * The return value for single met condition or * The defined default return value if no conditions are met. + */ + export interface Schema$AlgorithmRulesRule { + /** + * List of conditions in this rule. The criteria among conditions should be mutually exclusive. + */ + conditions?: Schema$AlgorithmRulesRuleCondition[]; + /** + * The default return value applied when none of the conditions are met. + */ + defaultReturnValue?: Schema$AlgorithmRulesSignalValue; + } + /** + * Set of signal comparisons. Equivalent of an `if` statement. + */ + export interface Schema$AlgorithmRulesRuleCondition { + /** + * The value returned if the `signalComparisons` condition evaluates to `TRUE`. + */ + returnValue?: Schema$AlgorithmRulesSignalValue; + /** + * List of comparisons that build `if` statement condition. The comparisons are combined into a single condition with `AND` logical operators. + */ + signalComparisons?: Schema$AlgorithmRulesSignalComparison[]; + } + /** + * A ruleset consisting of a list of rules and how to aggregate the resulting values. + */ + export interface Schema$AlgorithmRulesRuleset { + /** + * How to aggregate values of evaluated rules. + */ + aggregationType?: string | null; + /** + * Maximum value the ruleset can evaluate to. + */ + maxValue?: number | null; + /** + * List of rules to generate the impression value. + */ + rules?: Schema$AlgorithmRulesRule[]; + } + /** + * Signal used to evaluate rules. + */ + export interface Schema$AlgorithmRulesSignal { + /** + * Signal based on impressions. + */ + impressionSignal?: string | null; + } + /** + * A single comparison. The comparison compares the `signal` to the `comparisonValue`. The comparison of `siteId==123` is represented with the following field values: * `signal` has an `impressionSignal` of `SITE_ID`. * `comparisonOperator` is set to `EQUAL`. * `comparisonValue` is set to 123. + */ + export interface Schema$AlgorithmRulesSignalComparison { + /** + * Operator used to compare the two values. In the resulting experession, the `signal` will be the first value and the `comparisonValue will be the second. + */ + comparisonOperator?: string | null; + /** + * Value to compare signal to. + */ + comparisonValue?: Schema$AlgorithmRulesComparisonValue; + /** + * Signal to compare. + */ + signal?: Schema$AlgorithmRulesSignal; + } + /** + * Adjusted value of the signal used for rule evaluation. + */ + export interface Schema$AlgorithmRulesSignalValue { + /** + * Value to use as result. + */ + number?: number | null; + } + /** + * Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. + */ + export interface Schema$AppAssignedTargetingOptionDetails { + /** + * 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`. + */ + appId?: string | null; + /** + * 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. + */ + appPlatform?: string | null; + /** + * Output only. The display name of the app. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * 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`. + */ + export interface Schema$AppCategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the app category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$AppCategoryTargetingOptionDetails { + /** + * Output only. The name of the app collection. + */ + displayName?: string | null; + } + /** + * A single asset. + */ + export interface Schema$Asset { + /** + * The asset content. For uploaded assets, the content is the serving path. + */ + content?: string | null; + /** + * Media ID of the uploaded asset. This is a unique identifier for the asset. This ID can be passed to other API calls, e.g. CreateCreative to associate the asset with a creative. The Media ID space updated on **April 5, 2023**. Update media IDs cached before **April 5, 2023** by retrieving the new media ID from associated creative resources or re-uploading the asset. + */ + mediaId?: string | null; + } + /** + * Asset association for the creative. + */ + export interface Schema$AssetAssociation { + /** + * The associated asset. + */ + asset?: Schema$Asset; + /** + * The role of this asset for the creative. + */ + role?: string | null; + } + /** + * An assignment between a targetable inventory source and an inventory source group. + */ + export interface Schema$AssignedInventorySource { + /** + * 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. + */ + assignedInventorySourceId?: string | null; + /** + * Required. The ID of the inventory source entity being targeted. + */ + inventorySourceId?: string | null; + /** + * Output only. The resource name of the assigned inventory source. + */ + name?: string | null; + } + /** + * An assignment between a location list and a relevant targeting option. + */ + export interface Schema$AssignedLocation { + /** + * 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. + */ + assignedLocationId?: string | null; + /** + * Output only. The resource name of the assigned location. + */ + name?: string | null; + /** + * Required. The ID of the targeting option assigned to the location list. + */ + targetingOptionId?: string | null; + } + /** + * A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings. + */ + export interface Schema$AssignedTargetingOption { + /** + * Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`. + */ + ageRangeDetails?: Schema$AgeRangeAssignedTargetingOptionDetails; + /** + * App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`. + */ + appCategoryDetails?: Schema$AppCategoryAssignedTargetingOptionDetails; + /** + * App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`. + */ + appDetails?: Schema$AppAssignedTargetingOptionDetails; + /** + * 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. + */ + assignedTargetingOptionId?: string | null; + /** + * Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` + */ + assignedTargetingOptionIdAlias?: string | null; + /** + * 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. + */ + audienceGroupDetails?: Schema$AudienceGroupAssignedTargetingOptionDetails; + /** + * Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. + */ + audioContentTypeDetails?: Schema$AudioContentTypeAssignedTargetingOptionDetails; + /** + * 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. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails; + /** + * Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`. + */ + browserDetails?: Schema$BrowserAssignedTargetingOptionDetails; + /** + * Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + businessChainDetails?: Schema$BusinessChainAssignedTargetingOptionDetails; + /** + * Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + carrierAndIspDetails?: Schema$CarrierAndIspAssignedTargetingOptionDetails; + /** + * 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. + */ + categoryDetails?: Schema$CategoryAssignedTargetingOptionDetails; + /** + * Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`. + */ + channelDetails?: Schema$ChannelAssignedTargetingOptionDetails; + /** + * Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + contentDurationDetails?: Schema$ContentDurationAssignedTargetingOptionDetails; + /** + * Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + contentGenreDetails?: Schema$ContentGenreAssignedTargetingOptionDetails; + /** + * Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionAssignedTargetingOptionDetails; + /** + * Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionAssignedTargetingOptionDetails; + /** + * Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. + */ + contentStreamTypeDetails?: Schema$ContentStreamTypeAssignedTargetingOptionDetails; + /** + * Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`. + */ + dayAndTimeDetails?: Schema$DayAndTimeAssignedTargetingOptionDetails; + /** + * Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelAssignedTargetingOptionDetails; + /** + * Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + deviceTypeDetails?: Schema$DeviceTypeAssignedTargetingOptionDetails; + /** + * 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. + */ + digitalContentLabelExclusionDetails?: Schema$DigitalContentLabelAssignedTargetingOptionDetails; + /** + * Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + environmentDetails?: Schema$EnvironmentAssignedTargetingOptionDetails; + /** + * Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + exchangeDetails?: Schema$ExchangeAssignedTargetingOptionDetails; + /** + * Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`. + */ + genderDetails?: Schema$GenderAssignedTargetingOptionDetails; + /** + * Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + geoRegionDetails?: Schema$GeoRegionAssignedTargetingOptionDetails; + /** + * Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. + */ + householdIncomeDetails?: Schema$HouseholdIncomeAssignedTargetingOptionDetails; + /** + * Output only. The inheritance status of the assigned targeting option. + */ + inheritance?: string | null; + /** + * Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + inventorySourceDetails?: Schema$InventorySourceAssignedTargetingOptionDetails; + /** + * Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. + */ + inventorySourceGroupDetails?: Schema$InventorySourceGroupAssignedTargetingOptionDetails; + /** + * 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. + */ + keywordDetails?: Schema$KeywordAssignedTargetingOptionDetails; + /** + * Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + languageDetails?: Schema$LanguageAssignedTargetingOptionDetails; + /** + * Output only. The resource name for this assigned targeting option. + */ + name?: string | null; + /** + * Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. + */ + nativeContentPositionDetails?: Schema$NativeContentPositionAssignedTargetingOptionDetails; + /** + * 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. + */ + negativeKeywordListDetails?: Schema$NegativeKeywordListAssignedTargetingOptionDetails; + /** + * Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`. + */ + omidDetails?: Schema$OmidAssignedTargetingOptionDetails; + /** + * On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + onScreenPositionDetails?: Schema$OnScreenPositionAssignedTargetingOptionDetails; + /** + * Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + operatingSystemDetails?: Schema$OperatingSystemAssignedTargetingOptionDetails; + /** + * Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. + */ + parentalStatusDetails?: Schema$ParentalStatusAssignedTargetingOptionDetails; + /** + * POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`. + */ + poiDetails?: Schema$PoiAssignedTargetingOptionDetails; + /** + * Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. + */ + proximityLocationListDetails?: Schema$ProximityLocationListAssignedTargetingOptionDetails; + /** + * Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. + */ + regionalLocationListDetails?: Schema$RegionalLocationListAssignedTargetingOptionDetails; + /** + * 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. + */ + sensitiveCategoryExclusionDetails?: Schema$SensitiveCategoryAssignedTargetingOptionDetails; + /** + * Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`. + */ + sessionPositionDetails?: Schema$SessionPositionAssignedTargetingOptionDetails; + /** + * Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. + */ + subExchangeDetails?: Schema$SubExchangeAssignedTargetingOptionDetails; + /** + * Output only. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + /** + * Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. + */ + thirdPartyVerifierDetails?: Schema$ThirdPartyVerifierAssignedTargetingOptionDetails; + /** + * URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`. + */ + urlDetails?: Schema$UrlAssignedTargetingOptionDetails; + /** + * User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + userRewardedContentDetails?: Schema$UserRewardedContentAssignedTargetingOptionDetails; + /** + * Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeAssignedTargetingOptionDetails; + /** + * Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource. + */ + viewabilityDetails?: Schema$ViewabilityAssignedTargetingOptionDetails; + /** + * YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + */ + youtubeChannelDetails?: Schema$YoutubeChannelAssignedTargetingOptionDetails; + /** + * YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + */ + youtubeVideoDetails?: Schema$YoutubeVideoAssignedTargetingOptionDetails; + } + /** + * A single assigned user role, which defines a user's authorized interaction with a specified partner or advertiser. + */ + export interface Schema$AssignedUserRole { + /** + * The ID of the advertiser that the assigend user role applies to. + */ + advertiserId?: string | null; + /** + * Output only. The ID of the assigned user role. + */ + assignedUserRoleId?: string | null; + /** + * The ID of the partner that the assigned user role applies to. + */ + partnerId?: string | null; + /** + * Required. The user role to assign to a user for the entity. + */ + userRole?: string | null; + } + /** + * 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. + */ + export interface Schema$AudienceGroupAssignedTargetingOptionDetails { + /** + * 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. + */ + excludedFirstAndThirdPartyAudienceGroup?: Schema$FirstAndThirdPartyAudienceGroup; + /** + * 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. + */ + excludedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; + /** + * The combined audience ids of the included combined audience group. Contains combined audience ids only. + */ + includedCombinedAudienceGroup?: Schema$CombinedAudienceGroup; + /** + * The custom list ids of the included custom list group. Contains custom list ids only. + */ + includedCustomListGroup?: Schema$CustomListGroup; + /** + * The first and third party audience ids and recencies of included first and third party audience groups. Each first and third party audience group contains first and third party audience ids only. The relation between each first and third party audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with same settings will be ignored. + */ + includedFirstAndThirdPartyAudienceGroups?: Schema$FirstAndThirdPartyAudienceGroup[]; + /** + * The Google audience ids of the included Google audience group. Contains Google audience ids only. + */ + includedGoogleAudienceGroup?: Schema$GoogleAudienceGroup; + } + /** + * Details for an audio ad. + */ + export interface Schema$AudioAd { + /** + * The webpage address that appears with the ad. + */ + displayUrl?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The YouTube video of the ad. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * 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. + */ + export interface Schema$AudioContentTypeAssignedTargetingOptionDetails { + /** + * Required. The audio content type. + */ + audioContentType?: string | null; + } + /** + * 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`. + */ + export interface Schema$AudioContentTypeTargetingOptionDetails { + /** + * Output only. The audio content type. + */ + audioContentType?: string | null; + } + /** + * The length an audio or a video has been played. + */ + export interface Schema$AudioVideoOffset { + /** + * The offset in percentage of the audio or video duration. + */ + percentage?: string | null; + /** + * The offset in seconds from the start of the audio or video. + */ + seconds?: string | null; + } + /** + * Response message for AdvertiserService.AuditAdvertiser. + */ + export interface Schema$AuditAdvertiserResponse { + /** + * 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 + */ + adGroupCriteriaCount?: string | null; + /** + * 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 + */ + campaignCriteriaCount?: string | null; + /** + * The number of channels created under this advertiser. These channels count towards the limit of 1000 channels per advertiser. + */ + channelsCount?: string | null; + /** + * 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. + */ + negativeKeywordListsCount?: string | null; + /** + * 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. + */ + negativelyTargetedChannelsCount?: string | null; + /** + * The number of ACTIVE and PAUSED campaigns under this advertiser. These campaigns count towards the limit of 9999 campaigns per advertiser. + */ + usedCampaignsCount?: string | null; + /** + * 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. + */ + usedInsertionOrdersCount?: string | null; + /** + * 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. + */ + usedLineItemsCount?: string | null; + } + /** + * Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. + */ + export interface Schema$AuthorizedSellerStatusAssignedTargetingOptionDetails { + /** + * Output only. The authorized seller status to target. + */ + authorizedSellerStatus?: string | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$AuthorizedSellerStatusTargetingOptionDetails { + /** + * Output only. The authorized seller status. + */ + authorizedSellerStatus?: string | null; + } + /** + * Settings that control the bid strategy. Bid strategy determines the bid price. + */ + export interface Schema$BiddingStrategy { + /** + * A strategy that uses a fixed bid price. + */ + fixedBid?: Schema$FixedBidStrategy; + /** + * 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`. + */ + maximizeSpendAutoBid?: Schema$MaximizeSpendBidStrategy; + /** + * 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. + */ + performanceGoalAutoBid?: Schema$PerformanceGoalBidStrategy; + /** + * A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity. + */ + youtubeAndPartnersBid?: Schema$YoutubeAndPartnersBiddingStrategy; + } + /** + * Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserAssignedTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + /** + * 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. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable browser. This will be populated in the browser_details field when targeting_type is `TARGETING_TYPE_BROWSER`. + */ + export interface Schema$BrowserTargetingOptionDetails { + /** + * Output only. The display name of the browser. + */ + displayName?: string | null; + } + /** + * Summarized information of an individual campaign budget. + */ + export interface Schema$BudgetSummary { + /** + * 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. + */ + externalBudgetId?: string | null; + /** + * 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. + */ + preTaxAmountMicros?: string | null; + /** + * 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. + */ + prismaCpeCode?: Schema$PrismaCpeCode; + /** + * 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. + */ + taxAmountMicros?: string | null; + /** + * 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. + */ + totalAmountMicros?: string | null; + } + /** + * Request message for BulkEditAdvertiserAssignedTargetingOptions. + */ + export interface Schema$BulkEditAdvertiserAssignedTargetingOptionsRequest { + /** + * 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` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * 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` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + } + export interface Schema$BulkEditAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options that have been successfully created. This list will be absent if empty. + */ + createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; + } + /** + * Request message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesRequest { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to these assigned inventory sources. + */ + advertiserId?: string | null; + /** + * The assigned inventory sources to create in bulk, specified as a list of AssignedInventorySources. + */ + createdAssignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * The IDs of the assigned inventory sources to delete in bulk, specified as a list of assigned_inventory_source_ids. + */ + deletedAssignedInventorySources?: string[] | null; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to these assigned inventory sources. + */ + partnerId?: string | null; + } + /** + * Response message for AssignedInventorySourceService.BulkEdit. + */ + export interface Schema$BulkEditAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources that have been successfully created. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + } + /** + * Request message for AssignedLocationService.BulkEditAssignedLocations. + */ + export interface Schema$BulkEditAssignedLocationsRequest { + /** + * The assigned locations to create in bulk, specified as a list of AssignedLocation resources. + */ + createdAssignedLocations?: Schema$AssignedLocation[]; + /** + * The IDs of the assigned locations to delete in bulk, specified as a list of assignedLocationId values. + */ + deletedAssignedLocations?: string[] | null; + } + export interface Schema$BulkEditAssignedLocationsResponse { + /** + * The list of assigned locations that have been successfully created. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + } + /** + * Request message for BulkEditLineItemsAssignedTargetingOptions. + */ + export interface Schema$BulkEditAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of CreateAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of DeleteAssignedTargetingOptionsRequest. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + /** + * Required. The ID of the line items whose targeting is being updated. + */ + lineItemIds?: string[] | null; + } + export interface Schema$BulkEditAssignedTargetingOptionsResponse { + /** + * The error information for each line item that failed to update. + */ + errors?: Schema$Status[]; + /** + * Output only. The IDs of the line items which failed. + */ + failedLineItemIds?: string[] | null; + /** + * Output only. The IDs of the line items which successfully updated. + */ + updatedLineItemIds?: string[] | null; + } + /** + * Request message for BulkEditAssignedUserRoles. + */ + export interface Schema$BulkEditAssignedUserRolesRequest { + /** + * The assigned user roles to create in batch, specified as a list of AssignedUserRoles. + */ + createdAssignedUserRoles?: Schema$AssignedUserRole[]; + /** + * 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`. + */ + deletedAssignedUserRoles?: string[] | null; + } + export interface Schema$BulkEditAssignedUserRolesResponse { + /** + * The list of assigned user roles that have been successfully created. This list will be absent if empty. + */ + createdAssignedUserRoles?: Schema$AssignedUserRole[]; + } + /** + * Request message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsRequest { + /** + * The negative keywords to create in batch, specified as a list of NegativeKeywords. + */ + createdNegativeKeywords?: Schema$NegativeKeyword[]; + /** + * The negative keywords to delete in batch, specified as a list of keyword_values. + */ + deletedNegativeKeywords?: string[] | null; + } + /** + * Response message for NegativeKeywordService.BulkEditNegativeKeywords. + */ + export interface Schema$BulkEditNegativeKeywordsResponse { + /** + * The list of negative keywords that have been successfully created. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Request message for BulkEditPartnerAssignedTargetingOptions. + */ + export interface Schema$BulkEditPartnerAssignedTargetingOptionsRequest { + /** + * The assigned targeting options to create in batch, specified as a list of `CreateAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + createRequests?: Schema$CreateAssignedTargetingOptionsRequest[]; + /** + * The assigned targeting options to delete in batch, specified as a list of `DeleteAssignedTargetingOptionsRequest`. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + deleteRequests?: Schema$DeleteAssignedTargetingOptionsRequest[]; + } + export interface Schema$BulkEditPartnerAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options that have been successfully created. This list will be absent if empty. + */ + createdAssignedTargetingOptions?: Schema$AssignedTargetingOption[]; + } + /** + * Request message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesRequest { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string | null; + /** + * The sites to create in batch, specified as a list of Sites. + */ + createdSites?: Schema$Site[]; + /** + * The sites to delete in batch, specified as a list of site url_or_app_ids. + */ + deletedSites?: string[] | null; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string | null; + } + /** + * Response message for SiteService.BulkEditSites. + */ + export interface Schema$BulkEditSitesResponse { + /** + * The list of sites that have been successfully created. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } + export interface Schema$BulkListAdGroupAssignedTargetingOptionsResponse { + /** + * The list of wrapper objects, each providing an assigned targeting option and the ad group it is assigned to. This list will be absent if empty. + */ + adGroupAssignedTargetingOptions?: Schema$AdGroupAssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent call to `BulkListAdGroupAssignedTargetingOptions` to fetch the next page of results. This token will be absent if there are no more AdGroupAssignedTargetingOption resources to return. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListAssignedTargetingOptionsResponse { + /** + * 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. + */ + lineItemAssignedTargetingOptions?: Schema$LineItemAssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListCampaignAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$BulkListInsertionOrderAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Request message for LineItemService.BulkUpdateLineItems. + */ + export interface Schema$BulkUpdateLineItemsRequest { + /** + * Required. IDs of line items to update. + */ + lineItemIds?: string[] | null; + /** + * 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." + */ + targetLineItem?: Schema$LineItem; + /** + * Required. A field mask identifying which fields to update. Only the following fields are currently supported: * entityStatus + */ + updateMask?: string | null; + } + /** + * Response message for LineItemService.BulkUpdateLineItems. + */ + export interface Schema$BulkUpdateLineItemsResponse { + /** + * Errors returned by line items that failed to update. + */ + errors?: Schema$Status[]; + /** + * The IDs of line items that failed to update. + */ + failedLineItemIds?: string[] | null; + /** + * 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. + */ + skippedLineItemIds?: string[] | null; + /** + * The IDs of successfully updated line items. + */ + updatedLineItemIds?: string[] | null; + } + /** + * Details for a bumper ad. + */ + export interface Schema$BumperAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + } + /** + * 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`. + */ + export interface Schema$BusinessChainAssignedTargetingOptionDetails { + /** + * Output only. The display name of a business chain, e.g. "KFC", "Chase Bank". + */ + displayName?: string | null; + /** + * 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. + */ + proximityRadiusAmount?: number | null; + /** + * Required. The unit of distance by which the targeting radius is measured. + */ + proximityRadiusUnit?: string | null; + /** + * 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. + */ + targetingOptionId?: string | null; + } + /** + * Search terms for Business Chain targeting options. At least one of the field should be populated. + */ + export interface Schema$BusinessChainSearchTerms { + /** + * The search query for the desired business chain. The query must be the full name of the business, e.g. "KFC", "mercedes-benz". + */ + businessChainQuery?: string | null; + /** + * The search query for the desired geo region, e.g. "Seattle", "United State". + */ + regionQuery?: string | null; + } + /** + * 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`. + */ + export interface Schema$BusinessChainTargetingOptionDetails { + /** + * Output only. The display name of the business chain, e.g. "KFC", "Chase Bank". + */ + businessChain?: string | null; + /** + * Output only. The display name of the geographic region, e.g. "Ontario, Canada". + */ + geoRegion?: string | null; + /** + * Output only. The type of the geographic region. + */ + geoRegionType?: string | null; + } + /** + * A single campaign. + */ + export interface Schema$Campaign { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string | null; + /** + * The list of budgets available to this campaign. If this field is not set, the campaign uses an unlimited budget. + */ + campaignBudgets?: Schema$CampaignBudget[]; + /** + * Required. The planned spend and duration of the campaign. + */ + campaignFlight?: Schema$CampaignFlight; + /** + * Required. The goal of the campaign. + */ + campaignGoal?: Schema$CampaignGoal; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string | null; + /** + * Required. The display name of the campaign. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * 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. + */ + entityStatus?: string | null; + /** + * Required. The frequency cap setting of the campaign. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The resource name of the campaign. + */ + name?: string | null; + /** + * Output only. The timestamp when the campaign was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how the campaign budget is allocated. + */ + export interface Schema$CampaignBudget { + /** + * 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. + */ + budgetAmountMicros?: string | null; + /** + * 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. + */ + budgetId?: string | null; + /** + * Required. Immutable. Specifies whether the budget is measured in currency or impressions. + */ + budgetUnit?: string | null; + /** + * 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. + */ + dateRange?: Schema$DateRange; + /** + * Required. The display name of the budget. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * 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. + */ + externalBudgetId?: string | null; + /** + * Required. The external source of the budget. + */ + externalBudgetSource?: string | null; + /** + * 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. + */ + invoiceGroupingId?: string | null; + /** + * Additional metadata for use by the Mediaocean Prisma tool. Required for Mediaocean budgets. Only applicable to prisma_enabled advertisers. + */ + prismaConfig?: Schema$PrismaConfig; + } + /** + * Settings that track the planned spend and duration of a campaign. + */ + export interface Schema$CampaignFlight { + /** + * 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. + */ + plannedDates?: Schema$DateRange; + /** + * 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. + */ + plannedSpendAmountMicros?: string | null; + } + /** + * Settings that control the goal of a campaign. + */ + export interface Schema$CampaignGoal { + /** + * Required. The type of the campaign goal. + */ + campaignGoalType?: string | null; + /** + * 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` + */ + performanceGoal?: Schema$PerformanceGoal; + } + /** + * 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`. + */ + export interface Schema$CarrierAndIspAssignedTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * 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. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$CarrierAndIspTargetingOptionDetails { + /** + * Output only. The display name of the carrier or ISP. + */ + displayName?: string | null; + /** + * Output only. The type indicating if it's carrier or ISP. + */ + type?: string | null; + } + /** + * Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryAssignedTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable category. This will be populated in the category_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_CATEGORY`. + */ + export interface Schema$CategoryTargetingOptionDetails { + /** + * Output only. The display name of the category. + */ + displayName?: string | null; + } + /** + * A single channel. Channels are custom groups of related websites and apps. + */ + export interface Schema$Channel { + /** + * The ID of the advertiser that owns the channel. + */ + advertiserId?: string | null; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string | null; + /** + * Required. The display name of the channel. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the channel. + */ + name?: string | null; + /** + * Output only. Number of line items that are directly targeting this channel negatively. + */ + negativelyTargetedLineItemCount?: string | null; + /** + * The ID of the partner that owns the channel. + */ + partnerId?: string | null; + /** + * Output only. Number of line items that are directly targeting this channel positively. + */ + positivelyTargetedLineItemCount?: string | null; + } + /** + * Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. + */ + export interface Schema$ChannelAssignedTargetingOptionDetails { + /** + * 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. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true. + */ + negative?: boolean | null; + } + /** + * Settings for advertisers that use both Campaign Manager 360 (CM360) and third-party ad servers. + */ + export interface Schema$CmHybridConfig { + /** + * Required. Immutable. Account ID of the CM360 Floodlight configuration linked with the DV360 advertiser. + */ + cmAccountId?: string | null; + /** + * Required. Immutable. ID of the CM360 Floodlight configuration linked with the DV360 advertiser. + */ + cmFloodlightConfigId?: string | null; + /** + * 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. + */ + cmFloodlightLinkingAuthorized?: boolean | null; + /** + * 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. + */ + cmSyncableSiteIds?: string[] | null; + /** + * Whether or not to report DV360 cost to CM360. + */ + dv360ToCmCostReportingEnabled?: boolean | null; + /** + * Whether or not to include DV360 data in CM360 data transfer reports. + */ + dv360ToCmDataSharingEnabled?: boolean | null; + } + /** + * A Campaign Manager 360 tracking ad. + */ + export interface Schema$CmTrackingAd { + /** + * The ad ID of the campaign manager 360 tracking Ad. + */ + cmAdId?: string | null; + /** + * The creative ID of the campaign manager 360 tracking Ad. + */ + cmCreativeId?: string | null; + /** + * The placement ID of the campaign manager 360 tracking Ad. + */ + cmPlacementId?: string | null; + } + /** + * Describes a combined audience resource. + */ + export interface Schema$CombinedAudience { + /** + * Output only. The unique ID of the combined audience. Assigned by the system. + */ + combinedAudienceId?: string | null; + /** + * Output only. The display name of the combined audience. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the combined audience. + */ + name?: string | null; + } + /** + * Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CombinedAudienceGroup { + /** + * 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. + */ + settings?: Schema$CombinedAudienceTargetingSetting[]; + } + /** + * Details of combined audience targeting setting. + */ + export interface Schema$CombinedAudienceTargetingSetting { + /** + * Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id. + */ + combinedAudienceId?: string | null; + } + /** + * Common attributes for in-stream, non-skippable and bumper ads. + */ + export interface Schema$CommonInStreamAttribute { + /** + * The text on the call-to-action button. + */ + actionButtonLabel?: string | null; + /** + * The headline of the call-to-action banner. + */ + actionHeadline?: string | null; + /** + * The image which shows next to the video ad. + */ + companionBanner?: Schema$ImageAsset; + /** + * The webpage address that appears with the ad. + */ + displayUrl?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The YouTube video of the ad. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * Contact information defining a Customer Match audience member. + */ + export interface Schema$ContactInfo { + /** + * Country code of the member. Must also be set with the following fields: * hashed_first_name * hashed_last_name * zip_codes + */ + countryCode?: string | null; + /** + * A list of SHA256 hashed email of the member. Before hashing, remove all whitespace and make sure the string is all lowercase. + */ + hashedEmails?: string[] | null; + /** + * 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 + */ + hashedFirstName?: string | null; + /** + * 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 + */ + hashedLastName?: string | null; + /** + * 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. + */ + hashedPhoneNumbers?: string[] | null; + /** + * A list of zip codes of the member. Must also be set with the following fields: * country_code * hashed_first_name * hashed_last_name + */ + zipCodes?: string[] | null; + } + /** + * Wrapper message for a list of contact information defining Customer Match audience members. + */ + export interface Schema$ContactInfoList { + /** + * 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. + */ + contactInfos?: Schema$ContactInfo[]; + } + /** + * 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. + */ + export interface Schema$ContentDurationAssignedTargetingOptionDetails { + /** + * Output only. The content duration. + */ + contentDuration?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content duration. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. + */ + export interface Schema$ContentDurationTargetingOptionDetails { + /** + * Output only. The content duration. + */ + contentDuration?: string | null; + } + /** + * 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. + */ + export interface Schema$ContentGenreAssignedTargetingOptionDetails { + /** + * Output only. The display name of the content genre. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable content genre. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. + */ + export interface Schema$ContentGenreTargetingOptionDetails { + /** + * Output only. The display name of the content genre + */ + displayName?: string | null; + } + /** + * 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`. + */ + export interface Schema$ContentInstreamPositionAssignedTargetingOptionDetails { + /** + * 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`. + */ + adType?: string | null; + /** + * Required. The content instream position for video or audio ads. + */ + contentInstreamPosition?: string | null; + } + /** + * 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`. + */ + export interface Schema$ContentInstreamPositionTargetingOptionDetails { + /** + * Output only. The content instream position. + */ + contentInstreamPosition?: string | null; + } + /** + * 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`. + */ + export interface Schema$ContentOutstreamPositionAssignedTargetingOptionDetails { + /** + * 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`. + */ + adType?: string | null; + /** + * Required. The content outstream position. + */ + contentOutstreamPosition?: string | null; + } + /** + * 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`. + */ + export interface Schema$ContentOutstreamPositionTargetingOptionDetails { + /** + * Output only. The content outstream position. + */ + contentOutstreamPosition?: string | null; + } + /** + * 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. + */ + export interface Schema$ContentStreamTypeAssignedTargetingOptionDetails { + /** + * Output only. The content stream type. + */ + contentStreamType?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$ContentStreamTypeTargetingOptionDetails { + /** + * Output only. The content stream type. + */ + contentStreamType?: string | null; + } + /** + * 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. + */ + export interface Schema$ConversionCountingConfig { + /** + * 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. + */ + floodlightActivityConfigs?: Schema$TrackingFloodlightActivityConfig[]; + /** + * 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. + */ + postViewCountPercentageMillis?: string | null; + } + /** + * Counter event of the creative. + */ + export interface Schema$CounterEvent { + /** + * Required. The name of the counter event. + */ + name?: string | null; + /** + * Required. The name used to identify this counter event in reports. + */ + reportingName?: string | null; + } + /** + * A request message for CreateAsset. + */ + export interface Schema$CreateAssetRequest { + /** + * Required. The filename of the asset, including the file extension. The filename must be UTF-8 encoded with a maximum size of 240 bytes. + */ + filename?: string | null; + } + /** + * A response message for CreateAsset. + */ + export interface Schema$CreateAssetResponse { + /** + * The uploaded asset, if successful. + */ + asset?: Schema$Asset; + } + /** + * A request listing which assigned targeting options of a given targeting type should be created and added. + */ + export interface Schema$CreateAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting options to create and add. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * Request message for [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$CreateSdfDownloadTaskRequest { + /** + * The ID of the advertiser to download SDF for. + */ + advertiserId?: string | null; + /** + * Filters on entities by their entity IDs. + */ + idFilter?: Schema$IdFilter; + /** + * Filters on Inventory Sources by their IDs. + */ + inventorySourceFilter?: Schema$InventorySourceFilter; + /** + * 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. + */ + parentEntityFilter?: Schema$ParentEntityFilter; + /** + * The ID of the partner to download SDF for. + */ + partnerId?: string | null; + /** + * 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. + */ + version?: string | null; + } + /** + * A single Creative. + */ + export interface Schema$Creative { + /** + * Additional dimensions. Applicable when creative_type is one of: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_EXPANDABLE` * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_LIGHTBOX` * `CREATIVE_TYPE_PUBLISHER_HOSTED` If this field is specified, width_pixels and height_pixels are both required and must be greater than or equal to 0. + */ + additionalDimensions?: Schema$Dimensions[]; + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string | null; + /** + * Third-party HTML tracking tag to be appended to the creative tag. + */ + appendedTag?: string | null; + /** + * Required. Assets associated to this creative. + */ + assets?: Schema$AssetAssociation[]; + /** + * 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. + */ + cmPlacementId?: string | null; + /** + * The Campaign Manager 360 tracking ad associated with the creative. Optional for the following creative_type when created by an advertiser that uses both Campaign Manager 360 and third-party ad serving: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` Output only for other cases. + */ + cmTrackingAd?: Schema$CmTrackingAd; + /** + * The IDs of companion creatives for a video creative. You can assign existing display creatives (with image or HTML5 assets) to serve surrounding the publisher's video player. Companions display around the video player while the video is playing and remain after the video has completed. Creatives contain additional dimensions can not be companion creatives. This field is only supported for following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` + */ + companionCreativeIds?: string[] | null; + /** + * Counter events for a rich media creative. Counters track the number of times that a user interacts with any part of a rich media creative in a specified way (mouse-overs, mouse-outs, clicks, taps, data loading, keyboard entries, etc.). Any event that can be captured in the creative can be recorded as a counter. Leave it empty or unset for creatives containing image assets only. + */ + counterEvents?: Schema$CounterEvent[]; + /** + * Output only. The timestamp when the creative was created. Assigned by the system. + */ + createTime?: string | null; + /** + * Output only. A list of attributes of the creative that is generated by the system. + */ + creativeAttributes?: string[] | null; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string | null; + /** + * Required. Immutable. The type of the creative. + */ + creativeType?: string | null; + /** + * Required. Primary dimensions of the creative. Applicable to all creative types. The value of width_pixels and height_pixels defaults to `0` when creative_type is one of: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + dimensions?: Schema$Dimensions; + /** + * Required. The display name of the creative. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. Indicates whether the creative is dynamic. + */ + dynamic?: boolean | null; + /** + * Required. Controls whether or not the creative can serve. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` * `ENTITY_STATUS_PAUSED` + */ + entityStatus?: string | null; + /** + * 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. + */ + exitEvents?: Schema$ExitEvent[]; + /** + * 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` + */ + expandingDirection?: string | null; + /** + * 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` + */ + expandOnHover?: boolean | null; + /** + * Required. Indicates where the creative is hosted. + */ + hostingSource?: string | null; + /** + * 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` + */ + html5Video?: boolean | null; + /** + * 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. + */ + iasCampaignMonitoring?: boolean | null; + /** + * 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. + */ + integrationCode?: string | null; + /** + * JavaScript measurement URL from supported third-party verification providers (ComScore, DoubleVerify, IAS, Moat). HTML script tags are not supported. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + jsTrackerUrl?: string | null; + /** + * 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. + */ + lineItemIds?: string[] | null; + /** + * 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` + */ + mediaDuration?: string | null; + /** + * 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` + */ + mp3Audio?: boolean | null; + /** + * Output only. The resource name of the creative. + */ + name?: string | null; + /** + * User notes for this creative. Must be UTF-8 encoded with a length of no more than 20,000 characters. + */ + notes?: string | null; + /** + * Specifies the OBA icon for a video creative. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + obaIcon?: Schema$ObaIcon; + /** + * 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` + */ + oggAudio?: boolean | null; + /** + * 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` + */ + progressOffset?: Schema$AudioVideoOffset; + /** + * 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` + */ + requireHtml5?: boolean | null; + /** + * 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` + */ + requireMraid?: boolean | null; + /** + * 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` + */ + requirePingForAttribution?: boolean | null; + /** + * Output only. The current status of the creative review process. + */ + reviewStatus?: Schema$ReviewStatusInfo; + /** + * 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` + */ + skipOffset?: Schema$AudioVideoOffset; + /** + * Whether the user can choose to skip a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_VIDEO` + */ + skippable?: boolean | null; + /** + * 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` + */ + thirdPartyTag?: string | null; + /** + * Tracking URLs from third parties to track interactions with a video creative. This field is only supported for the following creative_type: * `CREATIVE_TYPE_AUDIO` * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + thirdPartyUrls?: Schema$ThirdPartyUrl[]; + /** + * Timer custom events for a rich media creative. Timers track the time during which a user views and interacts with a specified part of a rich media creative. A creative can have multiple timer events, each timed independently. Leave it empty or unset for creatives containing image assets only. + */ + timerEvents?: Schema$TimerEvent[]; + /** + * Tracking URLs for analytics providers or third-party ad technology vendors. The URLs must start with https (except on inventory that doesn't require SSL compliance). If using macros in your URL, use only macros supported by Display & Video 360. Standard URLs only, no IMG or SCRIPT tags. This field is only writeable in following creative_type: * `CREATIVE_TYPE_NATIVE` * `CREATIVE_TYPE_NATIVE_SITE_SQUARE` * `CREATIVE_TYPE_NATIVE_VIDEO` + */ + trackerUrls?: string[] | null; + /** + * Output only. Audio/Video transcodes. Display & Video 360 transcodes the main asset into a number of alternative versions that use different file formats or have different properties (resolution, audio bit rate, and video bit rate), each designed for specific video players or bandwidths. These transcodes give a publisher's system more options to choose from for each impression on your video and ensures that the appropriate file serves based on the viewer’s connection and screen size. This field is only supported in following creative_type: * `CREATIVE_TYPE_VIDEO` * `CREATIVE_TYPE_NATIVE_VIDEO` * `CREATIVE_TYPE_AUDIO` + */ + transcodes?: Schema$Transcode[]; + /** + * 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` + */ + universalAdId?: Schema$UniversalAdId; + /** + * Output only. The timestamp when the creative was last updated, either by the user or system (e.g. creative review). Assigned by the system. + */ + updateTime?: string | null; + /** + * 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` + */ + vastTagUrl?: string | null; + /** + * 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` + */ + vpaid?: boolean | null; + } + /** + * Creative requirements configuration for the inventory source. + */ + export interface Schema$CreativeConfig { + /** + * The type of creative that can be assigned to the inventory source. Only the following types are supported: * `CREATIVE_TYPE_STANDARD` * `CREATIVE_TYPE_VIDEO` + */ + creativeType?: string | null; + /** + * The configuration for display creatives. Applicable when creative_type is `CREATIVE_TYPE_STANDARD`. + */ + displayCreativeConfig?: Schema$InventorySourceDisplayCreativeConfig; + /** + * The configuration for video creatives. Applicable when creative_type is `CREATIVE_TYPE_VIDEO`. + */ + videoCreativeConfig?: Schema$InventorySourceVideoCreativeConfig; + } + /** + * A single custom bidding algorithm. + */ + export interface Schema$CustomBiddingAlgorithm { + /** + * Immutable. The unique ID of the advertiser that owns the custom bidding algorithm. + */ + advertiserId?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm. Assigned by the system. + */ + customBiddingAlgorithmId?: string | null; + /** + * Required. Immutable. The type of custom bidding algorithm. + */ + customBiddingAlgorithmType?: string | null; + /** + * Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * `ENTITY_STATUS_ACTIVE` * `ENTITY_STATUS_ARCHIVED` + */ + entityStatus?: string | null; + /** + * 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). + */ + modelDetails?: Schema$CustomBiddingModelDetails[]; + /** + * Output only. The resource name of the custom bidding algorithm. + */ + name?: string | null; + /** + * Immutable. The unique ID of the partner that owns the custom bidding algorithm. + */ + partnerId?: string | null; + /** + * 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). + */ + sharedAdvertiserIds?: string[] | null; + } + /** + * A single custom bidding algorithm rules. + */ + export interface Schema$CustomBiddingAlgorithmRules { + /** + * Output only. Whether the rules resource is currently being used for scoring by the parent algorithm. + */ + active?: boolean | null; + /** + * Output only. The time when the rules resource was created. + */ + createTime?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to. + */ + customBiddingAlgorithmId?: string | null; + /** + * Output only. The unique ID of the rules resource. + */ + customBiddingAlgorithmRulesId?: string | null; + /** + * Output only. Error code of the rejected rules resource. This field will only be populated when the state is `REJECTED`. + */ + error?: Schema$CustomBiddingAlgorithmRulesError; + /** + * Output only. The resource name of the rules resource. + */ + name?: string | null; + /** + * Required. Immutable. The reference to the uploaded AlgorithmRules file. + */ + rules?: Schema$CustomBiddingAlgorithmRulesRef; + /** + * Output only. The state of the rules resource. + */ + state?: string | null; + } + /** + * An error message for a CustomBiddingAlgorithmRules resource. + */ + export interface Schema$CustomBiddingAlgorithmRulesError { + /** + * The type of error. + */ + errorCode?: string | null; + } + /** + * The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules. + */ + export interface Schema$CustomBiddingAlgorithmRulesRef { + /** + * A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format `customBiddingAlgorithms/{custom_bidding_algorithm_id\}/rulesRef/{ref_id\}`. + */ + resourceName?: string | null; + } + /** + * The details of a custom bidding algorithm model for a single shared advertiser. + */ + export interface Schema$CustomBiddingModelDetails { + /** + * The unique ID of the relevant advertiser. + */ + advertiserId?: string | null; + /** + * The readiness state of custom bidding model. + */ + readinessState?: string | null; + /** + * Output only. The suspension state of custom bidding model. + */ + suspensionState?: string | null; + } + /** + * A single custom bidding script. + */ + export interface Schema$CustomBiddingScript { + /** + * Output only. Whether the script is currently being used for scoring by the parent algorithm. + */ + active?: boolean | null; + /** + * Output only. The time when the script was created. + */ + createTime?: string | null; + /** + * Output only. The unique ID of the custom bidding algorithm the script belongs to. + */ + customBiddingAlgorithmId?: string | null; + /** + * Output only. The unique ID of the custom bidding script. + */ + customBiddingScriptId?: string | null; + /** + * Output only. Error details of a rejected custom bidding script. This field will only be populated when state is REJECTED. + */ + errors?: Schema$ScriptError[]; + /** + * Output only. The resource name of the custom bidding script. + */ + name?: string | null; + /** + * The reference to the uploaded script file. + */ + script?: Schema$CustomBiddingScriptRef; + /** + * Output only. The state of the custom bidding script. + */ + state?: string | null; + } + /** + * The reference to the uploaded custom bidding script file. + */ + export interface Schema$CustomBiddingScriptRef { + /** + * 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\}`. + */ + resourceName?: string | null; + } + /** + * The key and value of a custom label. + */ + export interface Schema$CustomLabel { + /** + * The key of the label. + */ + key?: string | null; + /** + * The value of the label. + */ + value?: string | null; + } + /** + * Describes a custom list entity, such as a custom affinity or custom intent audience list. + */ + export interface Schema$CustomList { + /** + * Output only. The unique ID of the custom list. Assigned by the system. + */ + customListId?: string | null; + /** + * Output only. The display name of the custom list. . + */ + displayName?: string | null; + /** + * Output only. The resource name of the custom list. + */ + name?: string | null; + } + /** + * Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$CustomListGroup { + /** + * Required. All custom list targeting settings in custom list group. Repeated settings with same id will be ignored. + */ + settings?: Schema$CustomListTargetingSetting[]; + } + /** + * Details of custom list targeting setting. + */ + export interface Schema$CustomListTargetingSetting { + /** + * Required. Custom id of custom list targeting setting. This id is custom_list_id. + */ + customListId?: string | null; + } + /** + * 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 + */ + export interface Schema$Date { + /** + * 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. + */ + day?: number | null; + /** + * Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + */ + month?: number | null; + /** + * Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + */ + year?: number | null; + } + /** + * A date range. + */ + export interface Schema$DateRange { + /** + * The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + endDate?: Schema$Date; + /** + * The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`. + */ + startDate?: Schema$Date; + } + /** + * Representation of time defined by day of the week and hour of the day. + */ + export interface Schema$DayAndTime { + /** + * Required. Day of the week. + */ + dayOfWeek?: string | null; + /** + * Required. Hour of the day. + */ + hourOfDay?: number | null; + /** + * Required. The mechanism used to determine the relevant timezone. + */ + timeZoneResolution?: string | null; + } + /** + * 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`. + */ + export interface Schema$DayAndTimeAssignedTargetingOptionDetails { + /** + * Required. The day of the week for this day and time targeting setting. + */ + dayOfWeek?: string | null; + /** + * Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day). + */ + endHour?: number | null; + /** + * Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day). + */ + startHour?: number | null; + /** + * Required. The mechanism used to determine which timezone to use for this day and time targeting setting. + */ + timeZoneResolution?: string | null; + } + /** + * A request listing which assigned targeting options of a given targeting type should be deleted. + */ + export interface Schema$DeleteAssignedTargetingOptionsRequest { + /** + * Required. The assigned targeting option IDs to delete. + */ + assignedTargetingOptionIds?: string[] | null; + /** + * Required. Identifies the type of this assigned targeting option. + */ + targetingType?: string | null; + } + /** + * 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`. + */ + export interface Schema$DeviceMakeModelAssignedTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$DeviceMakeModelTargetingOptionDetails { + /** + * Output only. The display name of the device make and model. + */ + displayName?: string | null; + } + /** + * Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. + */ + export interface Schema$DeviceTypeAssignedTargetingOptionDetails { + /** + * Required. The display name of the device type. + */ + deviceType?: string | null; + /** + * 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. + */ + youtubeAndPartnersBidMultiplier?: number | null; + } + /** + * 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`. + */ + export interface Schema$DeviceTypeTargetingOptionDetails { + /** + * Output only. The device type that is used to be targeted. + */ + deviceType?: string | null; + } + /** + * 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`. + */ + export interface Schema$DigitalContentLabelAssignedTargetingOptionDetails { + /** + * Required. The display name of the digital content label rating tier to be EXCLUDED. + */ + excludedContentRatingTier?: string | null; + } + /** + * 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`. + */ + export interface Schema$DigitalContentLabelTargetingOptionDetails { + /** + * Output only. An enum for the content label brand safety tiers. + */ + contentRatingTier?: string | null; + } + /** + * Dimensions. + */ + export interface Schema$Dimensions { + /** + * The height in pixels. + */ + heightPixels?: number | null; + /** + * The width in pixels. + */ + widthPixels?: number | null; + } + /** + * The ad sourced from a DV360 creative. + */ + export interface Schema$DisplayVideoSourceAd { + /** + * The ID of the source creative. + */ + creativeId?: string | null; + } + /** + * Details of DoubleVerify settings. + */ + export interface Schema$DoubleVerify { + /** + * Avoid bidding on apps with the star ratings. + */ + appStarRating?: Schema$DoubleVerifyAppStarRating; + /** + * Avoid bidding on apps with the age rating. + */ + avoidedAgeRatings?: string[] | null; + /** + * DV Brand Safety Controls. + */ + brandSafetyCategories?: Schema$DoubleVerifyBrandSafetyCategories; + /** + * 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 + */ + customSegmentId?: string | null; + /** + * Display viewability settings (applicable to display line items only). + */ + displayViewability?: Schema$DoubleVerifyDisplayViewability; + /** + * Avoid Sites and Apps with historical Fraud & IVT Rates. + */ + fraudInvalidTraffic?: Schema$DoubleVerifyFraudInvalidTraffic; + /** + * Video viewability settings (applicable to video line items only). + */ + videoViewability?: Schema$DoubleVerifyVideoViewability; + } + /** + * Details of DoubleVerify star ratings settings. + */ + export interface Schema$DoubleVerifyAppStarRating { + /** + * Avoid bidding on apps with the star ratings. + */ + avoidedStarRating?: string | null; + /** + * Avoid bidding on apps with insufficient star ratings. + */ + avoidInsufficientStarRating?: boolean | null; + } + /** + * Settings for brand safety controls. + */ + export interface Schema$DoubleVerifyBrandSafetyCategories { + /** + * Brand safety high severity avoidance categories. + */ + avoidedHighSeverityCategories?: string[] | null; + /** + * Brand safety medium severity avoidance categories. + */ + avoidedMediumSeverityCategories?: string[] | null; + /** + * Unknown or unrateable. + */ + avoidUnknownBrandSafetyCategory?: boolean | null; + } + /** + * Details of DoubleVerify display viewability settings. + */ + export interface Schema$DoubleVerifyDisplayViewability { + /** + * Target web and app inventory to maximize IAB viewable rate. + */ + iab?: string | null; + /** + * Target web and app inventory to maximize 100% viewable duration. + */ + viewableDuring?: string | null; + } + /** + * DoubleVerify Fraud & Invalid Traffic settings. + */ + export interface Schema$DoubleVerifyFraudInvalidTraffic { + /** + * Avoid Sites and Apps with historical Fraud & IVT. + */ + avoidedFraudOption?: string | null; + /** + * Insufficient Historical Fraud & IVT Stats. + */ + avoidInsufficientOption?: boolean | null; + } + /** + * Details of DoubleVerify video viewability settings. + */ + export interface Schema$DoubleVerifyVideoViewability { + /** + * Target inventory to maximize impressions with 400x300 or greater player size. + */ + playerImpressionRate?: string | null; + /** + * Target web inventory to maximize IAB viewable rate. + */ + videoIab?: string | null; + /** + * Target web inventory to maximize fully viewable rate. + */ + videoViewableRate?: string | null; + } + /** + * Request message for LineItemService.DuplicateLineItem. + */ + export interface Schema$DuplicateLineItemRequest { + /** + * The display name of the new line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + targetDisplayName?: string | null; + } + export interface Schema$DuplicateLineItemResponse { + /** + * The ID of the created line item. + */ + duplicateLineItemId?: string | null; + } + /** + * Request message for FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. + */ + export interface Schema$EditCustomerMatchMembersRequest { + /** + * Input only. A list of contact information to define the members to be added. + */ + addedContactInfoList?: Schema$ContactInfoList; + /** + * Input only. A list of mobile device IDs to define the members to be added. + */ + addedMobileDeviceIdList?: Schema$MobileDeviceIdList; + /** + * Required. The ID of the owner advertiser of the updated Customer Match FirstAndThirdPartyAudience. + */ + advertiserId?: string | null; + } + /** + * The response of FirstAndThirdPartyAudienceService.EditCustomerMatchMembers. + */ + export interface Schema$EditCustomerMatchMembersResponse { + /** + * Required. The ID of the updated Customer Match FirstAndThirdPartyAudience. + */ + firstAndThirdPartyAudienceId?: string | null; + } + /** + * Request message for GuaranteedOrderService.EditGuaranteedOrderReadAccessors. + */ + export interface Schema$EditGuaranteedOrderReadAccessorsRequest { + /** + * The advertisers to add as read accessors to the guaranteed order. + */ + addedAdvertisers?: string[] | null; + /** + * Required. The partner context in which the change is being made. + */ + partnerId?: string | null; + /** + * 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. + */ + readAccessInherited?: boolean | null; + /** + * The advertisers to remove as read accessors to the guaranteed order. + */ + removedAdvertisers?: string[] | null; + } + export interface Schema$EditGuaranteedOrderReadAccessorsResponse { + /** + * Whether all advertisers of read_write_partner_id have read access to the guaranteed order. + */ + readAccessInherited?: boolean | null; + /** + * The IDs of advertisers with read access to the guaranteed order. + */ + readAdvertiserIds?: string[] | null; + } + /** + * Request message for InventorySourceService.EditInventorySourceReadWriteAccessors. + */ + export interface Schema$EditInventorySourceReadWriteAccessorsRequest { + /** + * 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. + */ + advertisersUpdate?: Schema$EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate; + /** + * Set the partner context as read/write accessor of the inventory source. This will remove all other current read/write advertiser accessors. + */ + assignPartner?: boolean | null; + /** + * Required. The partner context by which the accessors change is being made. + */ + partnerId?: string | null; + } + /** + * Update to the list of advertisers with read/write access to the inventory source. + */ + export interface Schema$EditInventorySourceReadWriteAccessorsRequestAdvertisersUpdate { + /** + * The advertisers to add. + */ + addedAdvertisers?: string[] | null; + /** + * The advertisers to remove. + */ + removedAdvertisers?: string[] | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentAssignedTargetingOptionDetails { + /** + * Required. The serving environment. + */ + environment?: string | null; + } + /** + * Represents a targetable environment. This will be populated in the environment_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. + */ + export interface Schema$EnvironmentTargetingOptionDetails { + /** + * Output only. The serving environment. + */ + environment?: string | null; + } + /** + * Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeAssignedTargetingOptionDetails { + /** + * Required. The enum value for the exchange. + */ + exchange?: string | null; + } + /** + * Settings that control which exchanges are enabled for a partner. + */ + export interface Schema$ExchangeConfig { + /** + * All enabled exchanges in the partner. Duplicate enabled exchanges will be ignored. + */ + enabledExchanges?: Schema$ExchangeConfigEnabledExchange[]; + } + /** + * An enabled exchange in the partner. + */ + export interface Schema$ExchangeConfigEnabledExchange { + /** + * The enabled exchange. + */ + exchange?: string | null; + /** + * Output only. Agency ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. + */ + googleAdManagerAgencyId?: string | null; + /** + * Output only. Network ID of Google Ad Manager. The field is only relevant when Google Ad Manager is the enabled exchange. + */ + googleAdManagerBuyerNetworkId?: string | null; + /** + * Output only. Seat ID of the enabled exchange. + */ + seatId?: string | null; + } + /** + * Exchange review status for the creative. + */ + export interface Schema$ExchangeReviewStatus { + /** + * The exchange reviewing the creative. + */ + exchange?: string | null; + /** + * Status of the exchange review. + */ + status?: string | null; + } + /** + * Represents a targetable exchange. This will be populated in the exchange_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. + */ + export interface Schema$ExchangeTargetingOptionDetails { + /** + * Output only. The type of exchange. + */ + exchange?: string | null; + } + /** + * Exit event of the creative. + */ + export interface Schema$ExitEvent { + /** + * 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. + */ + name?: string | null; + /** + * The name used to identify this event in reports. Leave it empty or unset for creatives containing image assets only. + */ + reportingName?: string | null; + /** + * Required. The type of the exit event. + */ + type?: string | null; + /** + * Required. The click through URL of the exit event. This is required when type is: * `EXIT_EVENT_TYPE_DEFAULT` * `EXIT_EVENT_TYPE_BACKUP` + */ + url?: string | null; + } + /** + * 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. + */ + export interface Schema$FirstAndThirdPartyAudience { + /** + * 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. + */ + activeDisplayAudienceSize?: string | null; + /** + * The app_id matches with the type of the mobile_device_ids being uploaded. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` + */ + appId?: string | null; + /** + * Output only. The source of the audience. + */ + audienceSource?: string | null; + /** + * The type of the audience. + */ + audienceType?: string | null; + /** + * Input only. A list of contact information to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_CONTACT_INFO` + */ + contactInfoList?: Schema$ContactInfoList; + /** + * The user-provided description of the audience. Only applicable to first party audiences. + */ + description?: string | null; + /** + * 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. + */ + displayAudienceSize?: string | null; + /** + * 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. + */ + displayDesktopAudienceSize?: string | null; + /** + * 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. + */ + displayMobileAppAudienceSize?: string | null; + /** + * 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. + */ + displayMobileWebAudienceSize?: string | null; + /** + * The display name of the first and third party audience. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the first and third party audience. Assigned by the system. + */ + firstAndThirdPartyAudienceId?: string | null; + /** + * Whether the audience is a first or third party audience. + */ + firstAndThirdPartyAudienceType?: string | null; + /** + * 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. + */ + gmailAudienceSize?: string | null; + /** + * The duration in days that an entry remains in the audience after the qualifying event. If the audience has no expiration, set the value of this field to 10000. Otherwise, the set value must be greater than 0 and less than or equal to 540. Only applicable to first party audiences. This field is required if one of the following audience_type is used: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + */ + membershipDurationDays?: string | null; + /** + * Input only. A list of mobile device IDs to define the initial audience members. Only applicable to audience_type `CUSTOMER_MATCH_DEVICE_ID` + */ + mobileDeviceIdList?: Schema$MobileDeviceIdList; + /** + * Output only. The resource name of the first and third party audience. + */ + name?: string | null; + /** + * 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. + */ + youtubeAudienceSize?: string | null; + } + /** + * Details of first and third party audience group. All first and third party audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$FirstAndThirdPartyAudienceGroup { + /** + * Required. All first and third party audience targeting settings in first and third party audience group. Repeated settings with same id are not allowed. + */ + settings?: Schema$FirstAndThirdPartyAudienceTargetingSetting[]; + } + /** + * Details of first and third party audience targeting setting. + */ + export interface Schema$FirstAndThirdPartyAudienceTargetingSetting { + /** + * 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. + */ + firstAndThirdPartyAudienceId?: string | null; + /** + * The recency of the first and third party audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used. + */ + recency?: string | null; + } + /** + * A strategy that uses a fixed bidding price. + */ + export interface Schema$FixedBidStrategy { + /** + * 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. + */ + bidAmountMicros?: string | null; + } + /** + * A single Floodlight group. + */ + export interface Schema$FloodlightGroup { + /** + * The Active View video viewability metric configuration for the Floodlight group. + */ + activeViewConfig?: Schema$ActiveViewVideoViewabilityMetricConfig; + /** + * 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: `"<\>`. + */ + customVariables?: {[key: string]: any} | null; + /** + * Required. The display name of the Floodlight group. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string | null; + /** + * 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. + */ + lookbackWindow?: Schema$LookbackWindow; + /** + * Output only. The resource name of the Floodlight group. + */ + name?: string | null; + /** + * Required. The web tag type enabled for the Floodlight group. + */ + webTagType?: string | null; + } + /** + * Settings that control the number of times a user may be shown with the same ad during a given time period. + */ + export interface Schema$FrequencyCap { + /** + * 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. + */ + maxImpressions?: number | null; + /** + * 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. + */ + maxViews?: number | null; + /** + * The time unit in which the frequency cap will be applied. Required when unlimited is `false`. + */ + timeUnit?: string | null; + /** + * 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 + */ + timeUnitCount?: number | null; + /** + * Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable. + */ + unlimited?: boolean | null; + } + /** + * Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. + */ + export interface Schema$GenderAssignedTargetingOptionDetails { + /** + * Required. The gender of the audience. + */ + gender?: string | null; + } + /** + * Represents a targetable gender. This will be populated in the gender_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. + */ + export interface Schema$GenderTargetingOptionDetails { + /** + * Output only. The gender of an audience. + */ + gender?: string | null; + } + /** + * Request message for LineItemService.GenerateDefaultLineItem. + */ + export interface Schema$GenerateDefaultLineItemRequest { + /** + * Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. The unique ID of the insertion order that the line item belongs to. + */ + insertionOrderId?: string | null; + /** + * Required. The type of the line item. + */ + lineItemType?: string | null; + /** + * 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`. + */ + mobileApp?: Schema$MobileApp; + } + /** + * 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`. + */ + export interface Schema$GeoRegionAssignedTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`. + */ + targetingOptionId?: string | null; + } + /** + * Search terms for geo region targeting options. + */ + export interface Schema$GeoRegionSearchTerms { + /** + * The search query for the desired geo region. The query can be a prefix, e.g. "New Yor", "Seattle", "USA", etc. + */ + geoRegionQuery?: string | null; + } + /** + * Represents a targetable geographic region. This will be populated in the geo_region_details field when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + export interface Schema$GeoRegionTargetingOptionDetails { + /** + * Output only. The display name of the geographic region (e.g., "Ontario, Canada"). + */ + displayName?: string | null; + /** + * Output only. The type of geographic region targeting. + */ + geoRegionType?: string | null; + } + /** + * Describes a Google audience resource. Includes Google audience lists. + */ + export interface Schema$GoogleAudience { + /** + * Output only. The display name of the Google audience. . + */ + displayName?: string | null; + /** + * Output only. The unique ID of the Google audience. Assigned by the system. + */ + googleAudienceId?: string | null; + /** + * Output only. The type of Google audience. . + */ + googleAudienceType?: string | null; + /** + * Output only. The resource name of the google audience. + */ + name?: string | null; + } + /** + * Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. + */ + export interface Schema$GoogleAudienceGroup { + /** + * Required. All Google audience targeting settings in Google audience group. Repeated settings with same id will be ignored. + */ + settings?: Schema$GoogleAudienceTargetingSetting[]; + } + /** + * Details of Google audience targeting setting. + */ + export interface Schema$GoogleAudienceTargetingSetting { + /** + * Required. Google audience id of the Google audience targeting setting. This id is google_audience_id. + */ + googleAudienceId?: string | null; + } + /** + * Media resource. + */ + export interface Schema$GoogleBytestreamMedia { + /** + * Name of the media resource. + */ + resourceName?: string | null; + } + /** + * 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. + */ + export interface Schema$GuaranteedOrder { + /** + * 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. + */ + defaultAdvertiserId?: string | null; + /** + * The ID of the default campaign that is assigned to the guaranteed order. The default campaign must belong to the default advertiser. + */ + defaultCampaignId?: string | null; + /** + * Required. The display name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Immutable. The exchange where the guaranteed order originated. + */ + exchange?: string | null; + /** + * Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange\}-{legacy_guaranteed_order_id\}`. + */ + guaranteedOrderId?: string | null; + /** + * 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. + */ + legacyGuaranteedOrderId?: string | null; + /** + * Output only. The resource name of the guaranteed order. + */ + name?: string | null; + /** + * Required. The publisher name of the guaranteed order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + publisherName?: string | null; + /** + * 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. + */ + readAccessInherited?: boolean | null; + /** + * 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. + */ + readAdvertiserIds?: string[] | null; + /** + * The advertiser with read/write access to the guaranteed order. This is also the default advertiser of the guaranteed order. + */ + readWriteAdvertiserId?: string | null; + /** + * The partner with read/write access to the guaranteed order. + */ + readWritePartnerId?: string | null; + /** + * The status settings of the guaranteed order. + */ + status?: Schema$GuaranteedOrderStatus; + /** + * Output only. The timestamp when the guaranteed order was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * The status settings of the guaranteed order. + */ + export interface Schema$GuaranteedOrderStatus { + /** + * 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. + */ + configStatus?: string | null; + /** + * 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`. + */ + entityPauseReason?: string | null; + /** + * 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`. + */ + entityStatus?: string | null; + } + /** + * 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`. + */ + export interface Schema$HouseholdIncomeAssignedTargetingOptionDetails { + /** + * Required. The household income of the audience. + */ + householdIncome?: string | null; + } + /** + * 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`. + */ + export interface Schema$HouseholdIncomeTargetingOptionDetails { + /** + * Output only. The household income of an audience. + */ + householdIncome?: string | null; + } + /** + * A filtering option that filters entities by their entity IDs. + */ + export interface Schema$IdFilter { + /** + * YouTube Ads to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupAdIds?: string[] | null; + /** + * YouTube Ad Groups to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + adGroupIds?: string[] | null; + /** + * Campaigns to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + campaignIds?: string[] | null; + /** + * Insertion Orders to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + insertionOrderIds?: string[] | null; + /** + * Line Items to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + lineItemIds?: string[] | null; + /** + * Media Products to download by ID. All IDs must belong to the same Advertiser or Partner specified in CreateSdfDownloadTaskRequest. + */ + mediaProductIds?: string[] | null; + } + /** + * Meta data of an image asset. + */ + export interface Schema$ImageAsset { + /** + * File size of the image asset in bytes. + */ + fileSize?: string | null; + /** + * Metadata for this image at its original size. + */ + fullSize?: Schema$Dimensions; + /** + * MIME type of the image asset. + */ + mimeType?: string | null; + } + /** + * A single insertion order. + */ + export interface Schema$InsertionOrder { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string | null; + /** + * The bidding strategy of the insertion order. By default, fixed_bid is set. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation settings of the insertion order. + */ + budget?: Schema$InsertionOrderBudget; + /** + * Required. Immutable. The unique ID of the campaign that the insertion order belongs to. + */ + campaignId?: string | null; + /** + * Required. The display name of the insertion order. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * 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. + */ + entityStatus?: string | null; + /** + * Required. The frequency capping setting of the insertion order. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string | null; + /** + * The type of insertion order. If this field is unspecified in creation, the value defaults to `RTB`. + */ + insertionOrderType?: string | null; + /** + * Additional integration details of the insertion order. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Required. The key performance indicator (KPI) of the insertion order. This is represented as referred to as the "Goal" in the Display & Video 360 interface. + */ + kpi?: Schema$Kpi; + /** + * Output only. The resource name of the insertion order. + */ + name?: string | null; + /** + * Required. The budget spending speed setting of the insertion order. + */ + pacing?: Schema$Pacing; + /** + * The partner costs associated with the insertion order. If absent or empty in CreateInsertionOrder method, the newly created insertion order will inherit partner costs from the partner settings. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Output only. The reservation type of the insertion order. + */ + reservationType?: string | null; + /** + * Output only. The timestamp when the insertion order was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Settings that control how insertion order budget is allocated. + */ + export interface Schema$InsertionOrderBudget { + /** + * The type of automation used to manage bid and budget for the insertion order. If this field is unspecified in creation, the value defaults to `INSERTION_ORDER_AUTOMATION_TYPE_NONE`. + */ + automationType?: string | null; + /** + * 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. + */ + budgetSegments?: Schema$InsertionOrderBudgetSegment[]; + /** + * Required. Immutable. The budget unit specifies whether the budget is currency based or impression based. + */ + budgetUnit?: string | null; + } + /** + * Settings that control the budget of a single budget segment. + */ + export interface Schema$InsertionOrderBudgetSegment { + /** + * 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. + */ + budgetAmountMicros?: string | null; + /** + * The budget_id of the campaign budget that this insertion order budget segment is a part of. + */ + campaignBudgetId?: string | null; + /** + * 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. + */ + dateRange?: Schema$DateRange; + /** + * The budget segment description. It can be used to enter Purchase Order information for each budget segment and have that information printed on the invoices. Must be UTF-8 encoded. + */ + description?: string | null; + } + /** + * Details for an in-stream ad. + */ + export interface Schema$InStreamAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + } + /** + * Details of Integral Ad Science settings. + */ + export interface Schema$IntegralAdScience { + /** + * The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999`, inclusive. + */ + customSegmentId?: string[] | null; + /** + * Display Viewability section (applicable to display line items only). + */ + displayViewability?: string | null; + /** + * Ad Fraud settings. + */ + excludedAdFraudRisk?: string | null; + /** + * Brand Safety - **Adult content**. + */ + excludedAdultRisk?: string | null; + /** + * Brand Safety - **Alcohol**. + */ + excludedAlcoholRisk?: string | null; + /** + * Brand Safety - **Drugs**. + */ + excludedDrugsRisk?: string | null; + /** + * Brand Safety - **Gambling**. + */ + excludedGamblingRisk?: string | null; + /** + * Brand Safety - **Hate speech**. + */ + excludedHateSpeechRisk?: string | null; + /** + * Brand Safety - **Illegal downloads**. + */ + excludedIllegalDownloadsRisk?: string | null; + /** + * Brand Safety - **Offensive language**. + */ + excludedOffensiveLanguageRisk?: string | null; + /** + * Brand Safety - **Violence**. + */ + excludedViolenceRisk?: string | null; + /** + * Brand Safety - **Unrateable**. + */ + excludeUnrateable?: boolean | null; + /** + * True advertising quality (applicable to Display line items only). + */ + traqScoreOption?: string | null; + /** + * Video Viewability Section (applicable to video line items only). + */ + videoViewability?: string | null; + } + /** + * Integration details of an entry. + */ + export interface Schema$IntegrationDetails { + /** + * Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters. + */ + details?: string | null; + /** + * 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. + */ + integrationCode?: string | null; + } + /** + * An inventory source. + */ + export interface Schema$InventorySource { + /** + * Whether the inventory source has a guaranteed or non-guaranteed delivery. + */ + commitment?: string | null; + /** + * The creative requirements of the inventory source. Not applicable for auction packages. + */ + creativeConfigs?: Schema$CreativeConfig[]; + /** + * 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. + */ + dealId?: string | null; + /** + * 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`. + */ + deliveryMethod?: string | null; + /** + * The display name of the inventory source. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * The exchange to which the inventory source belongs. + */ + exchange?: string | null; + /** + * Immutable. The ID of the guaranteed order that this inventory source belongs to. Only applicable when commitment is `INVENTORY_SOURCE_COMMITMENT_GUARANTEED`. + */ + guaranteedOrderId?: string | null; + /** + * Output only. The unique ID of the inventory source. Assigned by the system. + */ + inventorySourceId?: string | null; + /** + * Output only. The product type of the inventory source, denoting the way through which it sells inventory. + */ + inventorySourceProductType?: string | null; + /** + * Denotes the type of the inventory source. + */ + inventorySourceType?: string | null; + /** + * Output only. The resource name of the inventory source. + */ + name?: string | null; + /** + * The publisher/seller name of the inventory source. + */ + publisherName?: string | null; + /** + * Required. The rate details of the inventory source. + */ + rateDetails?: Schema$RateDetails; + /** + * Output only. The IDs of advertisers with read-only access to the inventory source. + */ + readAdvertiserIds?: string[] | null; + /** + * 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. + */ + readPartnerIds?: string[] | null; + /** + * 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. + */ + readWriteAccessors?: Schema$InventorySourceAccessors; + /** + * The status settings of the inventory source. + */ + status?: Schema$InventorySourceStatus; + /** + * The time range when this inventory source starts and stops serving. + */ + timeRange?: Schema$TimeRange; + /** + * Output only. The timestamp when the inventory source was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * The partner or advertisers with access to the inventory source. + */ + export interface Schema$InventorySourceAccessors { + /** + * The advertisers with access to the inventory source. All advertisers must belong to the same partner. + */ + advertisers?: Schema$InventorySourceAccessorsAdvertiserAccessors; + /** + * The partner with access to the inventory source. + */ + partner?: Schema$InventorySourceAccessorsPartnerAccessor; + } + /** + * The advertisers with access to the inventory source. + */ + export interface Schema$InventorySourceAccessorsAdvertiserAccessors { + /** + * The IDs of the advertisers. + */ + advertiserIds?: string[] | null; + } + /** + * The partner with access to the inventory source. + */ + export interface Schema$InventorySourceAccessorsPartnerAccessor { + /** + * The ID of the partner. + */ + partnerId?: string | null; + } + /** + * Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. + */ + export interface Schema$InventorySourceAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource. + */ + inventorySourceId?: string | null; + } + /** + * The configuration for display creatives. + */ + export interface Schema$InventorySourceDisplayCreativeConfig { + /** + * The size requirements for display creatives that can be assigned to the inventory source. + */ + creativeSize?: Schema$Dimensions; + } + /** + * A filtering option for filtering on Inventory Source entities. + */ + export interface Schema$InventorySourceFilter { + /** + * 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. + */ + inventorySourceIds?: string[] | null; + } + /** + * A collection of targetable inventory sources. + */ + export interface Schema$InventorySourceGroup { + /** + * Required. The display name of the inventory source group. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string | null; + /** + * Output only. The resource name of the inventory source group. + */ + name?: string | null; + } + /** + * 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`. + */ + export interface Schema$InventorySourceGroupAssignedTargetingOptionDetails { + /** + * Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource. + */ + inventorySourceGroupId?: string | null; + } + /** + * The status related settings of the inventory source. + */ + export interface Schema$InventorySourceStatus { + /** + * 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. + */ + configStatus?: string | null; + /** + * 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`. + */ + entityPauseReason?: string | null; + /** + * 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`. + */ + entityStatus?: string | null; + /** + * 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`. + */ + sellerPauseReason?: string | null; + /** + * 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`. + */ + sellerStatus?: string | null; + } + /** + * The configuration for video creatives. + */ + export interface Schema$InventorySourceVideoCreativeConfig { + /** + * The duration requirements for the video creatives that can be assigned to the inventory source. + */ + duration?: string | null; + } + /** + * A single invoice. + */ + export interface Schema$Invoice { + /** + * 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". + */ + budgetInvoiceGroupingId?: string | null; + /** + * 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". + */ + budgetSummaries?: Schema$BudgetSummary[]; + /** + * 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. + */ + correctedInvoiceId?: string | null; + /** + * The currency used in the invoice in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * The display name of the invoice. + */ + displayName?: string | null; + /** + * The date when the invoice is due. + */ + dueDate?: Schema$Date; + /** + * The unique ID of the invoice. + */ + invoiceId?: string | null; + /** + * The type of invoice document. + */ + invoiceType?: string | null; + /** + * The date when the invoice was issued. + */ + issueDate?: Schema$Date; + /** + * The resource name of the invoice. + */ + name?: string | null; + /** + * 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. + */ + nonBudgetMicros?: string | null; + /** + * The ID of the payments account the invoice belongs to. Appears on the invoice PDF as `Billing Account Number`. + */ + paymentsAccountId?: string | null; + /** + * The ID of the payments profile the invoice belongs to. Appears on the invoice PDF as `Billing ID`. + */ + paymentsProfileId?: string | null; + /** + * 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. + */ + pdfUrl?: string | null; + /** + * Purchase order number associated with the invoice. + */ + purchaseOrderNumber?: string | null; + /** + * 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. + */ + replacedInvoiceIds?: string[] | null; + /** + * The service start and end dates which are covered by this invoice. + */ + serviceDateRange?: Schema$DateRange; + /** + * 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. + */ + subtotalAmountMicros?: string | null; + /** + * The invoice total amount, in micros of the invoice's currency. For example, if currency_code is `USD`, then 1000000 represents one US dollar. + */ + totalAmountMicros?: string | null; + /** + * 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. + */ + totalTaxAmountMicros?: string | null; + } + /** + * Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. + */ + export interface Schema$KeywordAssignedTargetingOptionDetails { + /** + * 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. + */ + keyword?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Settings that control the key performance indicator, or KPI, of an insertion order. + */ + export interface Schema$Kpi { + /** + * The goal amount, in micros of the advertiser's currency. Applicable when kpi_type is one of: * `KPI_TYPE_CPM` * `KPI_TYPE_CPC` * `KPI_TYPE_CPA` * `KPI_TYPE_CPIAVC` * `KPI_TYPE_VCPM` For example: 1500000 represents 1.5 standard units of the currency. + */ + kpiAmountMicros?: string | null; + /** + * The decimal representation of the goal percentage in micros. Applicable when kpi_type is one of: * `KPI_TYPE_CTR` * `KPI_TYPE_VIEWABILITY` * `KPI_TYPE_CLICK_CVR` * `KPI_TYPE_IMPRESSION_CVR` * `KPI_TYPE_VTR` * `KPI_TYPE_AUDIO_COMPLETION_RATE` * `KPI_TYPE_VIDEO_COMPLETION_RATE` For example: 70000 represents 7% (decimal 0.07). + */ + kpiPercentageMicros?: string | null; + /** + * A KPI string, which can be empty. Must be UTF-8 encoded with a length of no more than 100 characters. Applicable when kpi_type is `KPI_TYPE_OTHER`. + */ + kpiString?: string | null; + /** + * Required. The type of KPI. + */ + kpiType?: string | null; + } + /** + * Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageAssignedTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + /** + * 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. + */ + negative?: boolean | null; + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`. + */ + targetingOptionId?: string | null; + } + /** + * Represents a targetable language. This will be populated in the language_details field when targeting_type is `TARGETING_TYPE_LANGUAGE`. + */ + export interface Schema$LanguageTargetingOptionDetails { + /** + * Output only. The display name of the language (e.g., "French"). + */ + displayName?: string | null; + } + /** + * A single line item. + */ + export interface Schema$LineItem { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string | null; + /** + * Required. The bidding strategy of the line item. + */ + bidStrategy?: Schema$BiddingStrategy; + /** + * Required. The budget allocation setting of the line item. + */ + budget?: Schema$LineItemBudget; + /** + * Output only. The unique ID of the campaign that the line item belongs to. + */ + campaignId?: string | null; + /** + * The conversion tracking setting of the line item. + */ + conversionCounting?: Schema$ConversionCountingConfig; + /** + * The IDs of the creatives associated with the line item. + */ + creativeIds?: string[] | null; + /** + * Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * 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`. + */ + entityStatus?: string | null; + /** + * Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default. + */ + excludeNewExchanges?: boolean | null; + /** + * Required. The start and end time of the line item's flight. + */ + flight?: Schema$LineItemFlight; + /** + * Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap. + */ + frequencyCap?: Schema$FrequencyCap; + /** + * Required. Immutable. The unique ID of the insertion order that the line item belongs to. + */ + insertionOrderId?: string | null; + /** + * Integration details of the line item. + */ + integrationDetails?: Schema$IntegrationDetails; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string | null; + /** + * Required. Immutable. The type of the line item. + */ + lineItemType?: string | null; + /** + * 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`. + */ + mobileApp?: Schema$MobileApp; + /** + * Output only. The resource name of the line item. + */ + name?: string | null; + /** + * Required. The budget spending speed setting of the line item. + */ + pacing?: Schema$Pacing; + /** + * 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. + */ + partnerCosts?: Schema$PartnerCost[]; + /** + * Required. The partner revenue model setting of the line item. + */ + partnerRevenueModel?: Schema$PartnerRevenueModel; + /** + * Output only. The reservation type of the line item. + */ + reservationType?: string | null; + /** + * The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. + */ + targetingExpansion?: Schema$TargetingExpansionConfig; + /** + * Output only. The timestamp when the line item was last updated. Assigned by the system. + */ + updateTime?: string | null; + /** + * 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. + */ + warningMessages?: string[] | null; + /** + * Output only. Settings specific to YouTube and Partners line items. + */ + youtubeAndPartnersSettings?: Schema$YoutubeAndPartnersSettings; + } + /** + * Wrapper object associating an assigned_targeting_option resource and the line item it is assigned to. + */ + export interface Schema$LineItemAssignedTargetingOption { + /** + * The assigned targeting option resource. + */ + assignedTargetingOption?: Schema$AssignedTargetingOption; + /** + * The ID of the line item the assigned targeting option is assigned to. + */ + lineItemId?: string | null; + } + /** + * Settings that control how budget is allocated. + */ + export interface Schema$LineItemBudget { + /** + * 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. + */ + budgetAllocationType?: string | null; + /** + * Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order. + */ + budgetUnit?: string | null; + /** + * 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. + */ + maxAmount?: string | null; + } + /** + * Settings that control the active duration of a line item. + */ + export interface Schema$LineItemFlight { + /** + * 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. + */ + dateRange?: Schema$DateRange; + /** + * Required. The type of the line item's flight dates. + */ + flightDateType?: string | null; + } + export interface Schema$ListAdGroupAdsResponse { + /** + * The list of ad group ads. This list will be absent if empty. + */ + adGroupAds?: Schema$AdGroupAd[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroupAds` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListAdGroupAssignedTargetingOptions. + */ + export interface Schema$ListAdGroupAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * A token identifying the next page of results. This value should be specified as the pageToken in a subsequent ListAdGroupAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more AssignedTargetingOption resources to return. + */ + nextPageToken?: string | null; + } + export interface Schema$ListAdGroupsResponse { + /** + * The list of ad groups. This list will be absent if empty. + */ + adGroups?: Schema$AdGroup[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListAdGroups` method to retrieve the next page of results. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListAdvertiserAssignedTargetingOptions. + */ + export interface Schema$ListAdvertiserAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListAdvertisersResponse { + /** + * The list of advertisers. This list will be absent if empty. + */ + advertisers?: Schema$Advertiser[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for AssignedInventorySourceService.ListAssignedInventorySources. + */ + export interface Schema$ListAssignedInventorySourcesResponse { + /** + * The list of assigned inventory sources. This list will be absent if empty. + */ + assignedInventorySources?: Schema$AssignedInventorySource[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for AssignedLocationService.ListAssignedLocations. + */ + export interface Schema$ListAssignedLocationsResponse { + /** + * The list of assigned locations. This list will be absent if empty. + */ + assignedLocations?: Schema$AssignedLocation[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListCampaignAssignedTargetingOptions. + */ + export interface Schema$ListCampaignAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCampaignsResponse { + /** + * The list of campaigns. This list will be absent if empty. + */ + campaigns?: Schema$Campaign[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListChannelsResponse { + /** + * The list of channels. This list will be absent if empty. + */ + channels?: Schema$Channel[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCombinedAudiencesResponse { + /** + * The list of combined audiences. This list will be absent if empty. + */ + combinedAudiences?: Schema$CombinedAudience[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCreativesResponse { + /** + * The list of creatives. This list will be absent if empty. + */ + creatives?: Schema$Creative[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingAlgorithmRulesResponse { + /** + * The list of CustomBiddingAlgorithmRules resources. This list will be absent if empty. + */ + customBiddingRules?: Schema$CustomBiddingAlgorithmRules[]; + /** + * A token to retrieve the next page of results. Pass this value in the page_token field in the subsequent call to `ListCustomBiddingAlgorithmRulesRequest` method to retrieve the next page of results. If this field is null, it means this is the last page. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingAlgorithmsResponse { + /** + * The list of custom bidding algorithms. This list will be absent if empty. + */ + customBiddingAlgorithms?: Schema$CustomBiddingAlgorithm[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomBiddingScriptsResponse { + /** + * The list of custom bidding scripts. This list will be absent if empty. + */ + customBiddingScripts?: Schema$CustomBiddingScript[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListCustomListsResponse { + /** + * The list of custom lists. This list will be absent if empty. + */ + customLists?: Schema$CustomList[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListFirstAndThirdPartyAudiencesResponse { + /** + * The list of first and third party audiences. Audience size properties will not be included. This list will be absent if empty. + */ + firstAndThirdPartyAudiences?: Schema$FirstAndThirdPartyAudience[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListGoogleAudiencesResponse { + /** + * The list of Google audiences. This list will be absent if empty. + */ + googleAudiences?: Schema$GoogleAudience[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListGuaranteedOrdersResponse { + /** + * The list of guaranteed orders. This list will be absent if empty. + */ + guaranteedOrders?: Schema$GuaranteedOrder[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInsertionOrderAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInsertionOrdersResponse { + /** + * The list of insertion orders. This list will be absent if empty. + */ + insertionOrders?: Schema$InsertionOrder[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for InventorySourceGroupService.ListInventorySourceGroups. + */ + export interface Schema$ListInventorySourceGroupsResponse { + /** + * The list of inventory source groups. This list will be absent if empty. + */ + inventorySourceGroups?: Schema$InventorySourceGroup[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInventorySourcesResponse { + /** + * The list of inventory sources. This list will be absent if empty. + */ + inventorySources?: Schema$InventorySource[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListInvoicesResponse { + /** + * The list of invoices. This list will be absent if empty. + */ + invoices?: Schema$Invoice[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for ListLineItemAssignedTargetingOptions. + */ + export interface Schema$ListLineItemAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLineItemsResponse { + /** + * The list of line items. This list will be absent if empty. + */ + lineItems?: Schema$LineItem[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListLocationListsResponse { + /** + * The list of location lists. This list will be absent if empty. + */ + locationLists?: Schema$LocationList[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for NegativeKeywordListService.ListNegativeKeywordLists. + */ + export interface Schema$ListNegativeKeywordListsResponse { + /** + * The list of negative keyword lists. This list will be absent if empty. + */ + negativeKeywordLists?: Schema$NegativeKeywordList[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + /** + * Response message for NegativeKeywordService.ListNegativeKeywords. + */ + export interface Schema$ListNegativeKeywordsResponse { + /** + * The list of negative keywords. This list will be absent if empty. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListPartnerAssignedTargetingOptionsResponse { + /** + * The list of assigned targeting options. This list will be absent if empty. + */ + assignedTargetingOptions?: Schema$AssignedTargetingOption[]; + /** + * 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. + */ + nextPageToken?: string | null; + } + export interface Schema$ListPartnersResponse { + /** + * 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. + */ + nextPageToken?: string | null; + /** + * The list of partners. This list will be absent if empty. + */ + partners?: Schema$Partner[]; + } + /** + * Response message for SiteService.ListSites. + */ + export interface Schema$ListSitesResponse { + /** + * 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. + */ + nextPageToken?: string | null; + /** + * The list of sites. This list will be absent if empty. + */ + sites?: Schema$Site[]; + } + /** + * Response message for ListTargetingOptions. + */ + export interface Schema$ListTargetingOptionsResponse { + /** + * 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. + */ + nextPageToken?: string | null; + /** + * The list of targeting options. This list will be absent if empty. + */ + targetingOptions?: Schema$TargetingOption[]; + } + export interface Schema$ListUsersResponse { + /** + * 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. + */ + nextPageToken?: string | null; + /** + * The list of users. This list will be absent if empty. + */ + users?: Schema$User[]; + } + /** + * A list of locations used for targeting. + */ + export interface Schema$LocationList { + /** + * Required. Immutable. The unique ID of the advertiser the location list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the location list. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string | null; + /** + * Required. Immutable. The type of location. All locations in the list will share this type. + */ + locationType?: string | null; + /** + * Output only. The resource name of the location list. + */ + name?: string | null; + } + /** + * Specifies how many days into the past to look when determining whether to record a conversion. + */ + export interface Schema$LookbackWindow { + /** + * Lookback window, in days, from the last time a given user clicked on one of your ads. + */ + clickDays?: number | null; + /** + * Lookback window, in days, from the last time a given user viewed one of your ads. + */ + impressionDays?: number | null; + } + export interface Schema$LookupInvoiceCurrencyResponse { + /** + * Currency used by the advertiser in ISO 4217 format. + */ + currencyCode?: string | null; + } + /** + * Details for a Masthead Ad. + */ + export interface Schema$MastheadAd { + /** + * The duration of time the video will autoplay. + */ + autoplayVideoDuration?: string | null; + /** + * The amount of time in milliseconds after which the video will start to play. + */ + autoplayVideoStartMillisecond?: string | null; + /** + * The text on the call-to-action button. + */ + callToActionButtonLabel?: string | null; + /** + * The destination URL for the call-to-action button. + */ + callToActionFinalUrl?: string | null; + /** + * The tracking URL for the call-to-action button. + */ + callToActionTrackingUrl?: string | null; + /** + * The videos that appear next to the Masthead Ad on desktop. Can be no more than two. + */ + companionYoutubeVideos?: Schema$YoutubeVideoDetails[]; + /** + * The description of the ad. + */ + description?: string | null; + /** + * The headline of the ad. + */ + headline?: string | null; + /** + * Whether to show a background or banner that appears at the top of a YouTube page. + */ + showChannelArt?: boolean | null; + /** + * The YouTube video used by the ad. + */ + video?: Schema$YoutubeVideoDetails; + /** + * The aspect ratio of the autoplaying YouTube video on the Masthead. + */ + videoAspectRatio?: string | null; + } + /** + * A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. + */ + export interface Schema$MaximizeSpendBidStrategy { + /** + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + */ + customBiddingAlgorithmId?: string | null; + /** + * 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. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * 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. + */ + performanceGoalType?: string | null; + /** + * Whether the strategy takes deal floor prices into account. + */ + raiseBidForDeals?: boolean | null; + } + /** + * Measurement settings of a partner. + */ + export interface Schema$MeasurementConfig { + /** + * Whether or not to report DV360 cost to CM360. + */ + dv360ToCmCostReportingEnabled?: boolean | null; + /** + * Whether or not to include DV360 data in CM360 data transfer reports. + */ + dv360ToCmDataSharingEnabled?: boolean | null; + } + /** + * A mobile app promoted by a mobile app install line item. + */ + export interface Schema$MobileApp { + /** + * 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`. + */ + appId?: string | null; + /** + * Output only. The app name. + */ + displayName?: string | null; + /** + * Output only. The app platform. + */ + platform?: string | null; + /** + * Output only. The app publisher. + */ + publisher?: string | null; + } + /** + * Wrapper message for a list of mobile device IDs defining Customer Match audience members. + */ + export interface Schema$MobileDeviceIdList { + /** + * A list of mobile device IDs defining Customer Match audience members. The size of mobile_device_ids mustn't be greater than 500,000. + */ + mobileDeviceIds?: string[] | null; + } + /** + * Represents an amount of money with its currency type. + */ + export interface Schema$Money { + /** + * The three-letter currency code defined in ISO 4217. + */ + currencyCode?: string | null; + /** + * 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. + */ + nanos?: number | null; + /** + * The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. + */ + units?: string | null; + } + /** + * 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. + */ + export interface Schema$NativeContentPositionAssignedTargetingOptionDetails { + /** + * Required. The content position. + */ + contentPosition?: string | null; + } + /** + * 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`. + */ + export interface Schema$NativeContentPositionTargetingOptionDetails { + /** + * Output only. The content position. + */ + contentPosition?: string | null; + } + /** + * A negatively targeted keyword that belongs to a negative keyword list. + */ + export interface Schema$NegativeKeyword { + /** + * 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. + */ + keywordValue?: string | null; + /** + * Output only. The resource name of the negative keyword. + */ + name?: string | null; + } + /** + * A list of negative keywords used for targeting. + */ + export interface Schema$NegativeKeywordList { + /** + * Output only. The unique ID of the advertiser the negative keyword list belongs to. + */ + advertiserId?: string | null; + /** + * Required. The display name of the negative keyword list. Must be UTF-8 encoded with a maximum size of 255 bytes. + */ + displayName?: string | null; + /** + * Output only. The resource name of the negative keyword list. + */ + name?: string | null; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string | null; + /** + * Output only. Number of line items that are directly targeting this negative keyword list. + */ + targetedLineItemCount?: string | null; + } + /** + * 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`. + */ + export interface Schema$NegativeKeywordListAssignedTargetingOptionDetails { + /** + * Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource. + */ + negativeKeywordListId?: string | null; + } + /** + * Details for a non-skippable ad. + */ + export interface Schema$NonSkippableAd { + /** + * Common ad attributes. + */ + commonInStreamAttribute?: Schema$CommonInStreamAttribute; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + } + /** + * OBA Icon for a Creative + */ + export interface Schema$ObaIcon { + /** + * 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 + */ + clickTrackingUrl?: string | null; + /** + * The dimensions of the OBA icon. + */ + dimensions?: Schema$Dimensions; + /** + * 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 + */ + landingPageUrl?: string | null; + /** + * The position of the OBA icon on the creative. + */ + position?: string | null; + /** + * The program of the OBA icon. For example: “AdChoices”. + */ + program?: string | null; + /** + * The MIME type of the OBA icon resource. + */ + resourceMimeType?: string | null; + /** + * The URL of the OBA icon resource. + */ + resourceUrl?: string | null; + /** + * 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 + */ + viewTrackingUrl?: string | null; + } + /** + * 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`. + */ + export interface Schema$OmidAssignedTargetingOptionDetails { + /** + * Required. The type of Open Measurement enabled inventory. + */ + omid?: string | null; + } + /** + * Represents a targetable Open Measurement enabled inventory type. This will be populated in the omid_details field when targeting_type is `TARGETING_TYPE_OMID`. + */ + export interface Schema$OmidTargetingOptionDetails { + /** + * Output only. The type of Open Measurement enabled inventory. + */ + omid?: string | null; + } + /** + * 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`. + */ + export interface Schema$OnScreenPositionAssignedTargetingOptionDetails { + /** + * 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`. + */ + adType?: string | null; + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$OnScreenPositionTargetingOptionDetails { + /** + * Output only. The on screen position. + */ + onScreenPosition?: string | null; + } + /** + * Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + export interface Schema$OperatingSystemAssignedTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$OperatingSystemTargetingOptionDetails { + /** + * Output only. The display name of the operating system. + */ + displayName?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Settings that control the rate at which a budget is spent. + */ + export interface Schema$Pacing { + /** + * Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0. + */ + dailyMaxImpressions?: string | null; + /** + * 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. + */ + dailyMaxMicros?: string | null; + /** + * Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`. + */ + pacingPeriod?: string | null; + /** + * Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. + */ + pacingType?: string | null; + } + /** + * 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`. + */ + export interface Schema$ParentalStatusAssignedTargetingOptionDetails { + /** + * Required. The parental status of the audience. + */ + parentalStatus?: string | null; + } + /** + * 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`. + */ + export interface Schema$ParentalStatusTargetingOptionDetails { + /** + * Output only. The parental status of an audience. + */ + parentalStatus?: string | null; + } + /** + * A filtering option that filters on selected file types belonging to a chosen set of filter entities. + */ + export interface Schema$ParentEntityFilter { + /** + * Required. File types that will be returned. + */ + fileType?: string[] | null; + /** + * 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. + */ + filterIds?: string[] | null; + /** + * Required. Filter type used to filter fetched entities. + */ + filterType?: string | null; + } + /** + * A single partner in Display & Video 360 (DV360). + */ + export interface Schema$Partner { + /** + * Ad server related settings of the partner. + */ + adServerConfig?: Schema$PartnerAdServerConfig; + /** + * Billing related settings of the partner. + */ + billingConfig?: Schema$PartnerBillingConfig; + /** + * Settings that control how partner data may be accessed. + */ + dataAccessConfig?: Schema$PartnerDataAccessConfig; + /** + * The display name of the partner. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Output only. The status of the partner. + */ + entityStatus?: string | null; + /** + * Settings that control which exchanges are enabled for the partner. + */ + exchangeConfig?: Schema$ExchangeConfig; + /** + * General settings of the partner. + */ + generalConfig?: Schema$PartnerGeneralConfig; + /** + * Output only. The resource name of the partner. + */ + name?: string | null; + /** + * Output only. The unique ID of the partner. Assigned by the system. + */ + partnerId?: string | null; + /** + * Output only. The timestamp when the partner was last updated. Assigned by the system. + */ + updateTime?: string | null; + } + /** + * Ad server related settings of a partner. + */ + export interface Schema$PartnerAdServerConfig { + /** + * Measurement settings of a partner. + */ + measurementConfig?: Schema$MeasurementConfig; + } + /** + * Billing related settings of a partner. + */ + export interface Schema$PartnerBillingConfig { + /** + * The ID of a partner default billing profile. + */ + billingProfileId?: string | null; + } + /** + * 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. + */ + export interface Schema$PartnerCost { + /** + * Required. The type of the partner cost. + */ + costType?: string | null; + /** + * 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. + */ + feeAmount?: string | null; + /** + * 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%. + */ + feePercentageMillis?: string | null; + /** + * Required. The fee type for this partner cost. + */ + feeType?: string | null; + /** + * 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. + */ + invoiceType?: string | null; + } + /** + * Settings that control how partner related data may be accessed. + */ + export interface Schema$PartnerDataAccessConfig { + /** + * Structured Data Files (SDF) settings for the partner. The SDF configuration for the partner. + */ + sdfConfig?: Schema$SdfConfig; + } + /** + * General settings of a partner. + */ + export interface Schema$PartnerGeneralConfig { + /** + * Immutable. Partner's currency in ISO 4217 format. + */ + currencyCode?: string | null; + /** + * 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 + */ + timeZone?: string | null; + } + /** + * Settings that control how partner revenue is calculated. + */ + export interface Schema$PartnerRevenueModel { + /** + * 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). + */ + markupAmount?: string | null; + /** + * Required. The markup type of the partner revenue model. + */ + markupType?: string | null; + } + /** + * Settings that control the performance goal of a campaign. + */ + export interface Schema$PerformanceGoal { + /** + * 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. + */ + performanceGoalAmountMicros?: string | null; + /** + * 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). + */ + performanceGoalPercentageMicros?: string | null; + /** + * 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`. + */ + performanceGoalString?: string | null; + /** + * Required. The type of the performance goal. + */ + performanceGoalType?: string | null; + } + /** + * A strategy that automatically adjusts the bid to meet or beat a specified performance goal. + */ + export interface Schema$PerformanceGoalBidStrategy { + /** + * The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. + */ + customBiddingAlgorithmId?: string | null; + /** + * 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. + */ + maxAverageCpmBidAmountMicros?: string | null; + /** + * 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. + */ + performanceGoalAmountMicros?: string | null; + /** + * 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`. + */ + performanceGoalType?: string | null; + } + /** + * Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. + */ + export interface Schema$PoiAssignedTargetingOptionDetails { + /** + * Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available. + */ + displayName?: string | null; + /** + * Output only. Latitude of the POI rounding to 6th decimal place. + */ + latitude?: number | null; + /** + * Output only. Longitude of the POI rounding to 6th decimal place. + */ + longitude?: number | null; + /** + * 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`. + */ + proximityRadiusAmount?: number | null; + /** + * Required. The unit of distance by which the targeting radius is measured. + */ + proximityRadiusUnit?: string | null; + /** + * 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". + */ + targetingOptionId?: string | null; + } + /** + * Search terms for POI targeting options. + */ + export interface Schema$PoiSearchTerms { + /** + * 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. + */ + poiQuery?: string | null; + } + /** + * Represents a targetable point of interest(POI). This will be populated in the poi_details field when targeting_type is `TARGETING_TYPE_POI`. + */ + export interface Schema$PoiTargetingOptionDetails { + /** + * Output only. The display name of a POI(e.g. "Times Square", "Space Needle"), followed by its full address if available. + */ + displayName?: string | null; + /** + * Output only. Latitude of the POI rounding to 6th decimal place. + */ + latitude?: number | null; + /** + * Output only. Longitude of the POI rounding to 6th decimal place. + */ + longitude?: number | null; + } + /** + * Settings specific to the Mediaocean Prisma tool. + */ + export interface Schema$PrismaConfig { + /** + * Required. Relevant client, product, and estimate codes from the Mediaocean Prisma tool. + */ + prismaCpeCode?: Schema$PrismaCpeCode; + /** + * Required. The Prisma type. + */ + prismaType?: string | null; + /** + * Required. The entity allocated this budget (DSP, site, etc.). + */ + supplier?: string | null; + } + /** + * Google Payments Center supports searching and filtering on the component fields of this code. + */ + export interface Schema$PrismaCpeCode { + /** + * The Prisma client code. + */ + prismaClientCode?: string | null; + /** + * The Prisma estimate code. + */ + prismaEstimateCode?: string | null; + /** + * The Prisma product code. + */ + prismaProductCode?: string | null; + } + /** + * The details of product feed. + */ + export interface Schema$ProductFeedData { + /** + * Whether the product feed has opted-out of showing products. + */ + isFeedDisabled?: boolean | null; + /** + * A list of dimensions used to match products. + */ + productMatchDimensions?: Schema$ProductMatchDimension[]; + /** + * How products are selected by the product feed. + */ + productMatchType?: string | null; + } + /** + * A dimension used to match products. + */ + export interface Schema$ProductMatchDimension { + /** + * The custom label to match all the products with the label. + */ + customLabel?: Schema$CustomLabel; + /** + * The ID of the product offer to match with a product with the same offer ID. + */ + productOfferId?: string | null; + } + /** + * 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`. + */ + export interface Schema$ProximityLocationListAssignedTargetingOptionDetails { + /** + * 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`. + */ + proximityLocationListId?: string | null; + /** + * 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. + */ + proximityRadius?: number | null; + /** + * Required. Radius distance units. + */ + proximityRadiusUnit?: string | null; + } + /** + * Publisher review status for the creative. + */ + export interface Schema$PublisherReviewStatus { + /** + * The publisher reviewing the creative. + */ + publisherName?: string | null; + /** + * Status of the publisher review. + */ + status?: string | null; + } + /** + * The rate related settings of the inventory source. + */ + export interface Schema$RateDetails { + /** + * The rate type. Acceptable values are `INVENTORY_SOURCE_RATE_TYPE_CPM_FIXED`, `INVENTORY_SOURCE_RATE_TYPE_CPM_FLOOR`, and `INVENTORY_SOURCE_RATE_TYPE_CPD`. + */ + inventorySourceRateType?: string | null; + /** + * Output only. The amount that the buyer has committed to spending on the inventory source up front. Only applicable for guaranteed inventory sources. + */ + minimumSpend?: Schema$Money; + /** + * The rate for the inventory source. + */ + rate?: Schema$Money; + /** + * Required for guaranteed inventory sources. The number of impressions guaranteed by the seller. + */ + unitsPurchased?: string | null; + } + /** + * 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`. + */ + export interface Schema$RegionalLocationListAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * 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`. + */ + regionalLocationListId?: string | null; + } + /** + * Request message for NegativeKeywordService.ReplaceNegativeKeywords. + */ + export interface Schema$ReplaceNegativeKeywordsRequest { + /** + * The negative keywords that will replace the existing keywords in the negative keyword list, specified as a list of NegativeKeywords. + */ + newNegativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Response message for NegativeKeywordService.ReplaceNegativeKeywords. + */ + export interface Schema$ReplaceNegativeKeywordsResponse { + /** + * The full list of negative keywords now present in the negative keyword list. + */ + negativeKeywords?: Schema$NegativeKeyword[]; + } + /** + * Request message for SiteService.ReplaceSites. + */ + export interface Schema$ReplaceSitesRequest { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string | null; + /** + * The sites that will replace the existing sites assigned to the channel, specified as a list of Sites. + */ + newSites?: Schema$Site[]; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string | null; + } + /** + * Response message for SiteService.ReplaceSites. + */ + export interface Schema$ReplaceSitesResponse { + /** + * The list of sites in the channel after replacing. + */ + sites?: Schema$Site[]; + } + /** + * Review statuses for the creative. + */ + export interface Schema$ReviewStatusInfo { + /** + * 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. + */ + approvalStatus?: string | null; + /** + * Content and policy review status for the creative. + */ + contentAndPolicyReviewStatus?: string | null; + /** + * Creative and landing page review status for the creative. + */ + creativeAndLandingPageReviewStatus?: string | null; + /** + * Exchange review statuses for the creative. + */ + exchangeReviewStatuses?: Schema$ExchangeReviewStatus[]; + /** + * Publisher review statuses for the creative. + */ + publisherReviewStatuses?: Schema$PublisherReviewStatus[]; + } + /** + * An error message for a custom bidding script. + */ + export interface Schema$ScriptError { + /** + * The column number in the script where the error was thrown. + */ + column?: string | null; + /** + * The type of error. + */ + errorCode?: string | null; + /** + * The detailed error message. + */ + errorMessage?: string | null; + /** + * The line number in the script where the error was thrown. + */ + line?: string | null; + } + /** + * Structured Data File (SDF) related settings. + */ + export interface Schema$SdfConfig { + /** + * An administrator email address to which the SDF processing status reports will be sent. + */ + adminEmail?: string | null; + /** + * Required. The version of SDF being used. + */ + version?: string | null; + } + /** + * Type for the response returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTask { + /** + * 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. + */ + resourceName?: string | null; + } + /** + * Type for the metadata returned by [SdfDownloadTaskService.CreateSdfDownloadTask]. + */ + export interface Schema$SdfDownloadTaskMetadata { + /** + * The time when the operation was created. + */ + createTime?: string | null; + /** + * The time when execution was completed. + */ + endTime?: string | null; + /** + * The SDF version used to execute this download task. + */ + version?: string | null; + } + /** + * Request message for SearchTargetingOptions. + */ + export interface Schema$SearchTargetingOptionsRequest { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string | null; + /** + * Search terms for Business Chain targeting options. Can only be used when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. + */ + businessChainSearchTerms?: Schema$BusinessChainSearchTerms; + /** + * Search terms for geo region targeting options. Can only be used when targeting_type is `TARGETING_TYPE_GEO_REGION`. + */ + geoRegionSearchTerms?: Schema$GeoRegionSearchTerms; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number | null; + /** + * 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. + */ + pageToken?: string | null; + /** + * Search terms for POI targeting options. Can only be used when targeting_type is `TARGETING_TYPE_POI`. + */ + poiSearchTerms?: Schema$PoiSearchTerms; + } + /** + * Response message for SearchTargetingOptions. + */ + export interface Schema$SearchTargetingOptionsResponse { + /** + * 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. + */ + nextPageToken?: string | null; + /** + * The list of targeting options that match the search criteria. This list will be absent if empty. + */ + targetingOptions?: Schema$TargetingOption[]; + } + /** + * 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`. + */ + export interface Schema$SensitiveCategoryAssignedTargetingOptionDetails { + /** + * Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED. + */ + excludedSensitiveCategory?: string | null; + } + /** + * 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`. + */ + export interface Schema$SensitiveCategoryTargetingOptionDetails { + /** + * Output only. An enum for the DV360 Sensitive category content classifier. + */ + sensitiveCategory?: string | null; + } + /** + * Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. + */ + export interface Schema$SessionPositionAssignedTargetingOptionDetails { + /** + * The position where the ad will show in a session. + */ + sessionPosition?: string | null; + } + /** + * A single site. Sites are apps or websites belonging to a channel. + */ + export interface Schema$Site { + /** + * Output only. The resource name of the site. + */ + name?: string | null; + /** + * Required. The app ID or URL of the site. Must be UTF-8 encoded with a maximum length of 240 bytes. + */ + urlOrAppId?: string | null; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * 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`. + */ + export interface Schema$SubExchangeAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`. + */ + targetingOptionId?: string | null; + } + /** + * 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`. + */ + export interface Schema$SubExchangeTargetingOptionDetails { + /** + * Output only. The display name of the sub-exchange. + */ + displayName?: string | null; + } + /** + * Setting that controls the average number of times the ads will show to the same person over a certain period of time. + */ + export interface Schema$TargetFrequency { + /** + * The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count. + */ + targetCount?: string | null; + /** + * The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS` + */ + timeUnit?: string | null; + /** + * The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1 + */ + timeUnitCount?: number | null; + } + /** + * Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. + */ + export interface Schema$TargetingExpansionConfig { + /** + * Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. + */ + audienceExpansionLevel?: string | null; + /** + * Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. + */ + audienceExpansionSeedListExcluded?: boolean | null; + /** + * Required. Whether to enable Optimized Targeting for the line item. + */ + enableOptimizedTargeting?: boolean | null; + } + /** + * Represents a single targeting option, which is a targetable concept in DV360. + */ + export interface Schema$TargetingOption { + /** + * Age range details. + */ + ageRangeDetails?: Schema$AgeRangeTargetingOptionDetails; + /** + * App category details. + */ + appCategoryDetails?: Schema$AppCategoryTargetingOptionDetails; + /** + * Audio content type details. + */ + audioContentTypeDetails?: Schema$AudioContentTypeTargetingOptionDetails; + /** + * Authorized seller status resource details. + */ + authorizedSellerStatusDetails?: Schema$AuthorizedSellerStatusTargetingOptionDetails; + /** + * Browser details. + */ + browserDetails?: Schema$BrowserTargetingOptionDetails; + /** + * Business chain resource details. + */ + businessChainDetails?: Schema$BusinessChainTargetingOptionDetails; + /** + * Carrier and ISP details. + */ + carrierAndIspDetails?: Schema$CarrierAndIspTargetingOptionDetails; + /** + * Category resource details. + */ + categoryDetails?: Schema$CategoryTargetingOptionDetails; + /** + * Content duration resource details. + */ + contentDurationDetails?: Schema$ContentDurationTargetingOptionDetails; + /** + * Content genre resource details. + */ + contentGenreDetails?: Schema$ContentGenreTargetingOptionDetails; + /** + * Content instream position details. + */ + contentInstreamPositionDetails?: Schema$ContentInstreamPositionTargetingOptionDetails; + /** + * Content outstream position details. + */ + contentOutstreamPositionDetails?: Schema$ContentOutstreamPositionTargetingOptionDetails; + /** + * Content stream type resource details. + */ + contentStreamTypeDetails?: Schema$ContentStreamTypeTargetingOptionDetails; + /** + * Device make and model resource details. + */ + deviceMakeModelDetails?: Schema$DeviceMakeModelTargetingOptionDetails; + /** + * Device type details. + */ + deviceTypeDetails?: Schema$DeviceTypeTargetingOptionDetails; + /** + * Digital content label details. + */ + digitalContentLabelDetails?: Schema$DigitalContentLabelTargetingOptionDetails; + /** + * Environment details. + */ + environmentDetails?: Schema$EnvironmentTargetingOptionDetails; + /** + * Exchange details. + */ + exchangeDetails?: Schema$ExchangeTargetingOptionDetails; + /** + * Gender details. + */ + genderDetails?: Schema$GenderTargetingOptionDetails; + /** + * Geographic region resource details. + */ + geoRegionDetails?: Schema$GeoRegionTargetingOptionDetails; + /** + * Household income details. + */ + householdIncomeDetails?: Schema$HouseholdIncomeTargetingOptionDetails; + /** + * Language resource details. + */ + languageDetails?: Schema$LanguageTargetingOptionDetails; + /** + * Output only. The resource name for this targeting option. + */ + name?: string | null; + /** + * Native content position details. + */ + nativeContentPositionDetails?: Schema$NativeContentPositionTargetingOptionDetails; + /** + * Open Measurement enabled inventory details. + */ + omidDetails?: Schema$OmidTargetingOptionDetails; + /** + * On screen position details. + */ + onScreenPositionDetails?: Schema$OnScreenPositionTargetingOptionDetails; + /** + * Operating system resources details. + */ + operatingSystemDetails?: Schema$OperatingSystemTargetingOptionDetails; + /** + * Parental status details. + */ + parentalStatusDetails?: Schema$ParentalStatusTargetingOptionDetails; + /** + * POI resource details. + */ + poiDetails?: Schema$PoiTargetingOptionDetails; + /** + * Sensitive Category details. + */ + sensitiveCategoryDetails?: Schema$SensitiveCategoryTargetingOptionDetails; + /** + * Sub-exchange details. + */ + subExchangeDetails?: Schema$SubExchangeTargetingOptionDetails; + /** + * Output only. A unique identifier for this targeting option. The tuple {`targeting_type`, `targeting_option_id`\} will be unique. + */ + targetingOptionId?: string | null; + /** + * Output only. The type of this targeting option. + */ + targetingType?: string | null; + /** + * User rewarded content details. + */ + userRewardedContentDetails?: Schema$UserRewardedContentTargetingOptionDetails; + /** + * Video player size details. + */ + videoPlayerSizeDetails?: Schema$VideoPlayerSizeTargetingOptionDetails; + /** + * Viewability resource details. + */ + viewabilityDetails?: Schema$ViewabilityTargetingOptionDetails; + } + /** + * Settings that control what third-party vendors are measuring specific line item metrics. + */ + export interface Schema$ThirdPartyMeasurementConfigs { + /** + * Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` + */ + brandLiftVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` + */ + brandSafetyVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` + */ + reachVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + /** + * Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` + */ + viewabilityVendorConfigs?: Schema$ThirdPartyVendorConfig[]; + } + /** + * Settings for advertisers that use third-party ad servers only. + */ + export interface Schema$ThirdPartyOnlyConfig { + /** + * Whether or not order ID reporting for pixels is enabled. This value cannot be changed once set to `true`. + */ + pixelOrderIdReportingEnabled?: boolean | null; + } + /** + * Tracking URLs from third parties to track interactions with an audio or a video creative. + */ + export interface Schema$ThirdPartyUrl { + /** + * The type of interaction needs to be tracked by the tracking URL + */ + type?: string | null; + /** + * 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 + */ + url?: string | null; + } + /** + * Settings that control how third-party measurement vendors are configured. + */ + export interface Schema$ThirdPartyVendorConfig { + /** + * The ID used by the platform of the third-party vendor to identify the line item. + */ + placementId?: string | null; + /** + * The third-party measurement vendor. + */ + vendor?: string | null; + } + /** + * 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`. + */ + export interface Schema$ThirdPartyVerifierAssignedTargetingOptionDetails { + /** + * Third party brand verifier -- Adloox. + */ + adloox?: Schema$Adloox; + /** + * Third party brand verifier -- DoubleVerify. + */ + doubleVerify?: Schema$DoubleVerify; + /** + * Third party brand verifier -- Integral Ad Science. + */ + integralAdScience?: Schema$IntegralAdScience; + } + /** + * A time range. + */ + export interface Schema$TimeRange { + /** + * Required. The upper bound of a time range, inclusive. + */ + endTime?: string | null; + /** + * Required. The lower bound of a time range, inclusive. + */ + startTime?: string | null; + } + /** + * Timer event of the creative. + */ + export interface Schema$TimerEvent { + /** + * Required. The name of the timer event. + */ + name?: string | null; + /** + * Required. The name used to identify this timer event in reports. + */ + reportingName?: string | null; + } + /** + * Settings that control the behavior of a single Floodlight activity config. + */ + export interface Schema$TrackingFloodlightActivityConfig { + /** + * Required. The ID of the Floodlight activity. + */ + floodlightActivityId?: string | null; + /** + * 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. + */ + postClickLookbackWindowDays?: number | null; + /** + * 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. + */ + postViewLookbackWindowDays?: number | null; + } + /** + * Represents information about the transcoded audio or video file. + */ + export interface Schema$Transcode { + /** + * The bit rate for the audio stream of the transcoded video, or the bit rate for the transcoded audio, in kilobits per second. + */ + audioBitRateKbps?: string | null; + /** + * The sample rate for the audio stream of the transcoded video, or the sample rate for the transcoded audio, in hertz. + */ + audioSampleRateHz?: string | null; + /** + * The transcoding bit rate of the transcoded video, in kilobits per second. + */ + bitRateKbps?: string | null; + /** + * The dimensions of the transcoded video. + */ + dimensions?: Schema$Dimensions; + /** + * The size of the transcoded file, in bytes. + */ + fileSizeBytes?: string | null; + /** + * The frame rate of the transcoded video, in frames per second. + */ + frameRate?: number | null; + /** + * The MIME type of the transcoded file. + */ + mimeType?: string | null; + /** + * The name of the transcoded file. + */ + name?: string | null; + /** + * Indicates if the transcoding was successful. + */ + transcoded?: boolean | null; + } + /** + * A creative identifier provided by a registry that is unique across all platforms. This is part of the VAST 4.0 standard. + */ + export interface Schema$UniversalAdId { + /** + * The unique creative identifier. + */ + id?: string | null; + /** + * The registry provides unique creative identifiers. + */ + registry?: string | null; + } + /** + * Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. + */ + export interface Schema$UrlAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * 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`. + */ + url?: string | null; + } + /** + * A single user in Display & Video 360. + */ + export interface Schema$User { + /** + * The assigned user roles. Required in CreateUser. Output only in UpdateUser. Can only be updated through BulkEditAssignedUserRoles. + */ + assignedUserRoles?: Schema$AssignedUserRole[]; + /** + * Required. The display name of the user. Must be UTF-8 encoded with a maximum size of 240 bytes. + */ + displayName?: string | null; + /** + * Required. Immutable. The email address used to identify the user. + */ + email?: string | null; + /** + * Output only. The resource name of the user. + */ + name?: string | null; + /** + * Output only. The unique ID of the user. Assigned by the system. + */ + userId?: string | null; + } + /** + * 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`. + */ + export interface Schema$UserRewardedContentAssignedTargetingOptionDetails { + /** + * Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. + */ + targetingOptionId?: string | null; + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * 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`. + */ + export interface Schema$UserRewardedContentTargetingOptionDetails { + /** + * Output only. User rewarded content status for video ads. + */ + userRewardedContent?: string | null; + } + /** + * Settings related to VideoAdSequence. + */ + export interface Schema$VideoAdSequenceSettings { + /** + * The minimum time interval before the same user sees this sequence again. + */ + minimumDuration?: string | null; + /** + * The steps of which the sequence consists. + */ + steps?: Schema$VideoAdSequenceStep[]; + } + /** + * The detail of a single step in a VideoAdSequence. + */ + export interface Schema$VideoAdSequenceStep { + /** + * The ID of the corresponding ad group of the step. + */ + adGroupId?: string | null; + /** + * The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type. + */ + interactionType?: string | null; + /** + * The ID of the previous step. The first step does not have previous step. + */ + previousStepId?: string | null; + /** + * The ID of the step. + */ + stepId?: string | null; + } + /** + * Details for a video discovery ad. + */ + export interface Schema$VideoDiscoveryAd { + /** + * First text line for the ad. + */ + description1?: string | null; + /** + * Second text line for the ad. + */ + description2?: string | null; + /** + * The headline of ad. + */ + headline?: string | null; + /** + * Thumbnail image used in the ad. + */ + thumbnail?: string | null; + /** + * The YouTube video the ad promotes. + */ + video?: Schema$YoutubeVideoDetails; + } + /** + * Details for a video performance ad. + */ + export interface Schema$VideoPerformanceAd { + /** + * The list of text assets shown on the call-to-action button. + */ + actionButtonLabels?: string[] | null; + /** + * The list of companion banners used by this ad. + */ + companionBanners?: Schema$ImageAsset[]; + /** + * The custom parameters to pass custom values to tracking URL template. + */ + customParameters?: {[key: string]: string} | null; + /** + * The list of descriptions shown on the call-to-action banner. + */ + descriptions?: string[] | null; + /** + * The first piece after the domain in the display URL. + */ + displayUrlBreadcrumb1?: string | null; + /** + * The second piece after the domain in the display URL. + */ + displayUrlBreadcrumb2?: string | null; + /** + * The domain of the display URL. + */ + domain?: string | null; + /** + * The URL address of the webpage that people reach after they click the ad. + */ + finalUrl?: string | null; + /** + * The list of headlines shown on the call-to-action banner. + */ + headlines?: string[] | null; + /** + * The list of lone headlines shown on the call-to-action banner. + */ + longHeadlines?: string[] | null; + /** + * The URL address loaded in the background for tracking purposes. + */ + trackingUrl?: string | null; + /** + * The list of YouTube video assets used by this ad. + */ + videos?: Schema$YoutubeVideoDetails[]; + } + /** + * 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. + */ + export interface Schema$VideoPlayerSizeAssignedTargetingOptionDetails { + /** + * Required. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * 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`. + */ + export interface Schema$VideoPlayerSizeTargetingOptionDetails { + /** + * Output only. The video player size. + */ + videoPlayerSize?: string | null; + } + /** + * Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityAssignedTargetingOptionDetails { + /** + * Required. The predicted viewability percentage. + */ + viewability?: string | null; + } + /** + * Represents a targetable viewability. This will be populated in the viewability_details field of a TargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. + */ + export interface Schema$ViewabilityTargetingOptionDetails { + /** + * Output only. The predicted viewability percentage. + */ + viewability?: string | null; + } + /** + * Settings that control the bid strategy for YouTube and Partners resources. + */ + export interface Schema$YoutubeAndPartnersBiddingStrategy { + /** + * Output only. Source of the effective target CPA value for ad group. + */ + adGroupEffectiveTargetCpaSource?: string | null; + /** + * Output only. The effective target CPA for ad group, in micros of advertiser's currency. + */ + adGroupEffectiveTargetCpaValue?: string | null; + /** + * The type of the bidding strategy. + */ + type?: string | null; + /** + * The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0. + */ + value?: string | null; + } + /** + * Settings that control what YouTube related inventories the YouTube and Partners line item will target. + */ + export interface Schema$YoutubeAndPartnersInventorySourceConfig { + /** + * Whether to target inventory on YouTube. This includes both search, channels and videos. + */ + includeYoutube?: boolean | null; + /** + * Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube. + */ + includeYoutubeVideoPartners?: boolean | null; + } + /** + * Settings for YouTube and Partners line items. + */ + export interface Schema$YoutubeAndPartnersSettings { + /** + * The kind of content on which the YouTube and Partners ads will be shown. + */ + contentCategory?: string | null; + /** + * Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. + */ + effectiveContentCategory?: string | null; + /** + * Settings that control what YouTube and Partners inventories the line item will target. + */ + inventorySourceSettings?: Schema$YoutubeAndPartnersInventorySourceConfig; + /** + * The ID of the form to generate leads. + */ + leadFormId?: string | null; + /** + * The ID of the merchant which is linked to the line item for product feed. + */ + linkedMerchantId?: string | null; + /** + * The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices. + */ + relatedVideoIds?: string[] | null; + /** + * The average number of times you want ads from this line item to show to the same person over a certain period of time. + */ + targetFrequency?: Schema$TargetFrequency; + /** + * Optional. The third-party measurement configs of the line item. + */ + thirdPartyMeasurementConfigs?: Schema$ThirdPartyMeasurementConfigs; + /** + * The settings related to VideoAdSequence. + */ + videoAdSequenceSettings?: Schema$VideoAdSequenceSettings; + /** + * The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap. + */ + viewFrequencyCap?: Schema$FrequencyCap; + } + /** + * Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. + */ + export interface Schema$YoutubeChannelAssignedTargetingOptionDetails { + /** + * The YouTube uploader channel id or the channel code of a YouTube channel. + */ + channelId?: string | null; + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + } + /** + * Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. + */ + export interface Schema$YoutubeVideoAssignedTargetingOptionDetails { + /** + * Indicates if this option is being negatively targeted. + */ + negative?: boolean | null; + /** + * YouTube video id as it appears on the YouTube watch page. + */ + videoId?: string | null; + } + /** + * Details of a YouTube video. + */ + export interface Schema$YoutubeVideoDetails { + /** + * The YouTube video ID which can be searched on YouTube webpage. + */ + id?: string | null; + /** + * The reason why the video data is not available. + */ + unavailableReason?: string | null; + } + + export class Resource$Advertisers { + context: APIRequestContext; + adGroupAds: Resource$Advertisers$Adgroupads; + adGroups: Resource$Advertisers$Adgroups; + assets: Resource$Advertisers$Assets; + campaigns: Resource$Advertisers$Campaigns; + channels: Resource$Advertisers$Channels; + creatives: Resource$Advertisers$Creatives; + insertionOrders: Resource$Advertisers$Insertionorders; + invoices: Resource$Advertisers$Invoices; + lineItems: Resource$Advertisers$Lineitems; + locationLists: Resource$Advertisers$Locationlists; + negativeKeywordLists: Resource$Advertisers$Negativekeywordlists; + targetingTypes: Resource$Advertisers$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.adGroupAds = new Resource$Advertisers$Adgroupads(this.context); + this.adGroups = new Resource$Advertisers$Adgroups(this.context); + this.assets = new Resource$Advertisers$Assets(this.context); + this.campaigns = new Resource$Advertisers$Campaigns(this.context); + this.channels = new Resource$Advertisers$Channels(this.context); + this.creatives = new Resource$Advertisers$Creatives(this.context); + this.insertionOrders = new Resource$Advertisers$Insertionorders( + this.context + ); + this.invoices = new Resource$Advertisers$Invoices(this.context); + this.lineItems = new Resource$Advertisers$Lineitems(this.context); + this.locationLists = new Resource$Advertisers$Locationlists(this.context); + this.negativeKeywordLists = new Resource$Advertisers$Negativekeywordlists( + this.context + ); + this.targetingTypes = new Resource$Advertisers$Targetingtypes( + this.context + ); + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + audit( + params: Params$Resource$Advertisers$Audit, + options: StreamMethodOptions + ): GaxiosPromise; + audit( + params?: Params$Resource$Advertisers$Audit, + options?: MethodOptions + ): GaxiosPromise; + audit( + params: Params$Resource$Advertisers$Audit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + audit( + params: Params$Resource$Advertisers$Audit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + audit( + params: Params$Resource$Advertisers$Audit, + callback: BodyResponseCallback + ): void; + audit(callback: BodyResponseCallback): void; + audit( + paramsOrCallback?: + | Params$Resource$Advertisers$Audit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Audit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Audit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}:audit').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new advertiser. Returns the newly created advertiser if successful. This method can take up to 180 seconds to complete. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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 . + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Editassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Advertisers$Editassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Editassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Editassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Editassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}:editAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Advertisers$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists assigned targeting options of an advertiser across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Listassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Listassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Listassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Listassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Listassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}:listAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing advertiser. Returns the updated advertiser if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Audit + extends StandardParameters { + /** + * Required. The ID of the advertiser to audit. + */ + advertiserId?: 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 + */ + readMask?: string; + } + export interface Params$Resource$Advertisers$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + export interface Params$Resource$Advertisers$Delete + extends StandardParameters { + /** + * The ID of the advertiser we need to delete. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Editassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAdvertiserAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Get extends StandardParameters { + /** + * Required. The ID of the advertiser to fetch. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$List extends StandardParameters { + /** + * Allows filtering by advertiser fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `advertiserId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All active advertisers under a partner: `entityStatus="ENTITY_STATUS_ACTIVE"` * All advertisers with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All advertisers with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=) operator`. Supported fields: * `targetingType` Examples: * targetingType with value TARGETING_TYPE_CHANNEL `targetingType="TARGETING_TYPE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser. Assigned by the system. + */ + advertiserId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Advertiser; + } + + export class Resource$Advertisers$Adgroupads { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an ad group ad. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroupads$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroupads$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroupads$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroupads$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroupads$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/adGroupAds/{+adGroupAdId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupAdId'], + pathParams: ['adGroupAdId', 'advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ad group ads. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Adgroupads$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroupads$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroupads$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroupads$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroupads$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroupads$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/adGroupAds' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Adgroupads$Get + extends StandardParameters { + /** + * Required. The ID of the ad group ad to fetch. + */ + adGroupAdId?: string; + /** + * Required. The ID of the advertiser this ad group ad belongs to. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Adgroupads$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the ad groups belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by custom ad group ad fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `adGroupId` * `displayName` * `entityStatus` * `adGroupAdId` Examples: * All ad group ads under an ad group: `adGroupId="1234"` * All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `100`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAds` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Adgroups { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Adgroups$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Adgroups$Targetingtypes( + this.context + ); + } + + /** + * Lists assigned targeting options for multiple ad groups across targeting types. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkListAdGroupAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkListAdGroupAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkListAdGroupAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAdGroupAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAdGroupAssignedTargetingOptions( + params: Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkListAdGroupAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAdGroupAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/adGroups:bulkListAdGroupAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets an ad group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupId'], + pathParams: ['adGroupId', 'advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists ad groups. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Adgroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}/adGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Adgroups$Bulklistadgroupassignedtargetingoptions + extends StandardParameters { + /** + * Required. The IDs of the ad groups to list assigned targeting options for. + */ + adGroupIds?: string[]; + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_YOUTUBE_VIDEO` or `TARGETING_TYPE_YOUTUBE_CHANNEL`: `targetingType="TARGETING_TYPE_YOUTUBE_VIDEO" OR targetingType="TARGETING_TYPE_YOUTUBE_CHANNEL"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `adGroupId` (default) * `assignedTargetingOption.targetingType` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to the `BulkListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Get + extends StandardParameters { + /** + * Required. The ID of the ad group to fetch. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser this ad group belongs to. + */ + advertiserId?: string; + } + export interface Params$Resource$Advertisers$Adgroups$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the ad groups belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by custom ad group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported properties: * `adGroupId` * `displayName` * `entityStatus` * `lineItemId` * `adGroupFormat` Examples: * All ad groups under an line item: `lineItemId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="AD_GROUP_FORMAT_IN_STREAM"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `displayName` (default) * `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `displayName desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroups` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Adgroups$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option assigned to an ad group. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'adGroupId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'adGroupId', + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to an ad group. Inherited assigned targeting options are not included. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/adGroups/{+adGroupId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'adGroupId', 'targetingType'], + pathParams: ['adGroupId', 'advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the ad group the assigned targeting option belongs to. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Adgroups$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the ad group to list assigned targeting options for. + */ + adGroupId?: string; + /** + * Required. The ID of the advertiser the ad group belongs to. + */ + advertiserId?: string; + /** + * Optional. Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Optional. Field by which to sort the list. Acceptable values are: * `assignedTargetingOptionId` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `assignedTargetingOptionId desc`. + */ + orderBy?: string; + /** + * Optional. Requested page size. Must be between `1` and `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListAdGroupAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SESSION_POSITION` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_YOUTUBE_CHANNEL` * `TARGETING_TYPE_YOUTUBE_VIDEO` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Assets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Advertisers$Assets$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Advertisers$Assets$Upload, + callback: BodyResponseCallback + ): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: + | Params$Resource$Advertisers$Assets$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Assets$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Assets$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}/assets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + mediaUrl: ( + rootUrl + '/upload/v3/advertisers/{+advertiserId}/assets' + ).replace(/([^:]\/)\/+/g, '$1'), + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Assets$Upload + extends StandardParameters { + /** + * Required. The ID of the advertiser this asset belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CreateAssetRequest; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Advertisers$Campaigns { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Campaigns$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Campaigns$Targetingtypes( + this.context + ); + } + + /** + * Creates a new campaign. Returns the newly created campaign if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Campaigns$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Campaigns$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Campaigns$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Campaigns$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a campaign. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Campaigns$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Campaigns$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/campaigns' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists assigned targeting options of a campaign across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}:listAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing campaign. Returns the updated campaign if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Campaigns$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Campaigns$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Campaigns$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId'], + pathParams: ['advertiserId', 'campaignId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Campaigns$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + export interface Params$Resource$Advertisers$Campaigns$Delete + extends StandardParameters { + /** + * The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * The ID of the campaign we need to delete. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to fetch. + */ + campaignId?: string; + } + export interface Params$Resource$Advertisers$Campaigns$List + extends StandardParameters { + /** + * The ID of the advertiser to list campaigns for. + */ + advertiserId?: string; + /** + * Allows filtering by campaign fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` campaigns under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All campaigns with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All campaigns with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to list assigned targeting options for. + */ + campaignId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the campaign. Assigned by the system. + */ + campaignId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Campaign; + } + + export class Resource$Advertisers$Campaigns$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option assigned to a campaign. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'campaignId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'campaignId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a campaign for a specified targeting type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'campaignId', 'targetingType'], + pathParams: ['advertiserId', 'campaignId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the campaign the assigned targeting option belongs to. + */ + campaignId?: 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` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the campaign belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the campaign to list assigned targeting options for. + */ + campaignId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2 `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER` `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Channels { + context: APIRequestContext; + sites: Resource$Advertisers$Channels$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.sites = new Resource$Advertisers$Channels$Sites(this.context); + } + + /** + * Creates a new channel. Returns the newly created channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Channels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Channels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Channels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a channel for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Channels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Channels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Channels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists channels for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Channels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Channels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a channel. Returns the updated channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Channels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Channels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/channels/{channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Channels$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + export interface Params$Resource$Advertisers$Channels$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Advertisers$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a site in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Channels$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Channels$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], + pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Channels$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Advertisers$Channels$Sites$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + callback: BodyResponseCallback + ): void; + replace(callback: BodyResponseCallback): void; + replace( + paramsOrCallback?: + | Params$Resource$Advertisers$Channels$Sites$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Channels$Sites$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Channels$Sites$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Advertisers$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Advertisers$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$Replace + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel whose sites will be replaced. + */ + channelId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceSitesRequest; + } + + export class Resource$Advertisers$Creatives { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new creative. Returns the newly created creative if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Creatives$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Creatives$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Creatives$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Creatives$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Creatives$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a creative. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Creatives$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Creatives$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Creatives$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Creatives$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Creatives$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/creatives' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing creative. Returns the updated creative if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Creatives$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Creatives$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Creatives$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Creatives$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + export interface Params$Resource$Advertisers$Creatives$Delete + extends StandardParameters { + /** + * The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * The ID of the creative to be deleted. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this creative belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the creative to fetch. + */ + creativeId?: string; + } + export interface Params$Resource$Advertisers$Creatives$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list creatives for. + */ + advertiserId?: string; + /** + * Allows filtering by creative fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `lineItemIds` field must use the `HAS (:)` operator. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. * For `entityStatus`, `minDuration`, `maxDuration`, `updateTime`, and `dynamic` fields, there may be at most one restriction. Supported Fields: * `approvalStatus` * `creativeId` * `creativeType` * `dimensions` (input in the form of `{width\}x{height\}`) * `dynamic` * `entityStatus` * `exchangeReviewStatus` (input in the form of `{exchange\}-{reviewStatus\}`) * `lineItemIds` * `maxDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `minDuration` (input in the form of `{duration\}s`. Only seconds are supported) * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Notes: * For `updateTime`, a creative resource's field value reflects the last time that a creative has been updated, which includes updates made by the system (e.g. creative review updates). Examples: * All native creatives: `creativeType="CREATIVE_TYPE_NATIVE"` * All active creatives with 300x400 or 50x100 dimensions: `entityStatus="ENTITY_STATUS_ACTIVE" AND (dimensions="300x400" OR dimensions="50x100")` * All dynamic creatives that are approved by AdX or AppNexus, with a minimum duration of 5 seconds and 200ms: `dynamic="true" AND minDuration="5.2s" AND (exchangeReviewStatus="EXCHANGE_GOOGLE_AD_MANAGER-REVIEW_STATUS_APPROVED" OR exchangeReviewStatus="EXCHANGE_APPNEXUS-REVIEW_STATUS_APPROVED")` * All video creatives that are associated with line item ID 1 or 2: `creativeType="CREATIVE_TYPE_VIDEO" AND (lineItemIds:1 OR lineItemIds:2)` * Find creatives by multiple creative IDs: `creativeId=1 OR creativeId=2` * All creatives with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Creatives$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the creative belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the creative. Assigned by the system. + */ + creativeId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Creative; + } + + export class Resource$Advertisers$Insertionorders { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Insertionorders$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = + new Resource$Advertisers$Insertionorders$Targetingtypes(this.context); + } + + /** + * Creates a new insertion order. Returns the newly created insertion order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Insertionorders$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Insertionorders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Insertionorders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists assigned targeting options of an insertion order across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + listAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing insertion order. Returns the updated insertion order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Insertionorders$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Insertionorders$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + export interface Params$Resource$Advertisers$Insertionorders$Delete + extends StandardParameters { + /** + * The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * The ID of the insertion order to delete. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order to fetch. + */ + insertionOrderId?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list insertion orders for. + */ + advertiserId?: string; + /** + * Allows filtering by insertion order fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All insertion orders under a campaign: `campaignId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` insertion orders under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")` * All insertion orders with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All insertion orders with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the insertion order to list assigned targeting options for. + */ + insertionOrderId?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the insertion order. Assigned by the system. + */ + insertionOrderId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InsertionOrder; + } + + export class Resource$Advertisers$Insertionorders$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to an insertion order. Returns the assigned targeting option if successful. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from an insertion order. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'insertionOrderId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'insertionOrderId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to an insertion order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'insertionOrderId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'insertionOrderId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to an insertion order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option will belong to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option belongs to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the insertion order the assigned targeting option belongs to. + */ + insertionOrderId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the insertion order belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the insertion order to list assigned targeting options for. + */ + insertionOrderId?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + + export class Resource$Advertisers$Invoices { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Invoices$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Invoices$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Invoices$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Invoices$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Invoices$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Invoices$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Invoices$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Invoices$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/advertisers/{+advertiserId}/invoices').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves the invoice currency used by an advertiser in a given month. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: StreamMethodOptions + ): GaxiosPromise; + lookupInvoiceCurrency( + params?: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options?: MethodOptions + ): GaxiosPromise; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + params: Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency, + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + callback: BodyResponseCallback + ): void; + lookupInvoiceCurrency( + paramsOrCallback?: + | Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/invoices:lookupInvoiceCurrency' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Invoices$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list invoices for. + */ + advertiserId?: 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. + */ + issueMonth?: string; + /** + * Select type of invoice to retrieve for Loi Sapin advertisers. Only applicable to Loi Sapin advertisers. Will be ignored otherwise. + */ + loiSapinInvoiceType?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Invoices$Lookupinvoicecurrency + extends StandardParameters { + /** + * Required. The ID of the advertiser to lookup currency for. + */ + advertiserId?: 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. + */ + invoiceMonth?: string; + } + + export class Resource$Advertisers$Lineitems { + context: APIRequestContext; + targetingTypes: Resource$Advertisers$Lineitems$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingTypes = new Resource$Advertisers$Lineitems$Targetingtypes( + this.context + ); + } + + /** + * Bulk edits targeting options under multiple line items. The operation will delete the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.delete_requests and then create the assigned targeting options provided in BulkEditAssignedTargetingOptionsRequest.create_requests. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkUpdate * lineItems.patch * assignedTargetingOptions.create * assignedTargetingOptions.delete + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEditAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkEditAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems:bulkEditAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Lists assigned targeting options for multiple line items across targeting types. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params?: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + params: Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + bulkListAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems:bulkListAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates multiple line items. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * UpdateLineItem * assignedTargetingOptions.create * assignedTargetingOptions.delete + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions + ): GaxiosPromise; + bulkUpdate( + params?: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options?: MethodOptions + ): GaxiosPromise; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkUpdate( + params: Params$Resource$Advertisers$Lineitems$Bulkupdate, + callback: BodyResponseCallback + ): void; + bulkUpdate( + callback: BodyResponseCallback + ): void; + bulkUpdate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Bulkupdate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Bulkupdate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Bulkupdate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/lineItems:bulkUpdate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a new line item. Returns the newly created line item if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Duplicates a line item. Returns the ID of the created line item if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions + ): GaxiosPromise; + duplicate( + params?: Params$Resource$Advertisers$Lineitems$Duplicate, + options?: MethodOptions + ): GaxiosPromise; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + duplicate( + params: Params$Resource$Advertisers$Lineitems$Duplicate, + callback: BodyResponseCallback + ): void; + duplicate( + callback: BodyResponseCallback + ): void; + duplicate( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Duplicate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Duplicate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Duplicate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}:duplicate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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 + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions + ): GaxiosPromise; + generateDefault( + params?: Params$Resource$Advertisers$Lineitems$Generatedefault, + options?: MethodOptions + ): GaxiosPromise; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateDefault( + params: Params$Resource$Advertisers$Lineitems$Generatedefault, + callback: BodyResponseCallback + ): void; + generateDefault(callback: BodyResponseCallback): void; + generateDefault( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Generatedefault + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Generatedefault; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Generatedefault; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems:generateDefault' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/lineItems' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing line item. Returns the updated line item if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * BulkEditAssignedTargetingOptions * BulkUpdateLineItems * assignedTargetingOptions.create * assignedTargetingOptions.delete + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Lineitems$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Lineitems$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Lineitems$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId'], + pathParams: ['advertiserId', 'lineItemId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Bulkeditassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belong to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Bulklistassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the advertiser the line items belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR` on the same field. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The IDs of the line items to list assigned targeting options for. + */ + lineItemIds?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Bulkupdate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkUpdateLineItemsRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Create + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + export interface Params$Resource$Advertisers$Lineitems$Delete + extends StandardParameters { + /** + * The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * The ID of the line item to delete. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Duplicate + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to duplicate. + */ + lineItemId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$DuplicateLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Generatedefault + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateDefaultLineItemRequest; + } + export interface Params$Resource$Advertisers$Lineitems$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser this line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item to fetch. + */ + lineItemId?: string; + } + export interface Params$Resource$Advertisers$Lineitems$List + extends StandardParameters { + /** + * Required. The ID of the advertiser to list line items for. + */ + advertiserId?: string; + /** + * Allows filtering by line item fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `updateTime` field must use the `GREATER THAN OR EQUAL TO (\>=)` or `LESS THAN OR EQUAL TO (<=)` operators. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `campaignId` * `displayName` * `entityStatus` * `insertionOrderId` * `lineItemId` * `lineItemType` * `updateTime` (input in ISO 8601 format, or `YYYY-MM-DDTHH:MM:SSZ`) Examples: * All line items under an insertion order: `insertionOrderId="1234"` * All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` and `LINE_ITEM_TYPE_DISPLAY_DEFAULT` line items under an advertiser: `(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND lineItemType="LINE_ITEM_TYPE_DISPLAY_DEFAULT"` * All line items with an update time less than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime<="2020-11-04T18:54:47Z"` * All line items with an update time greater than or equal to 2020-11-04T18:54:47Z (format of ISO 8601): `updateTime\>="2020-11-04T18:54:47Z"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the line item. Assigned by the system. + */ + lineItemId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LineItem; + } + + export class Resource$Advertisers$Lineitems$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to a line item. Returns the assigned targeting option if successful. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * DeleteLineItemAssignedTargetingOption + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from a line item. Requests to this endpoint cannot be made concurrently with the following requests updating the same line item: * lineItems.bulkEditAssignedTargetingOptions * lineItems.bulkUpdate * lineItems.patch * CreateLineItemAssignedTargetingOption + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'lineItemId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'lineItemId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a line item. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/lineItems/{+lineItemId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'lineItemId', 'targetingType'], + pathParams: ['advertiserId', 'lineItemId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the line item the assigned targeting option will belong to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this line item that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the line item the assigned targeting option belongs to. + */ + lineItemId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Lineitems$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser the line item belongs to. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` * `inheritance` Examples: * `AssignedTargetingOption` resources with ID 1 or 2: `assignedTargetingOptionId="1" OR assignedTargetingOptionId="2"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the line item to list assigned targeting options for. + */ + lineItemId?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types include: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_APP` * `TARGETING_TYPE_APP_CATEGORY` * `TARGETING_TYPE_AUDIENCE_GROUP` * `TARGETING_TYPE_AUDIO_CONTENT_TYPE` * `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` * `TARGETING_TYPE_BROWSER` * `TARGETING_TYPE_BUSINESS_CHAIN` * `TARGETING_TYPE_CARRIER_AND_ISP` * `TARGETING_TYPE_CATEGORY` * `TARGETING_TYPE_CHANNEL` * `TARGETING_TYPE_CONTENT_DURATION` * `TARGETING_TYPE_CONTENT_GENRE` * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_STREAM_TYPE` * `TARGETING_TYPE_DAY_AND_TIME` * `TARGETING_TYPE_DEVICE_MAKE_MODEL` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_INVENTORY_SOURCE` * `TARGETING_TYPE_INVENTORY_SOURCE_GROUP` * `TARGETING_TYPE_KEYWORD` * `TARGETING_TYPE_LANGUAGE` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_ON_SCREEN_POSITION` * `TARGETING_TYPE_OPERATING_SYSTEM` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` * `TARGETING_TYPE_REGIONAL_LOCATION_LIST` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_SUB_EXCHANGE` * `TARGETING_TYPE_THIRD_PARTY_VERIFIER` * `TARGETING_TYPE_URL` * `TARGETING_TYPE_USER_REWARDED_CONTENT` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` * `TARGETING_TYPE_YOUTUBE_CHANNEL` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) * `TARGETING_TYPE_YOUTUBE_VIDEO` (only for `LINE_ITEM_TYPE_YOUTUBE_AND_PARTNERS_VIDEO_SEQUENCE` line items) + */ + targetingType?: string; + } + + export class Resource$Advertisers$Locationlists { + context: APIRequestContext; + assignedLocations: Resource$Advertisers$Locationlists$Assignedlocations; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedLocations = + new Resource$Advertisers$Locationlists$Assignedlocations(this.context); + } + + /** + * Creates a new location list. Returns the newly created location list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Locationlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Locationlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/locationLists/{+locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists location lists based on a given advertiser id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/locationLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a location list. Returns the updated location list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Locationlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Locationlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Locationlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/locationLists/{locationListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + export interface Params$Resource$Advertisers$Locationlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to fetch. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched location lists belong. + */ + advertiserId?: string; + /** + * Allows filtering by location list fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `locationType` Examples: * All regional location list: `locationType="TARGETING_LOCATION_TYPE_REGIONAL"` * All proximity location list: `locationType="TARGETING_LOCATION_TYPE_PROXIMITY"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location lists belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the location list. Assigned by the system. + */ + locationListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LocationList; + } + + export class Resource$Advertisers$Locationlists$Assignedlocations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits multiple assignments between locations and a single location list. The operation will delete the assigned locations provided in deletedAssignedLocations and then create the assigned locations provided in createdAssignedLocations. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/locationLists/{+locationListId}/assignedLocations:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an assignment between a location and a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the assignment between a location and a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations/{+assignedLocationId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'locationListId', + 'assignedLocationId', + ], + pathParams: ['advertiserId', 'assignedLocationId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists locations assigned to a location list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Locationlists$Assignedlocations$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Locationlists$Assignedlocations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Locationlists$Assignedlocations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/locationLists/{locationListId}/assignedLocations' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'locationListId'], + pathParams: ['advertiserId', 'locationListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedLocationsRequest; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the location list for which the assignment will be created. + */ + locationListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedLocation; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned location to delete. + */ + assignedLocationId?: string; + /** + * Required. The ID of the location list to which this assignment is assigned. + */ + locationListId?: string; + } + export interface Params$Resource$Advertisers$Locationlists$Assignedlocations$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the location list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by location list assignment fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedLocationId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the location list to which these assignments are assigned. + */ + locationListId?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + + export class Resource$Advertisers$Negativekeywordlists { + context: APIRequestContext; + negativeKeywords: Resource$Advertisers$Negativekeywordlists$Negativekeywords; + constructor(context: APIRequestContext) { + this.context = context; + this.negativeKeywords = + new Resource$Advertisers$Negativekeywordlists$Negativekeywords( + this.context + ); + } + + /** + * Creates a new negative keyword list. Returns the newly created negative keyword list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a negative keyword list given an advertiser ID and a negative keyword list ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a negative keyword list given an advertiser ID and a negative keyword list ID. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Negativekeywordlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Negativekeywordlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists negative keyword lists based on a given advertiser id. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/advertisers/{+advertiserId}/negativeKeywordLists' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates a negative keyword list. Returns the updated negative keyword list if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Advertisers$Negativekeywordlists$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Advertisers$Negativekeywordlists$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/negativeKeywordLists/{negativeKeywordListId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list will belong. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to delete. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Get + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the negative keyword list to fetch. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the fetched negative keyword lists belong. + */ + advertiserId?: string; + /** + * Requested page size. Must be between `1` and `200`. Defaults to `100` if not set. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Patch + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the negative keyword list belongs. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the negative keyword list. Assigned by the system. + */ + negativeKeywordListId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeywordList; + } + + export class Resource$Advertisers$Negativekeywordlists$Negativekeywords { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a negative keyword in a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a negative keyword from a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords/{+keywordValue}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'negativeKeywordListId', + 'keywordValue', + ], + pathParams: ['advertiserId', 'keywordValue', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists negative keywords in a negative keyword list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace, + callback: BodyResponseCallback + ): void; + replace( + callback: BodyResponseCallback + ): void; + replace( + paramsOrCallback?: + | Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/negativeKeywordLists/{+negativeKeywordListId}/negativeKeywords:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'negativeKeywordListId'], + pathParams: ['advertiserId', 'negativeKeywordListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keywords belong. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditNegativeKeywordsRequest; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Create + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list in which the negative keyword will be created. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NegativeKeyword; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Delete + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The keyword value of the negative keyword to delete. + */ + keywordValue?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keyword belongs. + */ + negativeKeywordListId?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$List + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Allows filtering by negative keyword fields. Supported syntax: * Filter expressions for negative keywords can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `keywordValue` Examples: * All negative keywords for which the keyword value contains "google": `keywordValue : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the parent negative keyword list to which the requested negative keywords belong. + */ + negativeKeywordListId?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Advertisers$Negativekeywordlists$Negativekeywords$Replace + extends StandardParameters { + /** + * Required. The ID of the DV360 advertiser to which the parent negative keyword list belongs. + */ + advertiserId?: string; + /** + * Required. The ID of the parent negative keyword list to which the negative keywords belong. + */ + negativeKeywordListId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceNegativeKeywordsRequest; + } + + export class Resource$Advertisers$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Advertisers$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Advertisers$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Advertisers$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to an advertiser. Returns the assigned targeting option if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'advertiserId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: [ + 'advertiserId', + 'assignedTargetingOptionId', + 'targetingType', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to an advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/advertisers/{+advertiserId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['advertiserId', 'targetingType'], + pathParams: ['advertiserId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: 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` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: 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` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Required. An identifier unique to the targeting type in this advertiser that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: 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` + */ + targetingType?: string; + } + export interface Params$Resource$Advertisers$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Required. The ID of the advertiser. + */ + advertiserId?: string; + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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` + */ + targetingType?: string; + } + + export class Resource$Combinedaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a combined audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Combinedaudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Combinedaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Combinedaudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Combinedaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Combinedaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/combinedAudiences/{+combinedAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['combinedAudienceId'], + pathParams: ['combinedAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists combined audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Combinedaudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Combinedaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Combinedaudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Combinedaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Combinedaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Combinedaudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Combinedaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Combinedaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/combinedAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Combinedaudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched combined audience. + */ + advertiserId?: string; + /** + * Required. The ID of the combined audience to fetch. + */ + combinedAudienceId?: string; + /** + * The ID of the partner that has access to the fetched combined audience. + */ + partnerId?: string; + } + export interface Params$Resource$Combinedaudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched combined audiences. + */ + advertiserId?: string; + /** + * Allows filtering by combined audience fields. Supported syntax: * Filter expressions for combined audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All combined audiences for which the display name contains "Google": `displayName : "Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched combined audiences. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms { + context: APIRequestContext; + rules: Resource$Custombiddingalgorithms$Rules; + scripts: Resource$Custombiddingalgorithms$Scripts; + constructor(context: APIRequestContext) { + this.context = context; + this.rules = new Resource$Custombiddingalgorithms$Rules(this.context); + this.scripts = new Resource$Custombiddingalgorithms$Scripts(this.context); + } + + /** + * Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Custombiddingalgorithms$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/customBiddingAlgorithms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a custom bidding algorithm. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Custombiddingalgorithms$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Custombiddingalgorithms$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/customBiddingAlgorithms').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Custombiddingalgorithms$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Custombiddingalgorithms$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a rules reference object for an AlgorithmRules file. The resulting reference object provides a resource path where the AlgorithmRules file should be uploaded. This reference object should be included when creating a new CustomBiddingAlgorithmRules resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: StreamMethodOptions + ): GaxiosPromise; + uploadRules( + params?: Params$Resource$Custombiddingalgorithms$Uploadrules, + options?: MethodOptions + ): GaxiosPromise; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadRules( + params: Params$Resource$Custombiddingalgorithms$Uploadrules, + callback: BodyResponseCallback + ): void; + uploadRules( + callback: BodyResponseCallback + ): void; + uploadRules( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Uploadrules + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Uploadrules; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Uploadrules; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadRules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: StreamMethodOptions + ): GaxiosPromise; + uploadScript( + params?: Params$Resource$Custombiddingalgorithms$Uploadscript, + options?: MethodOptions + ): GaxiosPromise; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + uploadScript( + params: Params$Resource$Custombiddingalgorithms$Uploadscript, + callback: BodyResponseCallback + ): void; + uploadScript( + callback: BodyResponseCallback + ): void; + uploadScript( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Uploadscript + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Uploadscript; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Uploadscript; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}:uploadScript' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithm; + } + export interface Params$Resource$Custombiddingalgorithms$Get + extends StandardParameters { + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm to fetch. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$List + extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the custom bidding algorithm. + */ + advertiserId?: string; + /** + * Allows filtering by custom bidding algorithm fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND`. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `customBiddingAlgorithmType` field must use the `EQUALS (=)` operator. * The `displayName` field must use the `HAS (:)` operator. Supported fields: * `customBiddingAlgorithmType` * `displayName` Examples: * All custom bidding algorithms for which the display name contains "politics": `displayName:"politics"`. * All custom bidding algorithms for which the type is "SCRIPT_BASED": `customBiddingAlgorithmType=SCRIPT_BASED` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the DV360 partner that has access to the custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the custom bidding algorithm. Assigned by the system. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithm; + } + export interface Params$Resource$Custombiddingalgorithms$Uploadrules + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Uploadscript + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: 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. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms$Rules { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new rules resource. Returns the newly created rules resource if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Rules$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Rules$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a rules resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Rules$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Rules$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules/{+customBiddingAlgorithmRulesId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'customBiddingAlgorithmId', + 'customBiddingAlgorithmRulesId', + ], + pathParams: [ + 'customBiddingAlgorithmId', + 'customBiddingAlgorithmRulesId', + ], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists rules resources that belong to the given algorithm. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$Rules$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Rules$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Rules$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Rules$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Rules$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/rules' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Rules$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. Only this partner will have write access to this rules resource. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingAlgorithmRules; + } + export interface Params$Resource$Custombiddingalgorithms$Rules$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The ID of the rules resource to fetch. + */ + customBiddingAlgorithmRulesId?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Rules$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the rules resource. + */ + customBiddingAlgorithmId?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * A token identifying a page of results the server should return. Typically, this is the value of next_page_token returned from the previous call to `ListCustomBiddingAlgorithmRules` method. If not specified, the first page of results will be returned. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent custom bidding algorithm. + */ + partnerId?: string; + } + + export class Resource$Custombiddingalgorithms$Scripts { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new custom bidding script. Returns the newly created script if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Custombiddingalgorithms$Scripts$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a custom bidding script. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Custombiddingalgorithms$Scripts$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts/{+customBiddingScriptId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId', 'customBiddingScriptId'], + pathParams: ['customBiddingAlgorithmId', 'customBiddingScriptId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists custom bidding scripts that belong to the given algorithm. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Custombiddingalgorithms$Scripts$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Custombiddingalgorithms$Scripts$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Custombiddingalgorithms$Scripts$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Custombiddingalgorithms$Scripts$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Custombiddingalgorithms$Scripts$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/customBiddingAlgorithms/{+customBiddingAlgorithmId}/scripts' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customBiddingAlgorithmId'], + pathParams: ['customBiddingAlgorithmId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Custombiddingalgorithms$Scripts$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm that owns the script. + */ + customBiddingAlgorithmId?: 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. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$CustomBiddingScript; + } + export interface Params$Resource$Custombiddingalgorithms$Scripts$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: string; + /** + * Required. The ID of the custom bidding script to fetch. + */ + customBiddingScriptId?: 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. + */ + partnerId?: string; + } + export interface Params$Resource$Custombiddingalgorithms$Scripts$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent custom bidding algorithm. + */ + advertiserId?: string; + /** + * Required. The ID of the custom bidding algorithm owns the script. + */ + customBiddingAlgorithmId?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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. + */ + partnerId?: string; + } + + export class Resource$Customlists { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a custom list. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Customlists$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Customlists$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Customlists$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customlists$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Customlists$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Customlists$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/customLists/{+customListId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['customListId'], + pathParams: ['customListId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists custom lists. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Customlists$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Customlists$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Customlists$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customlists$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Customlists$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Customlists$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Customlists$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Customlists$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/customLists').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Customlists$Get extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Required. The ID of the custom list to fetch. + */ + customListId?: string; + } + export interface Params$Resource$Customlists$List extends StandardParameters { + /** + * The ID of the DV360 advertiser that has access to the fetched custom lists. + */ + advertiserId?: string; + /** + * Allows filtering by custom list fields. Supported syntax: * Filter expressions for custom lists can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All custom lists for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + + export class Resource$Firstandthirdpartyaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Firstandthirdpartyaudiences$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Firstandthirdpartyaudiences$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Firstandthirdpartyaudiences$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Firstandthirdpartyaudiences$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Firstandthirdpartyaudiences$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/firstAndThirdPartyAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the member list of a Customer Match audience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editCustomerMatchMembers( + params: Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers, + options: StreamMethodOptions + ): GaxiosPromise; + editCustomerMatchMembers( + params?: Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers, + options?: MethodOptions + ): GaxiosPromise; + editCustomerMatchMembers( + params: Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + params: Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + params: Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers, + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + callback: BodyResponseCallback + ): void; + editCustomerMatchMembers( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}:editCustomerMatchMembers' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['firstAndThirdPartyAudienceId'], + pathParams: ['firstAndThirdPartyAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a first and third party audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Firstandthirdpartyaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Firstandthirdpartyaudiences$Get, + callback: BodyResponseCallback + ): void; + get( + callback: BodyResponseCallback + ): void; + get( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['firstAndThirdPartyAudienceId'], + pathParams: ['firstAndThirdPartyAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists first and third party audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Firstandthirdpartyaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Firstandthirdpartyaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/firstAndThirdPartyAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing FirstAndThirdPartyAudience. Only supported for the following audience_type: * `CUSTOMER_MATCH_CONTACT_INFO` * `CUSTOMER_MATCH_DEVICE_ID` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Firstandthirdpartyaudiences$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Firstandthirdpartyaudiences$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Firstandthirdpartyaudiences$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Firstandthirdpartyaudiences$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Firstandthirdpartyaudiences$Patch, + callback: BodyResponseCallback + ): void; + patch( + callback: BodyResponseCallback + ): void; + patch( + paramsOrCallback?: + | Params$Resource$Firstandthirdpartyaudiences$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Firstandthirdpartyaudiences$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Firstandthirdpartyaudiences$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/firstAndThirdPartyAudiences/{+firstAndThirdPartyAudienceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['firstAndThirdPartyAudienceId'], + pathParams: ['firstAndThirdPartyAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Firstandthirdpartyaudiences$Create + extends StandardParameters { + /** + * Required. The ID of the advertiser under whom the FirstAndThirdPartyAudience will be created. + */ + advertiserId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirstAndThirdPartyAudience; + } + export interface Params$Resource$Firstandthirdpartyaudiences$Editcustomermatchmembers + extends StandardParameters { + /** + * Required. The ID of the Customer Match FirstAndThirdPartyAudience whose members will be edited. + */ + firstAndThirdPartyAudienceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditCustomerMatchMembersRequest; + } + export interface Params$Resource$Firstandthirdpartyaudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched first and third party audience. + */ + advertiserId?: string; + /** + * Required. The ID of the first and third party audience to fetch. + */ + firstAndThirdPartyAudienceId?: string; + /** + * The ID of the partner that has access to the fetched first and third party audience. + */ + partnerId?: string; + } + export interface Params$Resource$Firstandthirdpartyaudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched first and third party audiences. + */ + advertiserId?: string; + /** + * Allows filtering by first and third party audience fields. Supported syntax: * Filter expressions for first and third party audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All first and third party audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched first and third party audiences. + */ + partnerId?: string; + } + export interface Params$Resource$Firstandthirdpartyaudiences$Patch + extends StandardParameters { + /** + * Required. The ID of the owner advertiser of the updated FirstAndThirdPartyAudience. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the first and third party audience. Assigned by the system. + */ + firstAndThirdPartyAudienceId?: string; + /** + * Required. The mask to control which fields to update. Updates are only supported for the following fields: * `displayName` * `description` * `membershipDurationDays` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FirstAndThirdPartyAudience; + } + + export class Resource$Floodlightgroups { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Floodlight group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Floodlightgroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Floodlightgroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Floodlightgroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Floodlightgroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/floodlightGroups/{+floodlightGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing Floodlight group. Returns the updated Floodlight group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Floodlightgroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightgroups$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Floodlightgroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Floodlightgroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Floodlightgroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Floodlightgroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/floodlightGroups/{floodlightGroupId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['floodlightGroupId'], + pathParams: ['floodlightGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Floodlightgroups$Get + extends StandardParameters { + /** + * Required. The ID of the Floodlight group to fetch. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + } + export interface Params$Resource$Floodlightgroups$Patch + extends StandardParameters { + /** + * Output only. The unique ID of the Floodlight group. Assigned by the system. + */ + floodlightGroupId?: string; + /** + * Required. The partner context by which the Floodlight group is being accessed. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$FloodlightGroup; + } + + export class Resource$Googleaudiences { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a Google audience. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Googleaudiences$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Googleaudiences$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Googleaudiences$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Googleaudiences$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Googleaudiences$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Googleaudiences$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/googleAudiences/{+googleAudienceId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['googleAudienceId'], + pathParams: ['googleAudienceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Google audiences. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Googleaudiences$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Googleaudiences$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Googleaudiences$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Googleaudiences$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Googleaudiences$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Googleaudiences$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Googleaudiences$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Googleaudiences$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/googleAudiences').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Googleaudiences$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched Google audience. + */ + advertiserId?: string; + /** + * Required. The ID of the Google audience to fetch. + */ + googleAudienceId?: string; + /** + * The ID of the partner that has access to the fetched Google audience. + */ + partnerId?: string; + } + export interface Params$Resource$Googleaudiences$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the fetched Google audiences. + */ + advertiserId?: string; + /** + * Allows filtering by Google audience fields. Supported syntax: * Filter expressions for Google audiences can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All Google audiences for which the display name contains "Google": `displayName:"Google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the fetched Google audiences. + */ + partnerId?: string; + } + + export class Resource$Guaranteedorders { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new guaranteed order. Returns the newly created guaranteed order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Guaranteedorders$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Guaranteedorders$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Guaranteedorders$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Guaranteedorders$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Guaranteedorders$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/guaranteedOrders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Edits read advertisers of a guaranteed order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: StreamMethodOptions + ): GaxiosPromise; + editGuaranteedOrderReadAccessors( + params?: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options?: MethodOptions + ): GaxiosPromise; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + params: Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors, + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + callback: BodyResponseCallback + ): void; + editGuaranteedOrderReadAccessors( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/guaranteedOrders/{+guaranteedOrderId}:editGuaranteedOrderReadAccessors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a guaranteed order. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Guaranteedorders$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Guaranteedorders$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Guaranteedorders$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Guaranteedorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Guaranteedorders$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/guaranteedOrders/{+guaranteedOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Guaranteedorders$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Guaranteedorders$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Guaranteedorders$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Guaranteedorders$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Guaranteedorders$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/guaranteedOrders').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing guaranteed order. Returns the updated guaranteed order if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Guaranteedorders$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Guaranteedorders$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Guaranteedorders$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Guaranteedorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Guaranteedorders$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Guaranteedorders$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Guaranteedorders$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Guaranteedorders$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/guaranteedOrders/{+guaranteedOrderId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['guaranteedOrderId'], + pathParams: ['guaranteedOrderId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Guaranteedorders$Create + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuaranteedOrder; + } + export interface Params$Resource$Guaranteedorders$Editguaranteedorderreadaccessors + extends StandardParameters { + /** + * Required. The ID of the guaranteed order to edit. The ID is of the format `{exchange\}-{legacy_guaranteed_order_id\}` + */ + guaranteedOrderId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditGuaranteedOrderReadAccessorsRequest; + } + export interface Params$Resource$Guaranteedorders$Get + extends StandardParameters { + /** + * The ID of the advertiser that has access to the guaranteed order. + */ + advertiserId?: string; + /** + * Required. The ID of the guaranteed order to fetch. The ID is of the format `{exchange\}-{legacy_guaranteed_order_id\}` + */ + guaranteedOrderId?: string; + /** + * The ID of the partner that has access to the guaranteed order. + */ + partnerId?: string; + } + export interface Params$Resource$Guaranteedorders$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the guaranteed order. + */ + advertiserId?: string; + /** + * Allows filtering by guaranteed order fields. * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `guaranteed_order_id` * `exchange` * `display_name` * `status.entityStatus` Examples: * All active guaranteed orders: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Guaranteed orders belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the guaranteed order. + */ + partnerId?: string; + } + export interface Params$Resource$Guaranteedorders$Patch + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * Output only. The unique identifier of the guaranteed order. The guaranteed order IDs have the format `{exchange\}-{legacy_guaranteed_order_id\}`. + */ + guaranteedOrderId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GuaranteedOrder; + } + + export class Resource$Inventorysourcegroups { + context: APIRequestContext; + assignedInventorySources: Resource$Inventorysourcegroups$Assignedinventorysources; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedInventorySources = + new Resource$Inventorysourcegroups$Assignedinventorysources( + this.context + ); + } + + /** + * Creates a new inventory source group. Returns the newly created inventory source group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysourcegroups$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/inventorySourceGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an inventory source group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Inventorysourcegroups$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an inventory source group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Inventorysourcegroups$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysourcegroups$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysourcegroups$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/inventorySourceGroups/{+inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists inventory source groups that are accessible to the current user. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Inventorysourcegroups$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysourcegroups$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/inventorySourceGroups').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an inventory source group. Returns the updated inventory source group if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Inventorysourcegroups$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysourcegroups$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysourcegroups$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/inventorySourceGroups/{inventorySourceGroupId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventorysourcegroups$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner will not have access to this group. + */ + advertiserId?: 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. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; + } + export interface Params$Resource$Inventorysourcegroups$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to delete. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Get + extends StandardParameters { + /** + * 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. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to fetch. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access an advertiser-owned inventory source group. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$List + extends StandardParameters { + /** + * 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. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source group fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `inventorySourceGroupId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source group. A partner cannot access advertiser-owned inventory source groups. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the inventory source group. The parent partner does not have access to this group. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the inventory source group. Assigned by the system. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the inventory source group. Only this partner has write access to this group. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySourceGroup; + } + + export class Resource$Inventorysourcegroups$Assignedinventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates an assignment between an inventory source and an inventory source group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the assignment between an inventory source and an inventory source group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources/{+assignedInventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId', 'assignedInventorySourceId'], + pathParams: ['assignedInventorySourceId', 'inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists inventory sources assigned to an inventory source group. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysourcegroups$Assignedinventorysources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysourcegroups$Assignedinventorysources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/inventorySourceGroups/{+inventorySourceGroupId}/assignedInventorySources' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['inventorySourceGroupId'], + pathParams: ['inventorySourceGroupId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the inventory source group to which the assignments are assigned. + */ + inventorySourceGroupId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedInventorySourcesRequest; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner will not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source group to which the assignment will be assigned. + */ + inventorySourceGroupId?: 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. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedInventorySource; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent inventory source group. The parent partner does not have access to this assigned inventory source. + */ + advertiserId?: string; + /** + * Required. The ID of the assigned inventory source to delete. + */ + assignedInventorySourceId?: string; + /** + * Required. The ID of the inventory source group to which this assignment is assigned. + */ + inventorySourceGroupId?: string; + /** + * The ID of the partner that owns the parent inventory source group. Only this partner has write access to this assigned inventory source. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysourcegroups$Assignedinventorysources$List + extends StandardParameters { + /** + * 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. + */ + advertiserId?: string; + /** + * Allows filtering by assigned inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedInventorySourceId` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: string; + /** + * Required. The ID of the inventory source group to which these assignments are assigned. + */ + inventorySourceGroupId?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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. + */ + partnerId?: string; + } + + export class Resource$Inventorysources { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new inventory source. Returns the newly created inventory source if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Inventorysources$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Inventorysources$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Inventorysources$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysources$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Inventorysources$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Inventorysources$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/inventorySources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Edits read/write accessors of an inventory source. Returns the updated read_write_accessors for the inventory source. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: StreamMethodOptions + ): GaxiosPromise; + editInventorySourceReadWriteAccessors( + params?: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options?: MethodOptions + ): GaxiosPromise; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + params: Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors, + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + callback: BodyResponseCallback + ): void; + editInventorySourceReadWriteAccessors( + paramsOrCallback?: + | Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/inventorySources/{+inventorySourceId}:editInventorySourceReadWriteAccessors' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets an inventory source. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Inventorysources$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Inventorysources$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Inventorysources$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysources$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Inventorysources$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Inventorysources$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Inventorysources$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Inventorysources$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Inventorysources$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysources$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Inventorysources$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Inventorysources$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/inventorySources').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates an existing inventory source. Returns the updated inventory source if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Inventorysources$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Inventorysources$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Inventorysources$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysources$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Inventorysources$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Inventorysources$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Inventorysources$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Inventorysources$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/inventorySources/{+inventorySourceId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['inventorySourceId'], + pathParams: ['inventorySourceId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Inventorysources$Create + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySource; + } + export interface Params$Resource$Inventorysources$Editinventorysourcereadwriteaccessors + extends StandardParameters { + /** + * Required. The ID of inventory source to update. + */ + inventorySourceId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$EditInventorySourceReadWriteAccessorsRequest; + } + export interface Params$Resource$Inventorysources$Get + extends StandardParameters { + /** + * Optional. The ID of the DV360 advertiser to which the fetched inventory source is permissioned. If the user only has access to the advertiser and not the parent partner, use this field to specify the relevant advertiser. + */ + advertiserId?: string; + /** + * Required. The ID of the inventory source to fetch. + */ + inventorySourceId?: string; + /** + * Required. The ID of the DV360 partner to which the fetched inventory source is permissioned. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$List + extends StandardParameters { + /** + * The ID of the advertiser that has access to the inventory source. + */ + advertiserId?: string; + /** + * Allows filtering by inventory source fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `status.entityStatus` * `commitment` * `deliveryMethod` * `rateDetails.rateType` * `exchange` Examples: * All active inventory sources: `status.entityStatus="ENTITY_STATUS_ACTIVE"` * Inventory sources belonging to Google Ad Manager or Rubicon exchanges: `exchange="EXCHANGE_GOOGLE_AD_MANAGER" OR exchange="EXCHANGE_RUBICON"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that has access to the inventory source. + */ + partnerId?: string; + } + export interface Params$Resource$Inventorysources$Patch + extends StandardParameters { + /** + * The ID of the advertiser that the request is being made within. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the inventory source. Assigned by the system. + */ + inventorySourceId?: string; + /** + * The ID of the partner that the request is being made within. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$InventorySource; + } + + export class Resource$Media { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions + ): GaxiosPromise; + download( + params?: Params$Resource$Media$Download, + options?: MethodOptions + ): GaxiosPromise; + download( + params: Params$Resource$Media$Download, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + download( + params: Params$Resource$Media$Download, + callback: BodyResponseCallback + ): void; + download( + callback: BodyResponseCallback + ): void; + download( + paramsOrCallback?: + | Params$Resource$Media$Download + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Download; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Download; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/download/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions + ): GaxiosPromise; + upload( + params?: Params$Resource$Media$Upload, + options?: MethodOptions + ): GaxiosPromise; + upload( + params: Params$Resource$Media$Upload, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + upload( + params: Params$Resource$Media$Upload, + callback: BodyResponseCallback + ): void; + upload(callback: BodyResponseCallback): void; + upload( + paramsOrCallback?: + | Params$Resource$Media$Upload + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Media$Upload; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Media$Upload; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/media/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + mediaUrl: (rootUrl + '/upload/media/{+resourceName}').replace( + /([^:]\/)\/+/g, + '$1' + ), + requiredParams: ['resourceName'], + pathParams: ['resourceName'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Media$Download extends StandardParameters { + /** + * Name of the media that is being downloaded. See ReadRequest.resource_name. + */ + resourceName?: string; + } + export interface Params$Resource$Media$Upload extends StandardParameters { + /** + * Name of the media that is being downloaded. See ReadRequest.resource_name. + */ + resourceName?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleBytestreamMedia; + + /** + * Media metadata + */ + media?: { + /** + * Media mime-type + */ + mimeType?: string; + + /** + * Media body contents + */ + body?: any; + }; + } + + export class Resource$Partners { + context: APIRequestContext; + channels: Resource$Partners$Channels; + targetingTypes: Resource$Partners$Targetingtypes; + constructor(context: APIRequestContext) { + this.context = context; + this.channels = new Resource$Partners$Channels(this.context); + this.targetingTypes = new Resource$Partners$Targetingtypes(this.context); + } + + /** + * 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 . + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: StreamMethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params?: Params$Resource$Partners$Editassignedtargetingoptions, + options?: MethodOptions + ): GaxiosPromise; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + params: Params$Resource$Partners$Editassignedtargetingoptions, + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + callback: BodyResponseCallback + ): void; + editAssignedTargetingOptions( + paramsOrCallback?: + | Params$Resource$Partners$Editassignedtargetingoptions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Editassignedtargetingoptions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Editassignedtargetingoptions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/partners/{+partnerId}:editAssignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Partners$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Partners$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/partners/{+partnerId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists partners that are accessible to the current user. The order is defined by the order_by parameter. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Partners$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Partners$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/partners').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Editassignedtargetingoptions + extends StandardParameters { + /** + * Required. The ID of the partner. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditPartnerAssignedTargetingOptionsRequest; + } + export interface Params$Resource$Partners$Get extends StandardParameters { + /** + * Required. The ID of the partner to fetch. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$List extends StandardParameters { + /** + * Allows filtering by partner fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `AND` or `OR` logical operators. A sequence of restrictions implicitly uses `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `entityStatus` Examples: * All active partners: `entityStatus="ENTITY_STATUS_ACTIVE"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + + export class Resource$Partners$Channels { + context: APIRequestContext; + sites: Resource$Partners$Channels$Sites; + constructor(context: APIRequestContext) { + this.context = context; + this.sites = new Resource$Partners$Channels$Sites(this.context); + } + + /** + * Creates a new channel. Returns the newly created channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Partners$Channels$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Channels$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Channels$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/partners/{+partnerId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a channel for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Partners$Channels$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Channels$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Channels$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Channels$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/partners/{+partnerId}/channels/{+channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists channels for a partner or advertiser. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Partners$Channels$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Channels$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Channels$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Channels$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/partners/{+partnerId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId'], + pathParams: ['partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates a channel. Returns the updated channel if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Partners$Channels$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Partners$Channels$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Partners$Channels$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Partners$Channels$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Partners$Channels$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/partners/{+partnerId}/channels/{channelId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Channels$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + export interface Params$Resource$Partners$Channels$Get + extends StandardParameters { + /** + * The ID of the advertiser that owns the fetched channel. + */ + advertiserId?: string; + /** + * Required. The ID of the channel to fetch. + */ + channelId?: string; + /** + * The ID of the partner that owns the fetched channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the channels. + */ + advertiserId?: string; + /** + * Allows filtering by channel fields. Supported syntax: * Filter expressions for channel can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `displayName` Examples: * All channels for which the display name contains "google": `displayName : "google"`. The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that owns the channels. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$Patch + extends StandardParameters { + /** + * The ID of the advertiser that owns the created channel. + */ + advertiserId?: string; + /** + * Output only. The unique ID of the channel. Assigned by the system. + */ + channelId?: string; + /** + * The ID of the partner that owns the created channel. + */ + partnerId?: string; + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Channel; + } + + export class Resource$Partners$Channels$Sites { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEdit( + params?: Params$Resource$Partners$Channels$Sites$Bulkedit, + options?: MethodOptions + ): GaxiosPromise; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEdit( + params: Params$Resource$Partners$Channels$Sites$Bulkedit, + callback: BodyResponseCallback + ): void; + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Bulkedit + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Bulkedit; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Bulkedit; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{partnerId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Creates a site in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Channels$Sites$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Channels$Sites$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/partners/{partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a site from a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Partners$Channels$Sites$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Channels$Sites$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{partnerId}/channels/{+channelId}/sites/{+urlOrAppId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId', 'urlOrAppId'], + pathParams: ['channelId', 'partnerId', 'urlOrAppId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists sites in a channel. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Partners$Channels$Sites$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Channels$Sites$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Channels$Sites$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Channels$Sites$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/partners/{+partnerId}/channels/{+channelId}/sites' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: StreamMethodOptions + ): GaxiosPromise; + replace( + params?: Params$Resource$Partners$Channels$Sites$Replace, + options?: MethodOptions + ): GaxiosPromise; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + replace( + params: Params$Resource$Partners$Channels$Sites$Replace, + callback: BodyResponseCallback + ): void; + replace(callback: BodyResponseCallback): void; + replace( + paramsOrCallback?: + | Params$Resource$Partners$Channels$Sites$Replace + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Channels$Sites$Replace; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Partners$Channels$Sites$Replace; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{partnerId}/channels/{+channelId}/sites:replace' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId', 'channelId'], + pathParams: ['channelId', 'partnerId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Partners$Channels$Sites$Bulkedit + extends StandardParameters { + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; + } + export interface Params$Resource$Partners$Channels$Sites$Create + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel in which the site will be created. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Site; + } + export interface Params$Resource$Partners$Channels$Sites$Delete + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the site belongs. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + /** + * Required. The URL or app ID of the site to delete. + */ + urlOrAppId?: string; + } + export interface Params$Resource$Partners$Channels$Sites$List + extends StandardParameters { + /** + * The ID of the advertiser that owns the parent channel. + */ + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the requested sites belong. + */ + channelId?: string; + /** + * Allows filtering by site fields. Supported syntax: * Filter expressions for site retrieval can only contain at most one restriction. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `HAS (:)` operator. Supported fields: * `urlOrAppId` Examples: * All sites for which the URL or app ID contains "google": `urlOrAppId : "google"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * 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. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + } + export interface Params$Resource$Partners$Channels$Sites$Replace + extends StandardParameters { + /** + * Required. The ID of the parent channel whose sites will be replaced. + */ + channelId?: string; + /** + * The ID of the partner that owns the parent channel. + */ + partnerId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ReplaceSitesRequest; + } + + export class Resource$Partners$Targetingtypes { + context: APIRequestContext; + assignedTargetingOptions: Resource$Partners$Targetingtypes$Assignedtargetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.assignedTargetingOptions = + new Resource$Partners$Targetingtypes$Assignedtargetingoptions( + this.context + ); + } + } + + export class Resource$Partners$Targetingtypes$Assignedtargetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Assigns a targeting option to a partner. Returns the assigned targeting option if successful. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create, + callback: BodyResponseCallback + ): void; + create( + callback: BodyResponseCallback + ): void; + create( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['partnerId', 'targetingType'], + pathParams: ['partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes an assigned targeting option from a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: [ + 'partnerId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: ['assignedTargetingOptionId', 'partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a single targeting option assigned to a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [ + 'partnerId', + 'targetingType', + 'assignedTargetingOptionId', + ], + pathParams: ['assignedTargetingOptionId', 'partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the targeting options assigned to a partner. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/partners/{+partnerId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['partnerId', 'targetingType'], + pathParams: ['partnerId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Create + extends StandardParameters { + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$AssignedTargetingOption; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Delete + extends StandardParameters { + /** + * Required. The ID of the assigned targeting option to delete. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$Get + extends StandardParameters { + /** + * Required. An identifier unique to the targeting type in this partner that identifies the assigned targeting option being requested. + */ + assignedTargetingOptionId?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of this assigned targeting option. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + export interface Params$Resource$Partners$Targetingtypes$Assignedtargetingoptions$List + extends StandardParameters { + /** + * Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `assignedTargetingOptionId` Examples: * `AssignedTargetingOption` resource with ID 123456: `assignedTargetingOptionId="123456"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + /** + * Required. The ID of the partner. + */ + partnerId?: string; + /** + * Required. Identifies the type of assigned targeting options to list. Supported targeting types: * `TARGETING_TYPE_CHANNEL` + */ + targetingType?: string; + } + + export class Resource$Sdfdownloadtasks { + context: APIRequestContext; + operations: Resource$Sdfdownloadtasks$Operations; + constructor(context: APIRequestContext) { + this.context = context; + this.operations = new Resource$Sdfdownloadtasks$Operations(this.context); + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Sdfdownloadtasks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Sdfdownloadtasks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Sdfdownloadtasks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Sdfdownloadtasks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfdownloadtasks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfdownloadtasks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/sdfdownloadtasks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sdfdownloadtasks$Create + extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$CreateSdfDownloadTaskRequest; + } + + export class Resource$Sdfdownloadtasks$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets the latest state of an asynchronous SDF download task operation. Clients should poll this method at intervals of 30 seconds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Sdfdownloadtasks$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Sdfdownloadtasks$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Sdfdownloadtasks$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Sdfdownloadtasks$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Sdfdownloadtasks$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Sdfdownloadtasks$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + + export class Resource$Targetingtypes { + context: APIRequestContext; + targetingOptions: Resource$Targetingtypes$Targetingoptions; + constructor(context: APIRequestContext) { + this.context = context; + this.targetingOptions = new Resource$Targetingtypes$Targetingoptions( + this.context + ); + } + } + + export class Resource$Targetingtypes$Targetingoptions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets a single targeting option. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Targetingtypes$Targetingoptions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Targetingtypes$Targetingoptions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/targetingTypes/{+targetingType}/targetingOptions/{+targetingOptionId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['targetingType', 'targetingOptionId'], + pathParams: ['targetingOptionId', 'targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists targeting options of a given type. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Targetingtypes$Targetingoptions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Targetingtypes$Targetingoptions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/targetingTypes/{+targetingType}/targetingOptions' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['targetingType'], + pathParams: ['targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Searches for targeting options of a given type based on the given search terms. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Targetingtypes$Targetingoptions$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Targetingtypes$Targetingoptions$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Targetingtypes$Targetingoptions$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Targetingtypes$Targetingoptions$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Targetingtypes$Targetingoptions$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v3/targetingTypes/{+targetingType}/targetingOptions:search' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['targetingType'], + pathParams: ['targetingType'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Targetingtypes$Targetingoptions$Get + extends StandardParameters { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Required. The ID of the of targeting option to retrieve. + */ + targetingOptionId?: 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` + */ + targetingType?: string; + } + export interface Params$Resource$Targetingtypes$Targetingoptions$List + extends StandardParameters { + /** + * Required. The Advertiser this request is being made in the context of. + */ + advertiserId?: string; + /** + * Allows filtering by targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by `OR` logical operators. * A restriction has the form of `{field\} {operator\} {value\}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `carrierAndIspDetails.type` * `geoRegionDetails.geoRegionType` * `targetingOptionId` Examples: * All `GEO REGION` targeting options that belong to sub type `GEO_REGION_TYPE_COUNTRY` or `GEO_REGION_TYPE_STATE`: `geoRegionDetails.geoRegionType="GEO_REGION_TYPE_COUNTRY" OR geoRegionDetails.geoRegionType="GEO_REGION_TYPE_STATE"` * All `CARRIER AND ISP` targeting options that belong to sub type `CARRIER_AND_ISP_TYPE_CARRIER`: `carrierAndIspDetails.type="CARRIER_AND_ISP_TYPE_CARRIER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: 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` + */ + targetingType?: string; + } + export interface Params$Resource$Targetingtypes$Targetingoptions$Search + extends StandardParameters { + /** + * Required. The type of targeting options to retrieve. Accepted values are: * `TARGETING_TYPE_GEO_REGION` * `TARGETING_TYPE_POI` * `TARGETING_TYPE_BUSINESS_CHAIN` + */ + targetingType?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SearchTargetingOptionsRequest; + } + + export class Resource$Users { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Bulk edits user roles for a user. The operation will delete the assigned user roles provided in BulkEditAssignedUserRolesRequest.deletedAssignedUserRoles and then assign the user roles provided in BulkEditAssignedUserRolesRequest.createdAssignedUserRoles. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: StreamMethodOptions + ): GaxiosPromise; + bulkEditAssignedUserRoles( + params?: Params$Resource$Users$Bulkeditassigneduserroles, + options?: MethodOptions + ): GaxiosPromise; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + params: Params$Resource$Users$Bulkeditassigneduserroles, + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + callback: BodyResponseCallback + ): void; + bulkEditAssignedUserRoles( + paramsOrCallback?: + | Params$Resource$Users$Bulkeditassigneduserroles + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Bulkeditassigneduserroles; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Bulkeditassigneduserroles; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v3/users/{+userId}:bulkEditAssignedUserRoles' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Creates a new user. Returns the newly created user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Users$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Users$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Users$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Users$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Users$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Users$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/users').replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Users$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Users$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Users$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Users$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Users$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Users$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/users/{+userId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets a user. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Users$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Users$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Users$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Users$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Users$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Users$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/users/{+userId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists users that are accessible to the current user. If two users have user roles on the same partner or advertiser, they can access each other. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Users$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Users$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Users$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Users$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Users$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Users$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/users').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing user. Returns the updated user if successful. This method has unique authentication requirements. Read the prerequisites in our [Managing Users guide](/display-video/api/guides/users/overview#prerequisites) before using this method. The "Try this method" feature does not work for this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Users$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Users$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Users$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Users$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Users$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Users$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Users$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Users$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://displayvideo.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v3/users/{+userId}').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['userId'], + pathParams: ['userId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Users$Bulkeditassigneduserroles + extends StandardParameters { + /** + * Required. The ID of the user to which the assigned user roles belong. + */ + userId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditAssignedUserRolesRequest; + } + export interface Params$Resource$Users$Create extends StandardParameters { + /** + * Request body metadata + */ + requestBody?: Schema$User; + } + export interface Params$Resource$Users$Delete extends StandardParameters { + /** + * Required. The ID of the user to delete. + */ + userId?: string; + } + export interface Params$Resource$Users$Get extends StandardParameters { + /** + * Required. The ID of the user to fetch. + */ + userId?: string; + } + export interface Params$Resource$Users$List extends StandardParameters { + /** + * Allows filtering by user fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `AND`. * A restriction has the form of `{field\} {operator\} {value\}`. * The `budget.budget_segments.date_range.end_date` field must use the `LESS THAN (<)` operator. * The `displayName and `email` field must use the `HAS (:)` operator. * All other fields must use the `EQUALS (=)` operator. Supported fields: * `assignedUserRole.advertiserId` * `assignedUserRole.entityType` * This is synthetic field of `AssignedUserRole` used for filtering. Identifies the type of entity to which the user role is assigned. Valid values are `Partner` and `Advertiser`. * `assignedUserRole.parentPartnerId` * This is a synthetic field of `AssignedUserRole` used for filtering. Identifies the parent partner of the entity to which the user role is assigned. * `assignedUserRole.partnerId` * `assignedUserRole.userRole` * `displayName` * `email` 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. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. + */ + filter?: 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`. + */ + orderBy?: string; + /** + * Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. + */ + pageSize?: number; + /** + * 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. + */ + pageToken?: string; + } + export interface Params$Resource$Users$Patch extends StandardParameters { + /** + * Required. The mask to control which fields to update. + */ + updateMask?: string; + /** + * Output only. The unique ID of the user. Assigned by the system. + */ + userId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$User; + } +} diff --git a/src/apis/dlp/v2.ts b/src/apis/dlp/v2.ts index bbd0c854a2..6dee6fea90 100644 --- a/src/apis/dlp/v2.ts +++ b/src/apis/dlp/v2.ts @@ -1352,6 +1352,10 @@ export namespace dlp_v2 { * If created by a job trigger, the resource name of the trigger that instantiated the job. */ jobTriggerName?: string | null; + /** + * Time when the job was last modified by the system. + */ + lastModified?: string | null; /** * The server-assigned name. */ diff --git a/src/apis/docs/v1.ts b/src/apis/docs/v1.ts index f9be741dca..a73b8c45e5 100644 --- a/src/apis/docs/v1.ts +++ b/src/apis/docs/v1.ts @@ -619,6 +619,10 @@ export namespace docs_v1 { * The ID of the header used only for the first page. If not set then a unique header for the first page does not exist. The value of use_first_page_header_footer determines whether to use the default_header_id or this value for the header on the first page. If not set, there's no first page header. This property is read-only. */ firstPageHeaderId?: string | null; + /** + * Optional. Indicates whether to flip the dimensions of the page_size, which allows changing the page orientation between portrait and landscape. + */ + flipPageOrientation?: boolean | null; /** * The bottom page margin. Updating the bottom page margin on the document style clears the bottom page margin on all section styles. */ @@ -696,6 +700,10 @@ export namespace docs_v1 { * Indicates if there was a suggested change to first_page_header_id. */ firstPageHeaderIdSuggested?: boolean | null; + /** + * Optional. Indicates if there was a suggested change to flip_page_orientation. + */ + flipPageOrientationSuggested?: boolean | null; /** * Indicates if there was a suggested change to margin_bottom. */ @@ -2385,6 +2393,10 @@ export namespace docs_v1 { * The ID of the header used only for the first page of the section. If use_first_page_header_footer is true, this value is used for the header on the first page of the section. If it's false, the header on the first page of the section uses the default_header_id. If unset, the value inherits from the previous SectionBreak's SectionStyle. If the value is unset in the first SectionBreak, it inherits from DocumentStyle's first_page_header_id. This property is read-only. */ firstPageHeaderId?: string | null; + /** + * Optional. Indicates whether to flip the dimensions of DocumentStyle's page_size for this section, which allows changing the page orientation between portrait and landscape. If unset, the value inherits from DocumentStyle's flip_page_orientation. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. + */ + flipPageOrientation?: boolean | null; /** * The bottom page margin of the section. If unset, the value defaults to margin_bottom from DocumentStyle. When updating this property, setting a concrete value is required. Unsetting this property results in a 400 bad request error. */ diff --git a/src/apis/documentai/v1.ts b/src/apis/documentai/v1.ts index 9e76899d00..5747b71d5d 100644 --- a/src/apis/documentai/v1.ts +++ b/src/apis/documentai/v1.ts @@ -2998,7 +2998,7 @@ export namespace documentai_v1 { updateTime?: string | null; } /** - * A singleton resource under a Processor which configures a collection of documents. Next Id: 8. + * A singleton resource under a Processor which configures a collection of documents. */ export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { /** @@ -4847,7 +4847,7 @@ export namespace documentai_v1 { */ computeStyleInfo?: boolean | null; /** - * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0+ processors. + * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. */ disableCharacterBoxesDetection?: boolean | null; /** @@ -4893,7 +4893,7 @@ export namespace documentai_v1 { */ enableMathOcr?: boolean | null; /** - * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+ processors. + * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. */ enableSelectionMarkDetection?: boolean | null; } @@ -4906,7 +4906,7 @@ export namespace documentai_v1 { */ fromEnd?: number | null; /** - * Only process certain pages from the start, process all if the document has less pages. + * Only process certain pages from the start. Process all if the document has fewer pages. */ fromStart?: number | null; /** diff --git a/src/apis/documentai/v1beta2.ts b/src/apis/documentai/v1beta2.ts index 6d8c738645..21c9b93a1d 100644 --- a/src/apis/documentai/v1beta2.ts +++ b/src/apis/documentai/v1beta2.ts @@ -3090,7 +3090,7 @@ export namespace documentai_v1beta2 { updateTime?: string | null; } /** - * A singleton resource under a Processor which configures a collection of documents. Next Id: 8. + * A singleton resource under a Processor which configures a collection of documents. */ export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { /** diff --git a/src/apis/documentai/v1beta3.ts b/src/apis/documentai/v1beta3.ts index b4e0425b65..1e48c19e7e 100644 --- a/src/apis/documentai/v1beta3.ts +++ b/src/apis/documentai/v1beta3.ts @@ -3067,7 +3067,7 @@ export namespace documentai_v1beta3 { updateTime?: string | null; } /** - * A singleton resource under a Processor which configures a collection of documents. Next Id: 8. + * A singleton resource under a Processor which configures a collection of documents. */ export interface Schema$GoogleCloudDocumentaiV1beta3Dataset { /** @@ -3385,6 +3385,31 @@ export namespace documentai_v1beta3 { */ docId?: string | null; } + /** + * Metadata about a document. + */ + export interface Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata { + /** + * Type of the dataset split to which the document belongs. + */ + datasetType?: string | null; + /** + * The display name of the document. + */ + displayName?: string | null; + /** + * Document identifier. + */ + documentId?: Schema$GoogleCloudDocumentaiV1beta3DocumentId; + /** + * Labelling state of the document. + */ + labelingState?: string | null; + /** + * Number of pages in the document. + */ + pageCount?: number | null; + } /** * Config that controls the output of documents. All documents will be written as a JSON file. */ @@ -4657,6 +4682,42 @@ export namespace documentai_v1beta3 { */ processorVersion?: string | null; } + export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest { + /** + * Optional. Query to filter the documents based on https://google.aip.dev/160. ## Currently support query strings are: `SplitType=DATASET_SPLIT_TEST|DATASET_SPLIT_TRAIN|DATASET_SPLIT_UNASSIGNED` - `LabelingState=DOCUMENT_LABELED|DOCUMENT_UNLABELED|DOCUMENT_AUTO_LABELED` - `DisplayName=\"file_name.pdf\"` - `EntityType=abc/def` - `TagName=\"auto-labeling-running\"|\"sampled\"` Note: - Only `AND`, `=` and `!=` are supported. e.g. `DisplayName=file_name AND EntityType!=abc` IS supported. - Wildcard `*` is supported only in `DisplayName` filter - No duplicate filter keys are allowed, e.g. `EntityType=a AND EntityType=b` is NOT supported. - String match is case sensitive (for filter `DisplayName` & `EntityType`). + */ + filter?: string | null; + /** + * The maximum number of documents to return. The service may return fewer than this value. If unspecified, at most 20 documents will be returned. The maximum value is 100; values above 100 will be coerced to 100. + */ + pageSize?: number | null; + /** + * A page token, received from a previous `ListDocuments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListDocuments` must match the call that provided the page token. + */ + pageToken?: string | null; + /** + * Optional. Controls if the ListDocuments request requires a total size of matched documents. See ListDocumentsResponse.total_size. Enabling this flag may adversely impact performance. Defaults to false. + */ + returnTotalSize?: boolean | null; + /** + * Optional. Number of results to skip beginning from the `page_token` if provided. https://google.aip.dev/158#skipping-results. It must be a non-negative integer. Negative values wil be rejected. Note that this is not the number of pages to skip. If this value causes the cursor to move past the end of results, `ListDocumentsResponse.document_metadata` and `ListDocumentsResponse.next_page_token` will be empty. + */ + skip?: number | null; + } + export interface Schema$GoogleCloudDocumentaiV1beta3ListDocumentsResponse { + /** + * Document metadata corresponding to the listed documents. + */ + documentMetadata?: Schema$GoogleCloudDocumentaiV1beta3DocumentMetadata[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Total count of documents queried. + */ + totalSize?: number | null; + } /** * The response from `ListEvaluations`. */ @@ -4735,7 +4796,7 @@ export namespace documentai_v1beta3 { */ computeStyleInfo?: boolean | null; /** - * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0+ processors. + * Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors. */ disableCharacterBoxesDetection?: boolean | null; /** @@ -4781,7 +4842,7 @@ export namespace documentai_v1beta3 { */ enableMathOcr?: boolean | null; /** - * Turn on selection mark detector in OCR engine. Only available in OCR 2.0+ processors. + * Turn on selection mark detector in OCR engine. Only available in OCR 2.0 (and later) processors. */ enableSelectionMarkDetection?: boolean | null; } @@ -4794,7 +4855,7 @@ export namespace documentai_v1beta3 { */ fromEnd?: number | null; /** - * Only process certain pages from the start, process all if the document has less pages. + * Only process certain pages from the start. Process all if the document has fewer pages. */ fromStart?: number | null; /** @@ -7909,6 +7970,103 @@ export namespace documentai_v1beta3 { } } + /** + * Returns a list of documents present in the dataset. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + options: StreamMethodOptions + ): GaxiosPromise; + listDocuments( + params?: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + options?: MethodOptions + ): GaxiosPromise; + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + listDocuments( + params: Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments, + callback: BodyResponseCallback + ): void; + listDocuments( + callback: BodyResponseCallback + ): void; + listDocuments( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://documentai.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta3/{+dataset}:listDocuments').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['dataset'], + pathParams: ['dataset'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Updates a `DatasetSchema`. * @@ -8082,6 +8240,18 @@ export namespace documentai_v1beta3 { */ requestBody?: Schema$GoogleCloudDocumentaiV1beta3ImportDocumentsRequest; } + export interface Params$Resource$Projects$Locations$Processors$Dataset$Listdocuments + extends StandardParameters { + /** + * Required. The resource name of the dataset to be listed. Format: projects/{project\}/locations/{location\}/processors/{processor\}/dataset + */ + dataset?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudDocumentaiV1beta3ListDocumentsRequest; + } export interface Params$Resource$Projects$Locations$Processors$Dataset$Updatedatasetschema extends StandardParameters { /** diff --git a/src/apis/eventarc/v1.ts b/src/apis/eventarc/v1.ts index 17eb525edc..db62f7e570 100644 --- a/src/apis/eventarc/v1.ts +++ b/src/apis/eventarc/v1.ts @@ -472,10 +472,6 @@ export namespace eventarc_v1 { * Represents a HTTP endpoint destination. */ export interface Schema$HttpEndpoint { - /** - * Optional. Forwards DNS requests to the VPC specified by network config to resolve the HTTP endpoint. Default to false. If set to true, Eventarc will create a peering zone to the consumer VPC and forward DNS requests. See: https://cloud.google.com/dns/docs/zones/zones-overview#peering_zones Enable this if the URI uses an internal DNS name or a private Cloud DNS zone. - */ - forwardDnsRequests?: boolean | null; /** * Required. The URI of the HTTP enpdoint. The value must be a RFC2396 URI string. Examples: `http://10.10.10.8:80/route`, `http://svc.us-central1.p.local:8080/`. Only HTTP and HTTPS protocols are supported. The host can be either a static IP addressable from the VPC specified by the network config, or an internal DNS hostname of the service resolvable via Cloud DNS. */ diff --git a/src/apis/firestore/v1.ts b/src/apis/firestore/v1.ts index 87cad838c5..e2d056c486 100644 --- a/src/apis/firestore/v1.ts +++ b/src/apis/firestore/v1.ts @@ -752,7 +752,7 @@ export namespace firestore_v1 { */ outputUriPrefix?: string | null; /** - * The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 1 hour. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents. + * The timestamp that corresponds to the version of the database to be exported. The timestamp must be rounded to the minute, in the past, and not older than 5 days. Please choose a reasonable timestamp based on prior knowledge on how long exports take as data at provided snapshot timestamp can expire during export. If specified, then the exported documents will represent a consistent view of the database at the provided time. Otherwise, there are no guarantees about the consistency of the exported documents. */ snapshotTime?: string | null; } @@ -819,6 +819,10 @@ export namespace firestore_v1 { */ ttlConfigDelta?: Schema$GoogleFirestoreAdminV1TtlConfigDelta; } + /** + * An index that stores vectors in a flat data structure, and supports exhaustive search. + */ + export interface Schema$GoogleFirestoreAdminV1FlatIndex {} /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. */ @@ -948,6 +952,10 @@ export namespace firestore_v1 { * Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, \>, \>=. */ order?: string | null; + /** + * Indicates that this field supports nearest neighbors and distance operations on vector. + */ + vectorConfig?: Schema$GoogleFirestoreAdminV1VectorConfig; } /** * Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. @@ -1086,7 +1094,7 @@ export namespace firestore_v1 { */ export interface Schema$GoogleFirestoreAdminV1RestoreDatabaseRequest { /** - * Required. Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` + * Backup to restore from. Must be from the same project as the parent. Format is: `projects/{project_id\}/locations/{location\}/backups/{backup\}` */ backup?: string | null; /** @@ -1133,6 +1141,19 @@ export namespace firestore_v1 { * Metadata related to the update database operation. */ export interface Schema$GoogleFirestoreAdminV1UpdateDatabaseMetadata {} + /** + * The index configuration to support vector search operations + */ + export interface Schema$GoogleFirestoreAdminV1VectorConfig { + /** + * Required. The vector dimension this configuration applies to. The resulting index will only include vectors of this dimension, and can be used for vector search with the same dimension. + */ + dimension?: number | null; + /** + * Indicates the vector index is a flat index. + */ + flat?: Schema$GoogleFirestoreAdminV1FlatIndex; + } /** * Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. */ @@ -1376,7 +1397,7 @@ export namespace firestore_v1 { */ nextPageToken?: string | null; /** - * Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned. + * Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned, or that the query is not yet supported for partitioning. */ partitions?: Schema$Cursor[]; } diff --git a/src/apis/firestore/v1beta1.ts b/src/apis/firestore/v1beta1.ts index 522c186566..1b255dc111 100644 --- a/src/apis/firestore/v1beta1.ts +++ b/src/apis/firestore/v1beta1.ts @@ -986,7 +986,7 @@ export namespace firestore_v1beta1 { */ nextPageToken?: string | null; /** - * Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned. + * Partition results. Each partition is a split point that can be used by RunQuery as a starting or end point for the query results. The RunQuery requests must be made with the same query supplied to this PartitionQuery request. The partition cursors will be ordered according to same ordering as the results of the query supplied to PartitionQuery. For example, if a PartitionQuery request returns partition cursors A and B, running the following three queries will return the entire result set of the original query: * query, end_at A * query, start_at A, end_at B * query, start_at B An empty result may indicate that the query has too few results to be partitioned, or that the query is not yet supported for partitioning. */ partitions?: Schema$Cursor[]; } diff --git a/src/apis/gkebackup/v1.ts b/src/apis/gkebackup/v1.ts index d1179fdbbf..fc39f29f6c 100644 --- a/src/apis/gkebackup/v1.ts +++ b/src/apis/gkebackup/v1.ts @@ -752,7 +752,7 @@ export namespace gkebackup_v1 { */ jsonPath?: string | null; /** - * Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation). To mix cluster-scoped and namespaced resources in the same rule, use an empty string ("") as one of the target namespaces. + * Optional. (Filtering parameter) Any resource subject to transformation must be contained within one of the listed Kubernetes Namespace in the Backup. If this field is not provided, no namespace filtering will be performed (all resources in all Namespaces, including all cluster-scoped resources, will be candidates for transformation). */ namespaces?: string[] | null; } @@ -1193,93 +1193,6 @@ export namespace gkebackup_v1 { ); } - /** - * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - deleteOperations( - params: Params$Resource$Projects$Locations$Deleteoperations, - options: StreamMethodOptions - ): GaxiosPromise; - deleteOperations( - params?: Params$Resource$Projects$Locations$Deleteoperations, - options?: MethodOptions - ): GaxiosPromise; - deleteOperations( - params: Params$Resource$Projects$Locations$Deleteoperations, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteOperations( - params: Params$Resource$Projects$Locations$Deleteoperations, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - deleteOperations( - params: Params$Resource$Projects$Locations$Deleteoperations, - callback: BodyResponseCallback - ): void; - deleteOperations(callback: BodyResponseCallback): void; - deleteOperations( - paramsOrCallback?: - | Params$Resource$Projects$Locations$Deleteoperations - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Deleteoperations; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Locations$Deleteoperations; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1/{+name}/operations').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'DELETE', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Gets information about a location. * @@ -1457,13 +1370,6 @@ export namespace gkebackup_v1 { } } - export interface Params$Resource$Projects$Locations$Deleteoperations - extends StandardParameters { - /** - * The name of the operation resource to be deleted. - */ - name?: string; - } export interface Params$Resource$Projects$Locations$Get extends StandardParameters { /** @@ -3799,6 +3705,90 @@ export namespace gkebackup_v1 { } } + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkebackup.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * 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. * @@ -3999,6 +3989,13 @@ export namespace gkebackup_v1 { */ requestBody?: Schema$GoogleLongrunningCancelOperationRequest; } + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Operations$Get extends StandardParameters { /** diff --git a/src/apis/gkehub/v1.ts b/src/apis/gkehub/v1.ts index d4545e3bdb..26b710b689 100644 --- a/src/apis/gkehub/v1.ts +++ b/src/apis/gkehub/v1.ts @@ -1955,10 +1955,6 @@ export namespace gkehub_v1 { * Scope represents a Scope in a Fleet. */ export interface Schema$Scope { - /** - * If true, all Memberships in the Fleet bind to this Scope. - */ - allMemberships?: boolean | null; /** * Output only. When the scope was created. */ diff --git a/src/apis/gkehub/v1alpha.ts b/src/apis/gkehub/v1alpha.ts index d4f2971af5..86e28af69e 100644 --- a/src/apis/gkehub/v1alpha.ts +++ b/src/apis/gkehub/v1alpha.ts @@ -2643,10 +2643,6 @@ export namespace gkehub_v1alpha { * Scope represents a Scope in a Fleet. */ export interface Schema$Scope { - /** - * If true, all Memberships in the Fleet bind to this Scope. - */ - allMemberships?: boolean | null; /** * Output only. When the scope was created. */ diff --git a/src/apis/gkehub/v1beta.ts b/src/apis/gkehub/v1beta.ts index b91f6ccaae..0874d97309 100644 --- a/src/apis/gkehub/v1beta.ts +++ b/src/apis/gkehub/v1beta.ts @@ -165,6 +165,15 @@ export namespace gkehub_v1beta { */ networkingInstallSucceeded?: Schema$Status; } + /** + * ApplianceCluster contains information specific to GDC Edge Appliance Clusters. + */ + export interface Schema$ApplianceCluster { + /** + * Immutable. Self-link of the Google Cloud resource for the Appliance Cluster. For example: //transferappliance.googleapis.com/projects/my-project/locations/us-west1-a/appliances/my-appliance + */ + resourceLink?: string | null; + } /** * 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. */ @@ -191,6 +200,27 @@ export namespace gkehub_v1beta { */ logType?: string | null; } + /** + * 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 + */ + export interface Schema$Authority { + /** + * Output only. An identity provider that reflects the `issuer` in the workload identity pool. + */ + identityProvider?: string | null; + /** + * Optional. A JSON Web Token (JWT) issuer URI. `issuer` must start with `https://` and be a valid URL with length <2000 characters, it must use `location` rather than `zone` for GKE clusters. 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). + */ + issuer?: string | null; + /** + * 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. + */ + oidcJwks?: string | null; + /** + * 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. + */ + workloadIdentityPool?: string | null; + } /** * Associates `members`, or principals, with a `role`. */ @@ -831,6 +861,28 @@ export namespace gkehub_v1beta { */ syncToken?: string | null; } + /** + * ConnectAgentResource represents a Kubernetes resource manifest for Connect Agent deployment. + */ + export interface Schema$ConnectAgentResource { + /** + * YAML manifest of the resource. + */ + manifest?: string | null; + /** + * Kubernetes type of the resource. + */ + type?: Schema$TypeMeta; + } + /** + * EdgeCluster contains information specific to Google Edge Clusters. + */ + export interface Schema$EdgeCluster { + /** + * Immutable. Self-link of the Google Cloud resource for the Edge Cluster. For example: //edgecontainer.googleapis.com/projects/my-project/locations/us-west1-a/clusters/my-cluster + */ + resourceLink?: string | null; + } /** * 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); \} */ @@ -1085,6 +1137,15 @@ export namespace gkehub_v1beta { */ mode?: string | null; } + /** + * GenerateConnectManifestResponse contains manifest information for installing/upgrading a Connect agent. + */ + export interface Schema$GenerateConnectManifestResponse { + /** + * The ordered list of Kubernetes resources that need to be applied to the cluster for GKE Connect agent installation/upgrade. + */ + manifest?: Schema$ConnectAgentResource[]; + } /** * Response for GenerateRBACRoleBindingYAML. */ @@ -1094,6 +1155,19 @@ export namespace gkehub_v1beta { */ roleBindingsYaml?: string | null; } + /** + * GkeCluster contains information specific to GKE clusters. + */ + export interface Schema$GkeCluster { + /** + * Output only. If cluster_missing is set then it denotes that the GKE cluster no longer exists in the GKE Control Plane. + */ + clusterMissing?: boolean | null; + /** + * Immutable. Self-link of the Google Cloud 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. + */ + resourceLink?: string | null; + } /** * 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). */ @@ -1261,6 +1335,56 @@ export namespace gkehub_v1beta { */ userPrefix?: string | null; } + /** + * KubernetesMetadata provides informational metadata for Memberships representing Kubernetes clusters. + */ + export interface Schema$KubernetesMetadata { + /** + * Output only. Kubernetes API server version string as reported by `/version`. + */ + kubernetesApiServerVersion?: string | null; + /** + * Output only. The total memory capacity as reported by the sum of all Kubernetes nodes resources, defined in MB. + */ + memoryMb?: number | null; + /** + * Output only. Node count as reported by Kubernetes nodes resources. + */ + nodeCount?: number | null; + /** + * 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. + */ + nodeProviderId?: string | null; + /** + * 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. + */ + updateTime?: string | null; + /** + * Output only. vCPU count as reported by Kubernetes nodes resources. + */ + vcpuCount?: number | null; + } + /** + * 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. + */ + export interface Schema$KubernetesResource { + /** + * 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. + */ + connectResources?: Schema$ResourceManifest[]; + /** + * 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. + */ + membershipCrManifest?: string | null; + /** + * 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. + */ + membershipResources?: Schema$ResourceManifest[]; + /** + * Optional. Options for Kubernetes resource generation. + */ + resourceOptions?: Schema$ResourceOptions; + } /** * Response message for the `GkeHub.ListFeatures` method. */ @@ -1326,6 +1450,23 @@ export namespace gkehub_v1beta { */ rbacrolebindings?: Schema$RBACRoleBinding[]; } + /** + * Response message for the `GkeHub.ListMemberships` method. + */ + export interface Schema$ListMembershipsResponse { + /** + * A token to request the next page of resources from the `ListMemberships` method. The value of an empty string means that there are no more resources to return. + */ + nextPageToken?: string | null; + /** + * The list of matching Memberships. + */ + resources?: Schema$Membership[]; + /** + * List of locations that could not be reached while fetching this list. + */ + unreachable?: string[] | null; + } /** * List of fleet namespaces. */ @@ -1429,6 +1570,63 @@ export namespace gkehub_v1beta { */ name?: string | null; } + /** + * Membership contains information about a member cluster. + */ + export interface Schema$Membership { + /** + * 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 + */ + authority?: Schema$Authority; + /** + * Output only. When the Membership was created. + */ + createTime?: string | null; + /** + * Output only. When the Membership was deleted. + */ + deleteTime?: string | null; + /** + * 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. + */ + description?: string | null; + /** + * Optional. Endpoint information to reach this member. + */ + endpoint?: Schema$MembershipEndpoint; + /** + * 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. + */ + externalId?: string | null; + /** + * Optional. Labels for this membership. + */ + labels?: {[key: string]: string} | null; + /** + * 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. + */ + lastConnectionTime?: string | null; + /** + * Optional. The monitoring config information for this membership. + */ + monitoringConfig?: Schema$MonitoringConfig; + /** + * Output only. The full, unique name of this Membership resource in the format `projects/x/locations/x/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. + */ + name?: string | null; + /** + * Output only. State of the Membership resource. + */ + state?: Schema$MembershipState; + /** + * 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. + */ + uniqueId?: string | null; + /** + * Output only. When the Membership was last updated. + */ + updateTime?: string | null; + } /** * MembershipBinding is a subresource of a Membership, representing what Fleet Scopes (or other, future Fleet resources) a Membership is bound to. */ @@ -1475,6 +1673,43 @@ export namespace gkehub_v1beta { */ code?: string | null; } + /** + * MembershipEndpoint contains information needed to contact a Kubernetes API, endpoint and any additional Kubernetes metadata. + */ + export interface Schema$MembershipEndpoint { + /** + * Optional. Specific information for a GDC Edge Appliance cluster. + */ + applianceCluster?: Schema$ApplianceCluster; + /** + * Optional. Specific information for a Google Edge cluster. + */ + edgeCluster?: Schema$EdgeCluster; + /** + * Optional. Specific information for a GKE-on-GCP cluster. + */ + gkeCluster?: Schema$GkeCluster; + /** + * Output only. Whether the lifecycle of this membership is managed by a google cluster platform service. + */ + googleManaged?: boolean | null; + /** + * Output only. Useful Kubernetes-specific metadata. + */ + kubernetesMetadata?: Schema$KubernetesMetadata; + /** + * 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. + */ + kubernetesResource?: Schema$KubernetesResource; + /** + * Optional. Specific information for a GKE Multi-Cloud cluster. + */ + multiCloudCluster?: Schema$MultiCloudCluster; + /** + * 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. + */ + onPremCluster?: Schema$OnPremCluster; + } /** * MembershipFeatureSpec contains configuration information for a single Membership. NOTE: Please use snake case in your feature name. */ @@ -1562,6 +1797,15 @@ export namespace gkehub_v1beta { */ version?: string | null; } + /** + * MembershipState describes the state of a Membership resource. + */ + export interface Schema$MembershipState { + /** + * Output only. The current state of the Membership resource. + */ + code?: string | null; + } /** * **Metering**: Per-Membership Feature State. */ @@ -1575,6 +1819,44 @@ export namespace gkehub_v1beta { */ preciseLastMeasuredClusterVcpuCapacity?: number | null; } + /** + * This field informs Fleet-based applications/services/UIs with the necessary information for where each underlying Cluster reports its metrics. + */ + export interface Schema$MonitoringConfig { + /** + * Immutable. Cluster name used to report metrics. For Anthos on VMWare/Baremetal, it would be in format `memberClusters/cluster_name`; And for Anthos on MultiCloud, it would be in format `{azureClusters, awsClusters\}/cluster_name`. + */ + cluster?: string | null; + /** + * Immutable. Cluster hash, this is a unique string generated by google code, which does not contain any PII, which we can use to reference the cluster. This is expected to be created by the monitoring stack and persisted into the Cluster object as well as to GKE-Hub. + */ + clusterHash?: string | null; + /** + * Kubernetes system metrics, if available, are written to this prefix. This defaults to kubernetes.io for GKE, and kubernetes.io/anthos for Anthos eventually. Noted: Anthos MultiCloud will have kubernetes.io prefix today but will migration to be under kubernetes.io/anthos + */ + kubernetesMetricsPrefix?: string | null; + /** + * Immutable. Location used to report Metrics + */ + location?: string | null; + /** + * Immutable. Project used to report Metrics + */ + projectId?: string | null; + } + /** + * MultiCloudCluster contains information specific to GKE Multi-Cloud clusters. + */ + export interface Schema$MultiCloudCluster { + /** + * 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. + */ + clusterMissing?: boolean | null; + /** + * Immutable. Self-link of the Google Cloud 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 + */ + resourceLink?: string | null; + } /** * **Multi-cluster Ingress**: The configuration for the MultiClusterIngress feature. */ @@ -1638,6 +1920,27 @@ export namespace gkehub_v1beta { */ code?: string | null; } + /** + * OnPremCluster contains information specific to GKE On-Prem clusters. + */ + export interface Schema$OnPremCluster { + /** + * Immutable. Whether the cluster is an admin cluster. + */ + adminCluster?: boolean | null; + /** + * 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. + */ + clusterMissing?: boolean | null; + /** + * Immutable. The on prem cluster's type. + */ + clusterType?: string | null; + /** + * Immutable. Self-link of the Google Cloud 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 + */ + resourceLink?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -2003,6 +2306,36 @@ export namespace gkehub_v1beta { */ code?: string | null; } + /** + * ResourceManifest represents a single Kubernetes resource to be applied to the cluster. + */ + export interface Schema$ResourceManifest { + /** + * 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. + */ + clusterScoped?: boolean | null; + /** + * YAML manifest of the resource. + */ + manifest?: string | null; + } + /** + * ResourceOptions represent options for Kubernetes resource generation. + */ + export interface Schema$ResourceOptions { + /** + * 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. + */ + connectVersion?: string | null; + /** + * 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`. + */ + k8sVersion?: string | null; + /** + * Optional. Use `apiextensions/v1beta1` instead of `apiextensions/v1` for CustomResourceDefinition resources. This option should be set for clusters with Kubernetes apiserver versions <1.16. + */ + v1beta1Crd?: boolean | null; + } /** * Role is the type for Kubernetes roles */ @@ -2016,10 +2349,6 @@ export namespace gkehub_v1beta { * Scope represents a Scope in a Fleet. */ export interface Schema$Scope { - /** - * If true, all Memberships in the Fleet bind to this Scope. - */ - allMemberships?: boolean | null; /** * Output only. When the scope was created. */ @@ -2184,6 +2513,19 @@ export namespace gkehub_v1beta { */ permissions?: string[] | null; } + /** + * TypeMeta is the type information needed for content unmarshalling of Kubernetes resources in the manifest. + */ + export interface Schema$TypeMeta { + /** + * APIVersion of the resource (e.g. v1). + */ + apiVersion?: string | null; + /** + * Kind of the resource (e.g. Deployment). + */ + kind?: string | null; + } export class Resource$Organizations { context: APIRequestContext; @@ -3891,58 +4233,57 @@ export namespace gkehub_v1beta { } /** - * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * Creates a new Membership. **This is currently only supported for GKE clusters on Google Cloud**. To register other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - getIamPolicy( - params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + create( + params: Params$Resource$Projects$Locations$Memberships$Create, options: StreamMethodOptions ): GaxiosPromise; - getIamPolicy( - params?: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + create( + params?: Params$Resource$Projects$Locations$Memberships$Create, options?: MethodOptions - ): GaxiosPromise; - getIamPolicy( - params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Memberships$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Memberships$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - getIamPolicy( - params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, - callback: BodyResponseCallback + create( + params: Params$Resource$Projects$Locations$Memberships$Create, + callback: BodyResponseCallback ): void; - getIamPolicy(callback: BodyResponseCallback): void; - getIamPolicy( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Projects$Locations$Memberships$Getiampolicy - | BodyResponseCallback + | Params$Resource$Projects$Locations$Memberships$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { + ): void | GaxiosPromise | GaxiosPromise { let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Locations$Memberships$Getiampolicy; + {}) as Params$Resource$Projects$Locations$Memberships$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Projects$Locations$Memberships$Getiampolicy; + params = {} as Params$Resource$Projects$Locations$Memberships$Create; options = {}; } @@ -3955,45 +4296,574 @@ export namespace gkehub_v1beta { const parameters = { options: Object.assign( { - url: (rootUrl + '/v1beta/{+resource}:getIamPolicy').replace( + url: (rootUrl + '/v1beta/{+parent}/memberships').replace( /([^:]\/)\/+/g, '$1' ), - method: 'GET', + method: 'POST', }, options ), params, - requiredParams: ['resource'], - pathParams: ['resource'], + requiredParams: ['parent'], + pathParams: ['parent'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * Removes a Membership. **This is currently only supported for GKE clusters on Google Cloud**. To unregister other clusters, follow the instructions at https://cloud.google.com/anthos/multicluster-management/connect/unregistering-a-cluster. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. * @param callback - Optional callback that handles the response. * @returns A promise if used with async/await, or void if used with a callback. */ - setIamPolicy( - params: Params$Resource$Projects$Locations$Memberships$Setiampolicy, + delete( + params: Params$Resource$Projects$Locations$Memberships$Delete, options: StreamMethodOptions ): GaxiosPromise; - setIamPolicy( - params?: Params$Resource$Projects$Locations$Memberships$Setiampolicy, + delete( + params?: Params$Resource$Projects$Locations$Memberships$Delete, options?: MethodOptions - ): GaxiosPromise; + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Memberships$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Memberships$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Memberships$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Generates the manifest for deployment of the GKE connect agent. **This method is used internally by Google-provided libraries.** Most clients should not need to call this method directly. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateConnectManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest, + options: StreamMethodOptions + ): GaxiosPromise; + generateConnectManifest( + params?: Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest, + options?: MethodOptions + ): GaxiosPromise; + generateConnectManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateConnectManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateConnectManifest( + params: Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest, + callback: BodyResponseCallback + ): void; + generateConnectManifest( + callback: BodyResponseCallback + ): void; + generateConnectManifest( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}:generateConnectManifest').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Gets the details of a Membership. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Memberships$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Memberships$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Memberships$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Memberships$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Memberships$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Memberships$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Memberships$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists Memberships in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Memberships$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Memberships$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Memberships$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Memberships$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Memberships$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Memberships$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}/memberships').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates an existing Membership. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Memberships$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Memberships$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Memberships$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Memberships$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Memberships$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Memberships$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Memberships$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://gkehub.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Memberships$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Memberships$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; setIamPolicy( params: Params$Resource$Projects$Locations$Memberships$Setiampolicy, options: StreamMethodOptions | BodyResponseCallback, @@ -4162,6 +5032,79 @@ export namespace gkehub_v1beta { } } + export interface Params$Resource$Projects$Locations$Memberships$Create + extends StandardParameters { + /** + * Required. Client chosen ID for the membership. `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. + */ + membershipId?: string; + /** + * Required. The parent (project and location) where the Memberships will be created. Specified in the format `projects/x/locations/x`. + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Membership; + } + export interface Params$Resource$Projects$Locations$Memberships$Delete + extends StandardParameters { + /** + * Optional. If set to true, any subresource from this Membership will also be deleted. Otherwise, the request will only work if the Membership has no subresource. + */ + force?: boolean; + /** + * Required. The Membership resource name in the format `projects/x/locations/x/memberships/x`. + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Memberships$Generateconnectmanifest + extends StandardParameters { + /** + * Optional. The image pull secret content for the registry, if not public. + */ + imagePullSecretContent?: string; + /** + * Optional. If true, generate the resources for upgrade only. Some resources generated only for installation (e.g. secrets) will be excluded. + */ + isUpgrade?: boolean; + /** + * Required. The Membership resource name the Agent will associate with, in the format `projects/x/locations/x/memberships/x`. + */ + name?: string; + /** + * Optional. Namespace for GKE Connect agent resources. Defaults to `gke-connect`. The Connect Agent is authorized automatically when run in the default namespace. Otherwise, explicit authorization must be granted with an additional IAM binding. + */ + namespace?: string; + /** + * Optional. URI of a proxy if connectivity from the agent to gkeconnect.googleapis.com requires the use of a proxy. Format must be in the form `http(s)://{proxy_address\}`, depending on the HTTP/HTTPS protocol supported by the proxy. This will direct the connect agent's outbound traffic through a HTTP(S) proxy. + */ + proxy?: string; + /** + * Optional. The registry to fetch the connect agent image from. Defaults to gcr.io/gkeconnect. + */ + registry?: string; + /** + * Optional. The Connect agent version to use. Defaults to the most current version. + */ + version?: string; + } + export interface Params$Resource$Projects$Locations$Memberships$Get + extends StandardParameters { + /** + * Required. The Membership resource name in the format `projects/x/locations/x/memberships/x`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Memberships$Getiampolicy extends StandardParameters { /** @@ -4173,6 +5116,49 @@ export namespace gkehub_v1beta { */ resource?: string; } + export interface Params$Resource$Projects$Locations$Memberships$List + extends StandardParameters { + /** + * Optional. Lists Memberships that match the filter expression, following the syntax outlined in https://google.aip.dev/160. Examples: - Name is `bar` in project `foo-proj` and location `global`: name = "projects/foo-proj/locations/global/membership/bar" - Memberships that have a label called `foo`: labels.foo:* - Memberships that have a label called `foo` whose value is `bar`: labels.foo = bar - Memberships in the CREATING state: state = CREATING + */ + filter?: string; + /** + * Optional. One or more fields to compare and use to sort the output. See https://google.aip.dev/132#ordering. + */ + orderBy?: string; + /** + * Optional. When requesting a 'page' of resources, `page_size` specifies number of resources to return. If unspecified or set to 0, all resources will be returned. + */ + pageSize?: number; + /** + * Optional. Token returned by previous call to `ListMemberships` which specifies the position in the list from where to continue listing the resources. + */ + pageToken?: string; + /** + * Required. The parent (project and location) where the Memberships will be listed. Specified in the format `projects/x/locations/x`. `projects/x/locations/-` list memberships in all the regions. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Memberships$Patch + extends StandardParameters { + /** + * Required. The Membership resource name in the format `projects/x/locations/x/memberships/x`. + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Mask of fields to update. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Membership; + } export interface Params$Resource$Projects$Locations$Memberships$Setiampolicy extends StandardParameters { /** diff --git a/src/apis/gkeonprem/v1.ts b/src/apis/gkeonprem/v1.ts index 9b01c0841b..862e9fefbc 100644 --- a/src/apis/gkeonprem/v1.ts +++ b/src/apis/gkeonprem/v1.ts @@ -1738,10 +1738,6 @@ export namespace gkeonprem_v1 { * Current version of the dependency e.g. 1.15.0. */ currentVersion?: string | null; - /** - * Local name of the dependency. - */ - localName?: string | null; /** * Membership names are formatted as `projects//locations//memberships/`. */ diff --git a/src/apis/gmail/v1.ts b/src/apis/gmail/v1.ts index 061b49b72d..3fd848fd69 100644 --- a/src/apis/gmail/v1.ts +++ b/src/apis/gmail/v1.ts @@ -173,6 +173,10 @@ export namespace gmail_v1 { * If a key pair is associated, the ID of the key pair, CseKeyPair. */ primaryKeyPairId?: string | null; + /** + * The configuration of a CSE identity that uses different key pairs for signing and encryption. + */ + signAndEncryptKeyPairs?: Schema$SignAndEncryptKeyPairs; } /** * A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages. @@ -211,10 +215,6 @@ export namespace gmail_v1 { * Metadata for a private key instance. */ export interface Schema$CsePrivateKeyMetadata { - /** - * Metadata for hardware keys. - */ - hardwareKeyMetadata?: Schema$HardwareKeyMetadata; /** * Metadata for a private key instance managed by an external key access control list service. */ @@ -346,15 +346,6 @@ export namespace gmail_v1 { */ verificationStatus?: string | null; } - /** - * Metadata for hardware keys. - */ - export interface Schema$HardwareKeyMetadata { - /** - * Description about the hardware key. - */ - description?: string | null; - } /** * A record of a change to the user's mailbox. Each history change may affect multiple messages in multiple ways. */ @@ -822,6 +813,19 @@ export namespace gmail_v1 { */ verificationStatus?: string | null; } + /** + * The configuration of a CSE identity that uses different key pairs for signing and encryption. + */ + export interface Schema$SignAndEncryptKeyPairs { + /** + * The ID of the CseKeyPair that encrypts signed outgoing mail. + */ + encryptionKeyPairId?: string | null; + /** + * The ID of the CseKeyPair that signs outgoing mail. + */ + signingKeyPairId?: string | null; + } /** * An S/MIME email config. */ diff --git a/src/apis/healthcare/v1.ts b/src/apis/healthcare/v1.ts index 35874f9a3b..779d977478 100644 --- a/src/apis/healthcare/v1.ts +++ b/src/apis/healthcare/v1.ts @@ -522,7 +522,7 @@ export namespace healthcare_v1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within `TextConfig`, and must also be excluded within `ImageConfig` if image redaction is required. + * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. */ useRegionalDataProcessing?: boolean | null; } @@ -644,6 +644,35 @@ export namespace healthcare_v1 { */ streamConfigs?: Schema$GoogleCloudHealthcareV1DicomStreamConfig[]; } + /** + * DicomStoreMetrics contains metrics describing a DICOM store. + */ + export interface Schema$DicomStoreMetrics { + /** + * Total blob storage bytes for all instances in the store. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the store. + */ + instanceCount?: string | null; + /** + * Resource name of the DICOM store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. + */ + name?: string | null; + /** + * Number of series in the store. + */ + seriesCount?: string | null; + /** + * Total structured storage bytes for all instances in the store. + */ + structuredStorageSizeBytes?: string | null; + /** + * Number of studies in the store. + */ + studyCount?: string | null; + } /** * 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); \} */ @@ -1241,6 +1270,36 @@ export namespace healthcare_v1 { */ rejectDuplicateMessage?: boolean | null; } + /** + * Count of messages and total storage size by type for a given HL7 store. + */ + export interface Schema$Hl7V2StoreMetric { + /** + * The total count of HL7v2 messages in the store for the given message type. + */ + count?: string | null; + /** + * The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`. + */ + messageType?: string | null; + /** + * The total amount of structured storage used by HL7v2 messages of this message type in the store. + */ + structuredStorageSizeBytes?: string | null; + } + /** + * List of metrics for a given HL7v2 store. + */ + export interface Schema$Hl7V2StoreMetrics { + /** + * List of HL7v2 store metrics by message type. + */ + metrics?: Schema$Hl7V2StoreMetric[]; + /** + * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + */ + name?: string | null; + } /** * 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. */ @@ -1969,6 +2028,27 @@ export namespace healthcare_v1 { */ setId?: string | null; } + /** + * SeriesMetrics contains metrics describing a DICOM series. + */ + export interface Schema$SeriesMetrics { + /** + * Total blob storage bytes for all instances in the series. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the series. + */ + instanceCount?: string | null; + /** + * The series resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}`. + */ + series?: string | null; + /** + * Total structured storage bytes for all instances in the series. + */ + structuredStorageSizeBytes?: string | null; + } /** * Request message for `SetIamPolicy` method. */ @@ -2037,6 +2117,31 @@ export namespace healthcare_v1 { */ resourceTypes?: string[] | null; } + /** + * StudyMetrics contains metrics describing a DICOM study. + */ + export interface Schema$StudyMetrics { + /** + * Total blob storage bytes for all instances in the study. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the study. + */ + instanceCount?: string | null; + /** + * Number of series in the study. + */ + seriesCount?: string | null; + /** + * Total structured storage bytes for all instances in the study. + */ + structuredStorageSizeBytes?: string | null; + /** + * The study resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}`. + */ + study?: string | null; + } /** * List of tags to be filtered. */ @@ -7047,9 +7152,14 @@ export namespace healthcare_v1 { export class Resource$Projects$Locations$Datasets$Dicomstores { context: APIRequestContext; + dicomWeb: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb; studies: Resource$Projects$Locations$Datasets$Dicomstores$Studies; constructor(context: APIRequestContext) { this.context = context; + this.dicomWeb = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb( + this.context + ); this.studies = new Resource$Projects$Locations$Datasets$Dicomstores$Studies( this.context @@ -7487,6 +7597,99 @@ export namespace healthcare_v1 { } } + /** + * Gets metrics associated with the DICOM store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getDICOMStoreMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options?: MethodOptions + ): GaxiosPromise; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:getDICOMStoreMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @@ -8428,6 +8631,13 @@ export namespace healthcare_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics + extends StandardParameters { + /** + * The resource name of the DICOM store to get metrics for. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy extends StandardParameters { /** @@ -8560,6 +8770,231 @@ export namespace healthcare_v1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb { + context: APIRequestContext; + studies: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies; + constructor(context: APIRequestContext) { + this.context = context; + this.studies = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies { + context: APIRequestContext; + series: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series; + constructor(context: APIRequestContext) { + this.context = context; + this.series = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series( + this.context + ); + } + + /** + * GetStudyMetrics returns metrics for a study. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getStudyMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options?: MethodOptions + ): GaxiosPromise; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + callback: BodyResponseCallback + ): void; + getStudyMetrics(callback: BodyResponseCallback): void; + getStudyMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+study}:getStudyMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['study'], + pathParams: ['study'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics + extends StandardParameters { + /** + * The study resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}`. + */ + study?: string; + } + + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * GetSeriesMetrics returns metrics for a series. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getSeriesMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options?: MethodOptions + ): GaxiosPromise; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+series}:getSeriesMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['series'], + pathParams: ['series'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics + extends StandardParameters { + /** + * The series resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}`. + */ + series?: string; + } + export class Resource$Projects$Locations$Datasets$Dicomstores$Studies { context: APIRequestContext; series: Resource$Projects$Locations$Datasets$Dicomstores$Studies$Series; @@ -13474,6 +13909,99 @@ export namespace healthcare_v1 { } } + /** + * Gets metrics asssociated with the HL7v2 store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getHL7v2StoreMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options?: MethodOptions + ): GaxiosPromise; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:getHL7v2StoreMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @@ -14051,6 +14579,13 @@ export namespace healthcare_v1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics + extends StandardParameters { + /** + * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy extends StandardParameters { /** diff --git a/src/apis/healthcare/v1beta1.ts b/src/apis/healthcare/v1beta1.ts index c7f19a2833..543690c72e 100644 --- a/src/apis/healthcare/v1beta1.ts +++ b/src/apis/healthcare/v1beta1.ts @@ -545,7 +545,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$CleanTextField {} /** - * Inspect text and transform sensitive text. Configurable using `TextConfig`. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS + * Inspect text and transform sensitive text. Configurable using TextConfig. Supported [Value Representations] (http://dicom.nema.org/medical/dicom/2018e/output/chtml/part05/sect_6.2.html#table_6.2-1): AE, LO, LT, PN, SH, ST, UC, UT, DA, DT, AS */ export interface Schema$CleanTextTag {} /** @@ -835,7 +835,7 @@ export namespace healthcare_v1beta1 { */ text?: Schema$TextConfig; /** - * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated `DicomConfig` or `FhirConfig` are used, then `LOCATION` must be excluded within `TextConfig`, and must also be excluded within `ImageConfig` if image redaction is required. + * Ensures in-flight data remains in the region of origin during de-identification. Using this option results in a significant reduction of throughput, and is not compatible with `LOCATION` or `ORGANIZATION_NAME` infoTypes. If the deprecated DicomConfig or FhirConfig are used, then `LOCATION` must be excluded within TextConfig, and must also be excluded within ImageConfig if image redaction is required. */ useRegionalDataProcessing?: boolean | null; } @@ -976,6 +976,35 @@ export namespace healthcare_v1beta1 { */ streamConfigs?: Schema$GoogleCloudHealthcareV1beta1DicomStreamConfig[]; } + /** + * DicomStoreMetrics contains metrics describing a DICOM store. + */ + export interface Schema$DicomStoreMetrics { + /** + * Total blob storage bytes for all instances in the store. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the store. + */ + instanceCount?: string | null; + /** + * Resource name of the DICOM store, of the form `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}`. + */ + name?: string | null; + /** + * Number of series in the store. + */ + seriesCount?: string | null; + /** + * Total structured storage bytes for all instances in the store. + */ + structuredStorageSizeBytes?: string | null; + /** + * Number of studies in the store. + */ + studyCount?: string | null; + } /** * Specifies the parameters needed for the de-identification of DICOM stores. */ @@ -1324,7 +1353,7 @@ export namespace healthcare_v1beta1 { */ export interface Schema$FhirOutput { /** - * Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set `enable_update_create` to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations. + * Name of the output FHIR store, which must already exist. You must grant the healthcare.fhirResources.update permission on the destination store to your project's **Cloud Healthcare Service Agent** [service account](https://cloud.google.com/healthcare/docs/how-tos/permissions-healthcare-api-gcp-products#the_cloud_healthcare_service_agent). The destination store must set enableUpdateCreate to true. The destination store must use FHIR version R4. Writing these resources will consume FHIR operations quota from the project containing the source data. De-identify operation metadata is only generated for DICOM de-identification operations. */ fhirStore?: string | null; } @@ -1807,6 +1836,36 @@ export namespace healthcare_v1beta1 { */ rejectDuplicateMessage?: boolean | null; } + /** + * Count of messages and total storage size by type for a given HL7 store. + */ + export interface Schema$Hl7V2StoreMetric { + /** + * The total count of HL7v2 messages in the store for the given message type. + */ + count?: string | null; + /** + * The Hl7v2 message type this metric applies to, such as `ADT` or `ORU`. + */ + messageType?: string | null; + /** + * The total amount of structured storage used by HL7v2 messages of this message type in the store. + */ + structuredStorageSizeBytes?: string | null; + } + /** + * List of metrics for a given HL7v2 store. + */ + export interface Schema$Hl7V2StoreMetrics { + /** + * List of HL7v2 store metrics by message type. + */ + metrics?: Schema$Hl7V2StoreMetric[]; + /** + * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + */ + name?: string | null; + } /** * 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. */ @@ -2705,6 +2764,27 @@ export namespace healthcare_v1beta1 { */ details?: {[key: string]: Schema$Detail} | null; } + /** + * SeriesMetrics contains metrics describing a DICOM series. + */ + export interface Schema$SeriesMetrics { + /** + * Total blob storage bytes for all instances in the series. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the series. + */ + instanceCount?: string | null; + /** + * The series resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}`. + */ + series?: string | null; + /** + * Total structured storage bytes for all instances in the series. + */ + structuredStorageSizeBytes?: string | null; + } /** * Request message for `SetIamPolicy` method. */ @@ -2773,6 +2853,31 @@ export namespace healthcare_v1beta1 { */ resourceTypes?: string[] | null; } + /** + * StudyMetrics contains metrics describing a DICOM study. + */ + export interface Schema$StudyMetrics { + /** + * Total blob storage bytes for all instances in the study. + */ + blobStorageSizeBytes?: string | null; + /** + * Number of instances in the study. + */ + instanceCount?: string | null; + /** + * Number of series in the study. + */ + seriesCount?: string | null; + /** + * Total structured storage bytes for all instances in the study. + */ + structuredStorageSizeBytes?: string | null; + /** + * The study resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}`. + */ + study?: string | null; + } /** * List of tags to be filtered. */ @@ -9456,9 +9561,14 @@ export namespace healthcare_v1beta1 { export class Resource$Projects$Locations$Datasets$Dicomstores { context: APIRequestContext; + dicomWeb: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb; studies: Resource$Projects$Locations$Datasets$Dicomstores$Studies; constructor(context: APIRequestContext) { this.context = context; + this.dicomWeb = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb( + this.context + ); this.studies = new Resource$Projects$Locations$Datasets$Dicomstores$Studies( this.context @@ -9899,6 +10009,99 @@ export namespace healthcare_v1beta1 { } } + /** + * Gets metrics associated with the DICOM store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getDICOMStoreMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options?: MethodOptions + ): GaxiosPromise; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics, + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + callback: BodyResponseCallback + ): void; + getDICOMStoreMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:getDICOMStoreMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @@ -10839,6 +11042,13 @@ export namespace healthcare_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getdicomstoremetrics + extends StandardParameters { + /** + * The resource name of the DICOM store to get metrics for. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Getiampolicy extends StandardParameters { /** @@ -10971,6 +11181,231 @@ export namespace healthcare_v1beta1 { requestBody?: Schema$TestIamPermissionsRequest; } + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb { + context: APIRequestContext; + studies: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies; + constructor(context: APIRequestContext) { + this.context = context; + this.studies = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies( + this.context + ); + } + } + + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies { + context: APIRequestContext; + series: Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series; + constructor(context: APIRequestContext) { + this.context = context; + this.series = + new Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series( + this.context + ); + } + + /** + * GetStudyMetrics returns metrics for a study. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getStudyMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options?: MethodOptions + ): GaxiosPromise; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getStudyMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics, + callback: BodyResponseCallback + ): void; + getStudyMetrics(callback: BodyResponseCallback): void; + getStudyMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+study}:getStudyMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['study'], + pathParams: ['study'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Getstudymetrics + extends StandardParameters { + /** + * The study resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}`. + */ + study?: string; + } + + export class Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * GetSeriesMetrics returns metrics for a series. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getSeriesMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options?: MethodOptions + ): GaxiosPromise; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + params: Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics, + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + callback: BodyResponseCallback + ): void; + getSeriesMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+series}:getSeriesMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['series'], + pathParams: ['series'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Datasets$Dicomstores$Dicomweb$Studies$Series$Getseriesmetrics + extends StandardParameters { + /** + * The series resource path. For example, `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/dicomStores/{dicom_store_id\}/dicomWeb/studies/{study_uid\}/series/{series_uid\}`. + */ + series?: string; + } + export class Resource$Projects$Locations$Datasets$Dicomstores$Studies { context: APIRequestContext; series: Resource$Projects$Locations$Datasets$Dicomstores$Studies$Series; @@ -16821,6 +17256,99 @@ export namespace healthcare_v1beta1 { } } + /** + * Gets metrics asssociated with the HL7v2 store. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: StreamMethodOptions + ): GaxiosPromise; + getHL7v2StoreMetrics( + params?: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options?: MethodOptions + ): GaxiosPromise; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + params: Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics, + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + callback: BodyResponseCallback + ): void; + getHL7v2StoreMetrics( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://healthcare.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}:getHL7v2StoreMetrics').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. * @@ -17401,6 +17929,13 @@ export namespace healthcare_v1beta1 { */ name?: string; } + export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Gethl7v2storemetrics + extends StandardParameters { + /** + * The resource name of the HL7v2 store to get metrics for, in the format `projects/{project_id\}/locations/{location_id\}/datasets/{dataset_id\}/hl7V2Stores/{hl7v2_store_id\}`. + */ + name?: string; + } export interface Params$Resource$Projects$Locations$Datasets$Hl7v2stores$Getiampolicy extends StandardParameters { /** diff --git a/src/apis/iap/v1.ts b/src/apis/iap/v1.ts index 961fce71a1..95b8b89cbc 100644 --- a/src/apis/iap/v1.ts +++ b/src/apis/iap/v1.ts @@ -494,6 +494,10 @@ export namespace iap_v1 { */ export interface Schema$ResetIdentityAwareProxyClientSecretRequest {} export interface Schema$Resource { + /** + * The proto or JSON formatted expected next state of the resource, wrapped in a google.protobuf.Any proto, against which the policy rules are evaluated. Services not integrated with custom org policy can omit this field. Services integrated with custom org policy must populate this field for all requests where the API call changes the state of the resource. Custom org policy backend uses these attributes to enforce custom org policies. When a proto is wrapped, it is generally the One Platform API proto. When a JSON string is wrapped, use `google.protobuf.StringValue` for the inner value. It is sufficient to pass just the max set of attributes that are allowed for use in custom constraints; other attributes can be omitted. See go/custom-constraints-org-policy-integration-guide for additional details. + */ + expectedNextState?: {[key: string]: any} | null; /** * The service defined labels of the resource on which the conditions will be evaluated. The semantics - including the key names - are vague to IAM. If the effective condition has a reference to a `resource.labels[foo]` construct, IAM consults with this map to retrieve the values associated with `foo` key for Conditions evaluation. If the provided key is not found in the labels map, the condition would evaluate to false. This field is in limited use. If your intended use case is not expected to express resource.labels attribute in IAM Conditions, leave this field empty. Before planning on using this attribute please: * Read go/iam-conditions-labels-comm and ensure your service can meet the data availability and management requirements. * Talk to iam-conditions-eng@ about your use case. */ diff --git a/src/apis/index.ts b/src/apis/index.ts index e29113b67d..7d262e5bed 100644 --- a/src/apis/index.ts +++ b/src/apis/index.ts @@ -106,6 +106,7 @@ import { VERSIONS as authorizedbuyersmarketplaceVersions, authorizedbuyersmarketplace, } from './authorizedbuyersmarketplace'; +import {VERSIONS as backupdrVersions, backupdr} from './backupdr'; import { VERSIONS as baremetalsolutionVersions, baremetalsolution, @@ -634,6 +635,7 @@ import { } from './videointelligence'; import {VERSIONS as visionVersions, vision} from './vision'; import {VERSIONS as vmmigrationVersions, vmmigration} from './vmmigration'; +import {VERSIONS as vmwareengineVersions, vmwareengine} from './vmwareengine'; import {VERSIONS as vpcaccessVersions, vpcaccess} from './vpcaccess'; import {VERSIONS as webfontsVersions, webfonts} from './webfonts'; import {VERSIONS as webmastersVersions, webmasters} from './webmasters'; @@ -702,6 +704,7 @@ export const APIS: APIList = { artifactregistry: artifactregistryVersions, assuredworkloads: assuredworkloadsVersions, authorizedbuyersmarketplace: authorizedbuyersmarketplaceVersions, + backupdr: backupdrVersions, baremetalsolution: baremetalsolutionVersions, batch: batchVersions, beyondcorp: beyondcorpVersions, @@ -933,6 +936,7 @@ export const APIS: APIList = { videointelligence: videointelligenceVersions, vision: visionVersions, vmmigration: vmmigrationVersions, + vmwareengine: vmwareengineVersions, vpcaccess: vpcaccessVersions, webfonts: webfontsVersions, webmasters: webmastersVersions, @@ -982,6 +986,7 @@ export class GeneratedAPIs { artifactregistry = artifactregistry; assuredworkloads = assuredworkloads; authorizedbuyersmarketplace = authorizedbuyersmarketplace; + backupdr = backupdr; baremetalsolution = baremetalsolution; batch = batch; beyondcorp = beyondcorp; @@ -1213,6 +1218,7 @@ export class GeneratedAPIs { videointelligence = videointelligence; vision = vision; vmmigration = vmmigration; + vmwareengine = vmwareengine; vpcaccess = vpcaccess; webfonts = webfonts; webmasters = webmasters; diff --git a/src/apis/indexing/README.md b/src/apis/indexing/README.md index 631fdf189e..0caff0cbbd 100644 --- a/src/apis/indexing/README.md +++ b/src/apis/indexing/README.md @@ -2,7 +2,7 @@ # indexing -> Notifies Google when your web pages change. +> Notifies Google Web Search when your web pages change. ## Installation diff --git a/src/apis/indexing/v3.ts b/src/apis/indexing/v3.ts index 5bd085ac2f..95b5a1ab6c 100644 --- a/src/apis/indexing/v3.ts +++ b/src/apis/indexing/v3.ts @@ -100,9 +100,9 @@ export namespace indexing_v3 { } /** - * Indexing API + * Web Search Indexing API * - * Notifies Google when your web pages change. + * Notifies Google Web Search when your web pages change. * * @example * ```js diff --git a/src/apis/metastore/v1.ts b/src/apis/metastore/v1.ts index 15999e3860..1344f9497f 100644 --- a/src/apis/metastore/v1.ts +++ b/src/apis/metastore/v1.ts @@ -572,6 +572,10 @@ export namespace metastore_v1 { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * The multi-region metadata if the current region is a multi-region. + */ + multiRegionMetadata?: Schema$MultiRegionMetadata; /** * The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default. */ @@ -682,6 +686,15 @@ export namespace metastore_v1 { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty. + */ + export interface Schema$MultiRegionMetadata { + /** + * The regions constituting the multi-region. + */ + constituentRegions?: string[] | null; + } /** * Network configuration for the Dataproc Metastore service.Next available ID: 4 */ diff --git a/src/apis/metastore/v1alpha.ts b/src/apis/metastore/v1alpha.ts index ee4db6c2ca..7dc7e8c566 100644 --- a/src/apis/metastore/v1alpha.ts +++ b/src/apis/metastore/v1alpha.ts @@ -599,6 +599,10 @@ export namespace metastore_v1alpha { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * The multi-region metadata if the current region is a multi-region. + */ + multiRegionMetadata?: Schema$MultiRegionMetadata; /** * The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default. */ @@ -722,6 +726,15 @@ export namespace metastore_v1alpha { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty. + */ + export interface Schema$MultiRegionMetadata { + /** + * The regions constituting the multi-region. + */ + constituentRegions?: string[] | null; + } /** * Network configuration for the Dataproc Metastore service.Next available ID: 4 */ diff --git a/src/apis/metastore/v1beta.ts b/src/apis/metastore/v1beta.ts index 4e4803d223..f36c2cdb83 100644 --- a/src/apis/metastore/v1beta.ts +++ b/src/apis/metastore/v1beta.ts @@ -599,6 +599,10 @@ export namespace metastore_v1beta { * Metadata about the service in a location. */ export interface Schema$LocationMetadata { + /** + * The multi-region metadata if the current region is a multi-region. + */ + multiRegionMetadata?: Schema$MultiRegionMetadata; /** * The versions of Hive Metastore that can be used when creating a new metastore service in this location. The server guarantees that exactly one HiveMetastoreVersion in the list will set is_default. */ @@ -722,6 +726,15 @@ export namespace metastore_v1beta { * Response message for DataprocMetastore.MoveTableToDatabase. */ export interface Schema$MoveTableToDatabaseResponse {} + /** + * The metadata for the multi-region that includes the constituent regions. The metadata is only populated if the region is multi-region. For single region, it will be empty. + */ + export interface Schema$MultiRegionMetadata { + /** + * The regions constituting the multi-region. + */ + constituentRegions?: string[] | null; + } /** * Network configuration for the Dataproc Metastore service.Next available ID: 4 */ diff --git a/src/apis/migrationcenter/v1.ts b/src/apis/migrationcenter/v1.ts index d2ce884d6a..8341da325d 100644 --- a/src/apis/migrationcenter/v1.ts +++ b/src/apis/migrationcenter/v1.ts @@ -855,11 +855,11 @@ export namespace migrationcenter_v1 { entries?: Schema$FstabEntry[]; } /** - * An insight about an asset (experimental insight) + * A generic insight about an asset. */ export interface Schema$GenericInsight { /** - * Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links + * Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links. */ additionalInformation?: string[] | null; /** @@ -1111,7 +1111,7 @@ export namespace migrationcenter_v1 { */ createTime?: string | null; /** - * User-friendly display name. Maximum length is 63 characters. + * Optional. User-friendly display name. Maximum length is 256 characters. */ displayName?: string | null; /** @@ -1818,7 +1818,7 @@ export namespace migrationcenter_v1 { */ network?: Schema$NetworkUsageSample; /** - * Time the sample was If omitted, the frame report time will be used. + * Time the sample was collected. If omitted, the frame report time will be used. */ sampleTime?: string | null; } diff --git a/src/apis/migrationcenter/v1alpha1.ts b/src/apis/migrationcenter/v1alpha1.ts index 98c0ba5566..51b84c6e2e 100644 --- a/src/apis/migrationcenter/v1alpha1.ts +++ b/src/apis/migrationcenter/v1alpha1.ts @@ -917,11 +917,11 @@ export namespace migrationcenter_v1alpha1 { path?: string | null; } /** - * An insight about an asset (experimental insight) + * A generic insight about an asset. */ export interface Schema$GenericInsight { /** - * Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links + * Output only. Additional information about the insight, each entry can be a logical entry and must make sense if it is displayed with line breaks between each entry. Text can contain md style links. */ additionalInformation?: string[] | null; /** @@ -1115,7 +1115,7 @@ export namespace migrationcenter_v1alpha1 { */ createTime?: string | null; /** - * User-friendly display name. Maximum length is 63 characters. + * Optional. User-friendly display name. Maximum length is 256 characters. */ displayName?: string | null; /** @@ -2756,7 +2756,7 @@ export namespace migrationcenter_v1alpha1 { publicIpAddress?: string | null; } /** - * VirtualMachinePreferences enables you to create sets of assumptions, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. + * VirtualMachinePreferences enables you to create sets of preferences, for example, a geographical location and pricing track, for your migrated virtual machines. The set of preferences influence recommendations for migrating virtual machine assets. */ export interface Schema$VirtualMachinePreferences { /** @@ -2767,10 +2767,18 @@ export namespace migrationcenter_v1alpha1 { * Compute Engine preferences concern insights and recommendations for Compute Engine target. */ computeEnginePreferences?: Schema$ComputeEnginePreferences; + /** + * Optional. Parameters that affect network cost estimations. If not set, default values will be used for the parameters. + */ + networkCostParameters?: Schema$VirtualMachinePreferencesNetworkCostParameters; /** * Region preferences for assets using this preference set. If you are unsure which value to set, the migration service API region is often a good value to start with. */ regionPreferences?: Schema$RegionPreferences; + /** + * Optional. Custom data to use for sizing optimizations. Relevant when SizingOptimizationStrategy is set to "custom". + */ + sizingOptimizationCustomParameters?: Schema$VirtualMachinePreferencesSizingOptimizationCustomParameters; /** * Sizing optimization strategy specifies the preferred strategy used when extrapolating usage data to calculate insights and recommendations for a virtual machine. If you are unsure which value to set, a moderate sizing optimization strategy is often a good value to start with. */ @@ -2788,6 +2796,36 @@ export namespace migrationcenter_v1alpha1 { */ vmwareEnginePreferences?: Schema$VmwareEnginePreferences; } + /** + * Parameters that affect network cost estimations. + */ + export interface Schema$VirtualMachinePreferencesNetworkCostParameters { + /** + * Optional. An estimated percentage of priced outbound traffic (egress traffic) from the measured outbound traffic. Must be in the interval [0, 100]. + */ + estimatedEgressTrafficPercentage?: number | null; + } + /** + * Custom data to use for sizing optimizations. + */ + export interface Schema$VirtualMachinePreferencesSizingOptimizationCustomParameters { + /** + * Optional. Type of statistical aggregation of a resource utilization data, on which to base the sizing metrics. + */ + aggregationMethod?: string | null; + /** + * Optional. Desired percentage of CPU usage. Must be in the interval [1, 100] (or 0 for default value). + */ + cpuUsagePercentage?: number | null; + /** + * Optional. Desired percentage of memory usage. Must be in the interval [1, 100] (or 0 for default value). + */ + memoryUsagePercentage?: number | null; + /** + * Optional. Desired increase factor of storage, relative to currently used storage. Must be in the interval [1.0, 2.0] (or 0 for default value). + */ + storageMultiplier?: number | null; + } /** * VMware disk config details. */ diff --git a/src/apis/networkconnectivity/v1.ts b/src/apis/networkconnectivity/v1.ts index 634dbc56d1..dbc59fa7f9 100644 --- a/src/apis/networkconnectivity/v1.ts +++ b/src/apis/networkconnectivity/v1.ts @@ -129,7 +129,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$AcceptHubSpokeRequest { /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -151,7 +151,7 @@ export namespace networkconnectivity_v1 { */ export interface Schema$AcceptSpokeRequest { /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; } @@ -298,19 +298,19 @@ export namespace networkconnectivity_v1 { */ export interface Schema$Filter { /** - * Optional. The destination IP range of outgoing packets that this policy based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + * Optional. The destination IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. */ destRange?: string | null; /** - * Optional. The IP protocol that this policy based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'. + * Optional. The IP protocol that this policy-based route applies to. Valid values are 'TCP', 'UDP', and 'ALL'. Default is 'ALL'. */ ipProtocol?: string | null; /** - * Required. Internet protocol versions this policy based route applies to. For this version, only IPV4 is supported. + * Required. Internet protocol versions this policy-based route applies to. For this version, only IPV4 is supported. */ protocolVersion?: string | null; /** - * Optional. The source IP range of outgoing packets that this policy based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. + * Optional. The source IP range of outgoing packets that this policy-based route applies to. Default is "0.0.0.0/0" if protocol version is IPv4. */ srcRange?: string | null; } @@ -469,11 +469,11 @@ export namespace networkconnectivity_v1 { updateTime?: string | null; } /** - * InterconnectAttachment to which this route applies to. + * InterconnectAttachment that this route applies to. */ export interface Schema$InterconnectAttachment { /** - * Optional. Cloud region to install this policy based route on interconnect attachment. Use `all` to install it on all interconnect attachments. + * Optional. Cloud region to install this policy-based route on interconnect attachment. Use `all` to install it on all interconnect attachments. */ region?: string | null; } @@ -688,7 +688,7 @@ export namespace networkconnectivity_v1 { */ nextPageToken?: string | null; /** - * Policy based routes to be returned. + * Policy-based routes to be returned. */ policyBasedRoutes?: Schema$PolicyBasedRoute[]; /** @@ -910,11 +910,11 @@ export namespace networkconnectivity_v1 { version?: number | null; } /** - * Policy Based Routes (PBR) are more powerful routes that allows GCP customers to route their L4 network traffic based on not just destination IP, but also source IP, protocol and more. A PBR always take precedence when it conflicts with other types of routes. Next id: 22 + * Policy-based routes route L4 network traffic based on not just destination IP address, but also source IP address, protocol, and more. If a policy-based route conflicts with other types of routes, the policy-based route always take precedence. */ export interface Schema$PolicyBasedRoute { /** - * Output only. Time when the PolicyBasedRoute was created. + * Output only. Time when the policy-based route was created. */ createTime?: string | null; /** @@ -926,11 +926,11 @@ export namespace networkconnectivity_v1 { */ filter?: Schema$Filter; /** - * Optional. The interconnect attachments to which this route applies to. + * Optional. The interconnect attachments that this policy-based route applies to. */ interconnectAttachment?: Schema$InterconnectAttachment; /** - * Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for Policy Based Route resources. + * Output only. Type of this resource. Always networkconnectivity#policyBasedRoute for policy-based Route resources. */ kind?: string | null; /** @@ -942,11 +942,11 @@ export namespace networkconnectivity_v1 { */ name?: string | null; /** - * Required. Fully-qualified URL of the network that this route applies to. e.g. projects/my-project/global/networks/my-network. + * Required. Fully-qualified URL of the network that this route applies to, for example: projects/my-project/global/networks/my-network. */ network?: string | null; /** - * Optional. The IP of a global access enabled L4 ILB that should be the next hop to handle matching packets. For this version, only next_hop_ilb_ip is supported. + * Optional. The IP address of a global-access-enabled L4 ILB that is the next hop for matching packets. For this version, only nextHopIlbIp is supported. */ nextHopIlbIp?: string | null; /** @@ -954,7 +954,7 @@ export namespace networkconnectivity_v1 { */ nextHopOtherRoutes?: string | null; /** - * Optional. The priority of this policy based route. Priority is used to break ties in cases where there are more than one matching policy based routes found. In cases where multiple policy based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive. + * Optional. The priority of this policy-based route. Priority is used to break ties in cases where there are more than one matching policy-based routes found. In cases where multiple policy-based routes are matched, the one with the lowest-numbered priority value wins. The default value is 1000. The priority value must be from 1 to 65535, inclusive. */ priority?: number | null; /** @@ -962,11 +962,11 @@ export namespace networkconnectivity_v1 { */ selfLink?: string | null; /** - * Output only. Time when the PolicyBasedRoute was updated. + * Output only. Time when the policy-based route was updated. */ updateTime?: string | null; /** - * Optional. VM instances to which this policy based route applies to. + * Optional. VM instances to which this policy-based route applies to. */ virtualMachine?: Schema$VirtualMachine; /** @@ -1046,7 +1046,7 @@ export namespace networkconnectivity_v1 { */ details?: string | null; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; /** @@ -1072,7 +1072,7 @@ export namespace networkconnectivity_v1 { */ details?: string | null; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string | null; } @@ -1535,11 +1535,11 @@ export namespace networkconnectivity_v1 { permissions?: string[] | null; } /** - * VM instances to which this policy based route applies to. + * VM instances to which this policy-based route applies to. */ export interface Schema$VirtualMachine { /** - * Optional. A list of VM instance tags to which this policy based route applies to. VM instances that have ANY of tags specified here will install this PBR. + * Optional. A list of VM instance tags the this policy-based route applies to. VM instances that have ANY of tags specified here will install this PBR. */ tags?: string[] | null; } @@ -1833,7 +1833,7 @@ export namespace networkconnectivity_v1 { } /** - * Accepts a proposal to attach a Network Connectivity Center spoke to the hub. + * Accepts a proposal to attach a Network Connectivity Center spoke to a hub. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2560,7 +2560,7 @@ export namespace networkconnectivity_v1 { } /** - * Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub. + * Rejects a Network Connectivity Center spoke from being attached to a hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -2844,7 +2844,7 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Global$Hubs$Acceptspoke extends StandardParameters { /** - * Required. The name of the hub. + * Required. The name of the hub into which to accept the spoke. */ name?: string; @@ -2864,7 +2864,7 @@ export namespace networkconnectivity_v1 { */ parent?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; @@ -2880,7 +2880,7 @@ export namespace networkconnectivity_v1 { */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -2963,7 +2963,7 @@ export namespace networkconnectivity_v1 { */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -2979,7 +2979,7 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Global$Hubs$Rejectspoke extends StandardParameters { /** - * Required. The name of the hub. + * Required. The name of the hub from which to reject the spoke. */ name?: string; @@ -3984,7 +3984,7 @@ export namespace networkconnectivity_v1 { } /** - * Creates a new PolicyBasedRoute in a given project and location. + * Creates a new policy-based route in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4080,7 +4080,7 @@ export namespace networkconnectivity_v1 { } /** - * Deletes a single PolicyBasedRoute. + * Deletes a single policy-based route. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4173,7 +4173,7 @@ export namespace networkconnectivity_v1 { } /** - * Gets details of a single PolicyBasedRoute. + * Gets details of a single policy-based route. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4348,7 +4348,7 @@ export namespace networkconnectivity_v1 { } /** - * Lists PolicyBasedRoutes in a given project and location. + * Lists policy-based routes in a given project and location. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. @@ -4638,7 +4638,7 @@ export namespace networkconnectivity_v1 { */ parent?: string; /** - * Required. Unique id for the Policy Based Route to create. + * Required. Unique id for the policy-based route to create. */ policyBasedRouteId?: string; /** @@ -4654,7 +4654,7 @@ export namespace networkconnectivity_v1 { export interface Params$Resource$Projects$Locations$Global$Policybasedroutes$Delete extends StandardParameters { /** - * Required. Name of the PolicyBasedRoute resource to delete. + * Required. Name of the policy-based route resource to delete. */ name?: string; /** @@ -9568,7 +9568,7 @@ export namespace networkconnectivity_v1 { */ parent?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** @@ -9588,7 +9588,7 @@ export namespace networkconnectivity_v1 { */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; } @@ -9640,7 +9640,7 @@ export namespace networkconnectivity_v1 { */ name?: string; /** - * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). */ requestId?: string; /** diff --git a/src/apis/networksecurity/v1beta1.ts b/src/apis/networksecurity/v1beta1.ts index 703829ac19..b0db793f55 100644 --- a/src/apis/networksecurity/v1beta1.ts +++ b/src/apis/networksecurity/v1beta1.ts @@ -338,6 +338,10 @@ export namespace networksecurity_v1beta1 { * Output only. Create time stamp */ createTime?: string | null; + /** + * Optional. Description of the firewall endpoint. Max length 2048 characters. + */ + description?: string | null; /** * Optional. Labels as key value pairs */ @@ -979,7 +983,7 @@ export namespace networksecurity_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Immutable. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. + * Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. */ name?: string | null; /** @@ -1016,7 +1020,7 @@ export namespace networksecurity_v1beta1 { */ labels?: {[key: string]: string} | null; /** - * Immutable. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + * Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. */ name?: string | null; /** @@ -3646,7 +3650,7 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Organizations$Locations$Securityprofilegroups$Patch extends StandardParameters { /** - * Immutable. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. + * Immutable. Identifier. Name of the SecurityProfileGroup resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfileGroups/{security_profile_group\}`. */ name?: string; /** @@ -4164,7 +4168,7 @@ export namespace networksecurity_v1beta1 { export interface Params$Resource$Organizations$Locations$Securityprofiles$Patch extends StandardParameters { /** - * Immutable. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. + * Immutable. Identifier. Name of the SecurityProfile resource. It matches pattern `projects|organizations/x/locations/{location\}/securityProfiles/{security_profile\}`. */ name?: string; /** diff --git a/src/apis/networkservices/v1.ts b/src/apis/networkservices/v1.ts index 5b0f0ca80f..c418f19994 100644 --- a/src/apis/networkservices/v1.ts +++ b/src/apis/networkservices/v1.ts @@ -509,6 +509,10 @@ export namespace networkservices_v1 { * Optional. Specifies the retry policy associated with this route. */ retryPolicy?: Schema$GrpcRouteRetryPolicy; + /** + * Optional. Specifies cookie-based stateful session affinity. + */ + statefulSessionAffinity?: Schema$GrpcRouteStatefulSessionAffinityPolicy; /** * Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. */ @@ -540,6 +544,15 @@ export namespace networkservices_v1 { */ matches?: Schema$GrpcRouteRouteMatch[]; } + /** + * The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. + */ + export interface Schema$GrpcRouteStatefulSessionAffinityPolicy { + /** + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + */ + cookieTtl?: string | null; + } /** * HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. */ @@ -857,6 +870,10 @@ export namespace networkservices_v1 { * Specifies the retry policy associated with this route. */ retryPolicy?: Schema$HttpRouteRetryPolicy; + /** + * Optional. Specifies cookie-based stateful session affinity. + */ + statefulSessionAffinity?: Schema$HttpRouteStatefulSessionAffinityPolicy; /** * Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. */ @@ -908,6 +925,15 @@ export namespace networkservices_v1 { */ matches?: Schema$HttpRouteRouteMatch[]; } + /** + * The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. + */ + export interface Schema$HttpRouteStatefulSessionAffinityPolicy { + /** + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + */ + cookieTtl?: string | null; + } /** * The specification for modifying the URL of the request, prior to forwarding the request to the destination. */ diff --git a/src/apis/networkservices/v1beta1.ts b/src/apis/networkservices/v1beta1.ts index de2cb8ec76..e0b94cdc50 100644 --- a/src/apis/networkservices/v1beta1.ts +++ b/src/apis/networkservices/v1beta1.ts @@ -254,6 +254,65 @@ export namespace networkservices_v1beta1 { */ title?: string | null; } + /** + * A single extension chain wrapper that contains the match conditions and extensions to execute. + */ + export interface Schema$ExtensionChain { + /** + * Required. A set of extensions to execute for the matching request. At least one extension is required. Up to 3 extensions can be defined for each extension chain for `LbTrafficExtension` resource. `LbRouteExtension` chains are limited to 1 extension per extension chain. + */ + extensions?: Schema$ExtensionChainExtension[]; + /** + * Required. Conditions under which this chain is invoked for a request. + */ + matchCondition?: Schema$ExtensionChainMatchCondition; + /** + * Required. The name for this extension chain. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + */ + name?: string | null; + } + /** + * A single extension in the chain to execute for the matching request. + */ + export interface Schema$ExtensionChainExtension { + /** + * Required. The `:authority` header in the gRPC request sent from Envoy to the extension service. + */ + authority?: string | null; + /** + * Optional. Determines how the proxy behaves if the call to the extension fails or times out. When set to `TRUE`, request or response processing continues without error. Any subsequent extensions in the extension chain are also executed. When set to `FALSE`: * If response headers have not been delivered to the downstream client, a generic 500 error is returned to the client. The error response can be tailored by configuring a custom error response in the load balancer. * If response headers have been delivered, then the HTTP stream to the downstream client is reset. Default is `FALSE`. + */ + failOpen?: boolean | null; + /** + * Optional. List of the HTTP headers to forward to the extension (from the client or backend). If omitted, all headers are sent. Each element is a string indicating the header name. + */ + forwardHeaders?: string[] | null; + /** + * Required. The name for this extension. The name is logged as part of the HTTP request logs. The name must conform with RFC-1034, is restricted to lower-cased letters, numbers and hyphens, and can have a maximum length of 63 characters. Additionally, the first character must be a letter and the last a letter or a number. + */ + name?: string | null; + /** + * Required. The reference to the service that runs the extension. Must be a reference to a [backend service](https://cloud.google.com/compute/docs/reference/rest/v1/backendServices). + */ + service?: string | null; + /** + * Optional. A set of events during request or response processing for which this extension is called. This field is required for the `LbTrafficExtension` resource. It's not relevant for the `LbRouteExtension` resource. + */ + supportedEvents?: string[] | null; + /** + * Required. Specifies the timeout for each individual message on the stream. The timeout must be between 10-1000 milliseconds. + */ + timeout?: string | null; + } + /** + * Conditions under which this chain is invoked for a request. + */ + export interface Schema$ExtensionChainMatchCondition { + /** + * Required. A Common Expression Language (CEL) expression that is used to match requests for which the extension chain is executed. + */ + celExpression?: string | null; + } /** * Gateway represents the configuration for a proxy, typically a load balancer. It captures the ip:port over which the services are exposed by the proxy, along with any policy configurations. Routes have reference to to Gateways to dictate how requests should be routed by this Gateway. */ @@ -483,6 +542,10 @@ export namespace networkservices_v1beta1 { * Optional. Specifies the retry policy associated with this route. */ retryPolicy?: Schema$GrpcRouteRetryPolicy; + /** + * Optional. Specifies cookie-based stateful session affinity. + */ + statefulSessionAffinity?: Schema$GrpcRouteStatefulSessionAffinityPolicy; /** * Optional. Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. */ @@ -514,6 +577,15 @@ export namespace networkservices_v1beta1 { */ matches?: Schema$GrpcRouteRouteMatch[]; } + /** + * The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. + */ + export interface Schema$GrpcRouteStatefulSessionAffinityPolicy { + /** + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + */ + cookieTtl?: string | null; + } /** * HttpRoute is the resource defining how HTTP traffic should be routed by a Mesh or Gateway resource. */ @@ -831,6 +903,10 @@ export namespace networkservices_v1beta1 { * Specifies the retry policy associated with this route. */ retryPolicy?: Schema$HttpRouteRetryPolicy; + /** + * Optional. Specifies cookie-based stateful session affinity. + */ + statefulSessionAffinity?: Schema$HttpRouteStatefulSessionAffinityPolicy; /** * Specifies the timeout for selected route. Timeout is computed from the time the request has been fully processed (i.e. end of stream) up until the response has been completely processed. Timeout includes all retries. */ @@ -882,6 +958,15 @@ export namespace networkservices_v1beta1 { */ matches?: Schema$HttpRouteRouteMatch[]; } + /** + * The specification for cookie-based stateful session affinity where the date plane supplies a “session cookie” with the name "GSSA" which encodes a specific destination host and each request containing that cookie will be directed to that host as long as the destination host remains up and healthy. The gRPC proxyless mesh library or sidecar proxy will manage the session cookie but the client application code is responsible for copying the cookie from each RPC in the session to the next. + */ + export interface Schema$HttpRouteStatefulSessionAffinityPolicy { + /** + * Required. The cookie TTL value for the Set-Cookie header generated by the data plane. The lifetime of the cookie may be set to a value from 1 to 86400 seconds (24 hours) inclusive. + */ + cookieTtl?: string | null; + } /** * The specification for modifying the URL of the request, prior to forwarding the request to the destination. */ @@ -895,6 +980,80 @@ export namespace networkservices_v1beta1 { */ pathPrefixRewrite?: string | null; } + /** + * `LbRouteExtension` is a resource that lets you control where traffic is routed to for a given request. + */ + export interface Schema$LbRouteExtension { + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. + */ + extensionChains?: Schema$ExtensionChain[]; + /** + * Required. A list of references to the forwarding rules to which this service extension is attach to. At least one forwarding rule is required. There can be only one `LbRouteExtension` resource per forwarding rule. + */ + forwardingRules?: string[] | null; + /** + * Optional. Set of labels associated with the `LbRouteExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + */ + labels?: {[key: string]: string} | null; + /** + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. + */ + loadBalancingScheme?: string | null; + /** + * Required. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } + /** + * `LbTrafficExtension` is a resource that lets the extension service modify the headers and payloads of both requests and responses without impacting the choice of backend services or any other security policies associated with the backend service. + */ + export interface Schema$LbTrafficExtension { + /** + * Output only. The timestamp when the resource was created. + */ + createTime?: string | null; + /** + * Optional. A human-readable description of the resource. + */ + description?: string | null; + /** + * Required. A set of ordered extension chains that contain the match conditions and extensions to execute. Match conditions for each extension chain are evaluated in sequence for a given request. The first extension chain that has a condition that matches the request is executed. Any subsequent extension chains do not execute. Limited to 5 extension chains per resource. + */ + extensionChains?: Schema$ExtensionChain[]; + /** + * Required. A list of references to the forwarding rules to which this service extension is attach to. At least one forwarding rule is required. There can be only one `LBTrafficExtension` resource per forwarding rule. + */ + forwardingRules?: string[] | null; + /** + * Optional. Set of labels associated with the `LbTrafficExtension` resource. The format must comply with [the following requirements](/compute/docs/labeling-resources#requirements). + */ + labels?: {[key: string]: string} | null; + /** + * Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Choosing a load balancer](https://cloud.google.com/load-balancing/docs/backend-service). + */ + loadBalancingScheme?: string | null; + /** + * Required. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. + */ + name?: string | null; + /** + * Output only. The timestamp when the resource was updated. + */ + updateTime?: string | null; + } /** * Response returned by the ListEndpointPolicies method. */ @@ -951,6 +1110,40 @@ export namespace networkservices_v1beta1 { */ nextPageToken?: string | null; } + /** + * Message for response to listing `LbRouteExtension` resources. + */ + export interface Schema$ListLbRouteExtensionsResponse { + /** + * The list of `LbRouteExtension` resources. + */ + lbRouteExtensions?: Schema$LbRouteExtension[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } + /** + * Message for response to listing `LbTrafficExtension` resources. + */ + export interface Schema$ListLbTrafficExtensionsResponse { + /** + * The list of `LbTrafficExtension` resources. + */ + lbTrafficExtensions?: Schema$LbTrafficExtension[]; + /** + * A token identifying a page of results that the server returns. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * The response message for Locations.ListLocations. */ @@ -1548,6 +1741,8 @@ export namespace networkservices_v1beta1 { gateways: Resource$Projects$Locations$Gateways; grpcRoutes: Resource$Projects$Locations$Grpcroutes; httpRoutes: Resource$Projects$Locations$Httproutes; + lbRouteExtensions: Resource$Projects$Locations$Lbrouteextensions; + lbTrafficExtensions: Resource$Projects$Locations$Lbtrafficextensions; meshes: Resource$Projects$Locations$Meshes; operations: Resource$Projects$Locations$Operations; serviceBindings: Resource$Projects$Locations$Servicebindings; @@ -1566,6 +1761,10 @@ export namespace networkservices_v1beta1 { this.httpRoutes = new Resource$Projects$Locations$Httproutes( this.context ); + this.lbRouteExtensions = + new Resource$Projects$Locations$Lbrouteextensions(this.context); + this.lbTrafficExtensions = + new Resource$Projects$Locations$Lbtrafficextensions(this.context); this.meshes = new Resource$Projects$Locations$Meshes(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context @@ -4428,6 +4627,1076 @@ export namespace networkservices_v1beta1 { requestBody?: Schema$HttpRoute; } + export class Resource$Projects$Locations$Lbrouteextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbRouteExtension` resource in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified `LbRouteExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of the specified `LbRouteExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Lbrouteextensions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `LbRouteExtension` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbrouteextensions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbRouteExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of the specified `LbRouteExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbrouteextensions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbrouteextensions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbrouteextensions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbRouteExtension` resource to be created. + */ + lbRouteExtensionId?: string; + /** + * Required. The parent resource of the `LbRouteExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbRouteExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbRouteExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbRouteExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbrouteextensions$Patch + extends StandardParameters { + /** + * Required. Name of the `LbRouteExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbRouteExtensions/{lb_route_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Used to specify the fields to be overwritten in the `LbRouteExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbRouteExtension; + } + + export class Resource$Projects$Locations$Lbtrafficextensions { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new `LbTrafficExtension` resource in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes the specified `LbTrafficExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of the specified `LbTrafficExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `LbTrafficExtension` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+parent}/lbTrafficExtensions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Updates the parameters of the specified `LbTrafficExtension` resource. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Lbtrafficextensions$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Lbtrafficextensions$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://networkservices.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Create + extends StandardParameters { + /** + * Required. User-provided ID of the `LbTrafficExtension` resource to be created. + */ + lbTrafficExtensionId?: string; + /** + * Required. The parent resource of the `LbTrafficExtension` resource. Must be in the format `projects/{project\}/locations/{location\}`. + */ + parent?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbTrafficExtension; + } + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Delete + extends StandardParameters { + /** + * Required. The name of the `LbTrafficExtension` resource to delete. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Get + extends StandardParameters { + /** + * Required. A name of the `LbTrafficExtension` resource to get. Must be in the format `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$List + extends StandardParameters { + /** + * Optional. Filtering results. + */ + filter?: string; + /** + * Optional. Hint for how to order the results. + */ + orderBy?: string; + /** + * Optional. Requested page size. The server might return fewer items than requested. If unspecified, the server picks an appropriate default. + */ + pageSize?: number; + /** + * Optional. A token identifying a page of results that the server returns. + */ + pageToken?: string; + /** + * Required. The project and location from which the `LbTrafficExtension` resources are listed, specified in the following format: `projects/{project\}/locations/{location\}`. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Lbtrafficextensions$Patch + extends StandardParameters { + /** + * Required. Name of the `LbTrafficExtension` resource in the following format: `projects/{project\}/locations/{location\}/lbTrafficExtensions/{lb_traffic_extension\}`. + */ + name?: string; + /** + * Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server can ignore the request if it has already been completed. The server guarantees that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, ignores the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Used to specify the fields to be overwritten in the `LbTrafficExtension` resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field is overwritten if it is in the mask. If the user does not specify a mask, then all fields are overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$LbTrafficExtension; + } + export class Resource$Projects$Locations$Meshes { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/notebooks/v1.ts b/src/apis/notebooks/v1.ts index 54f2bf320a..cc948b8400 100644 --- a/src/apis/notebooks/v1.ts +++ b/src/apis/notebooks/v1.ts @@ -918,6 +918,40 @@ export namespace notebooks_v1 { */ name?: string | null; } + /** + * Request for migrating a User-Managed Notebook to Workbench Instances. + */ + export interface Schema$MigrateInstanceRequest { + /** + * Optional. Specifies the behavior of post startup script during migration. + */ + postStartupScriptOption?: string | null; + } + /** + * Request for migrating a Runtime to a Workbench Instance. + */ + export interface Schema$MigrateRuntimeRequest { + /** + * Optional. Name of the VPC that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same VPC, and this field must be empty. Format: `projects/{project_id\}/global/networks/{network_id\}` + */ + network?: string | null; + /** + * Optional. Specifies the behavior of post startup script during migration. + */ + postStartupScriptOption?: string | null; + /** + * Optional. Idempotent request UUID. + */ + requestId?: string | null; + /** + * Optional. The service account to be included in the Compute Engine instance of the new Workbench Instance when the Runtime uses "single user only" mode for permission. If not specified, the [Compute Engine default service account](https://cloud.google.com/compute/docs/access/service-accounts#default_service_account) is used. When the Runtime uses service account mode for permission, it will reuse the same service account, and this field must be empty. + */ + serviceAccount?: string | null; + /** + * Optional. Name of the subnet that the new Instance is in. This is required if the Runtime uses google-managed network. If the Runtime uses customer-owned network, it will reuse the same subnet, and this field must be empty. Format: `projects/{project_id\}/regions/{region\}/subnetworks/{subnetwork_id\}` + */ + subnet?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -3486,6 +3520,93 @@ export namespace notebooks_v1 { } } + /** + * Migrates an existing User-Managed Notebook to Workbench Instances. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + migrate( + params: Params$Resource$Projects$Locations$Instances$Migrate, + options: StreamMethodOptions + ): GaxiosPromise; + migrate( + params?: Params$Resource$Projects$Locations$Instances$Migrate, + options?: MethodOptions + ): GaxiosPromise; + migrate( + params: Params$Resource$Projects$Locations$Instances$Migrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + migrate( + params: Params$Resource$Projects$Locations$Instances$Migrate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + migrate( + params: Params$Resource$Projects$Locations$Instances$Migrate, + callback: BodyResponseCallback + ): void; + migrate(callback: BodyResponseCallback): void; + migrate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Instances$Migrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Instances$Migrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Instances$Migrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://notebooks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:migrate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Registers an existing legacy notebook instance to the Notebooks API server. Legacy instances are instances created with the legacy Compute Engine calls. They are not manageable by the Notebooks API out of the box. This call makes these instances manageable by the Notebooks API. * @@ -5074,6 +5195,18 @@ export namespace notebooks_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Instances$Migrate + extends StandardParameters { + /** + * Required. Format: `projects/{project_id\}/locations/{location\}/instances/{instance_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MigrateInstanceRequest; + } export interface Params$Resource$Projects$Locations$Instances$Register extends StandardParameters { /** @@ -6203,6 +6336,93 @@ export namespace notebooks_v1 { } } + /** + * Migrate an existing Runtime to a new Workbench Instance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + migrate( + params: Params$Resource$Projects$Locations$Runtimes$Migrate, + options: StreamMethodOptions + ): GaxiosPromise; + migrate( + params?: Params$Resource$Projects$Locations$Runtimes$Migrate, + options?: MethodOptions + ): GaxiosPromise; + migrate( + params: Params$Resource$Projects$Locations$Runtimes$Migrate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + migrate( + params: Params$Resource$Projects$Locations$Runtimes$Migrate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + migrate( + params: Params$Resource$Projects$Locations$Runtimes$Migrate, + callback: BodyResponseCallback + ): void; + migrate(callback: BodyResponseCallback): void; + migrate( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Runtimes$Migrate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Runtimes$Migrate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Runtimes$Migrate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://notebooks.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:migrate').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Update Notebook Runtime configuration. * @@ -7161,6 +7381,18 @@ export namespace notebooks_v1 { */ parent?: string; } + export interface Params$Resource$Projects$Locations$Runtimes$Migrate + extends StandardParameters { + /** + * Required. Format: `projects/{project_id\}/locations/{location\}/runtimes/{runtime_id\}` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$MigrateRuntimeRequest; + } export interface Params$Resource$Projects$Locations$Runtimes$Patch extends StandardParameters { /** diff --git a/src/apis/ondemandscanning/v1.ts b/src/apis/ondemandscanning/v1.ts index 3e04ec643a..7be037d541 100644 --- a/src/apis/ondemandscanning/v1.ts +++ b/src/apis/ondemandscanning/v1.ts @@ -1642,6 +1642,10 @@ export namespace ondemandscanning_v1 { * The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. */ effectiveSeverity?: string | null; + /** + * Occurrence-specific extra details about the vulnerability. + */ + extraDetails?: string | null; /** * Output only. Whether at least one of the affected packages has a fix available. */ diff --git a/src/apis/ondemandscanning/v1beta1.ts b/src/apis/ondemandscanning/v1beta1.ts index ceac77b035..71c5c99dc8 100644 --- a/src/apis/ondemandscanning/v1beta1.ts +++ b/src/apis/ondemandscanning/v1beta1.ts @@ -1638,6 +1638,10 @@ export namespace ondemandscanning_v1beta1 { * The distro assigned severity for this vulnerability when it is available, otherwise this is the note provider assigned severity. When there are multiple PackageIssues for this vulnerability, they can have different effective severities because some might be provided by the distro while others are provided by the language ecosystem for a language pack. For this reason, it is advised to use the effective severity on the PackageIssue level. In the case where multiple PackageIssues have differing effective severities, this field should be the highest severity for any of the PackageIssues. */ effectiveSeverity?: string | null; + /** + * Occurrence-specific extra details about the vulnerability. + */ + extraDetails?: string | null; /** * Output only. Whether at least one of the affected packages has a fix available. */ diff --git a/src/apis/oslogin/v1alpha.ts b/src/apis/oslogin/v1alpha.ts index e53c4d6978..19665b1744 100644 --- a/src/apis/oslogin/v1alpha.ts +++ b/src/apis/oslogin/v1alpha.ts @@ -526,9 +526,11 @@ export namespace oslogin_v1alpha { export class Resource$Users$Projects { context: APIRequestContext; + locations: Resource$Users$Projects$Locations; zones: Resource$Users$Projects$Zones; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Users$Projects$Locations(this.context); this.zones = new Resource$Users$Projects$Zones(this.context); } @@ -629,6 +631,121 @@ export namespace oslogin_v1alpha { operatingSystemType?: string; } + export class Resource$Users$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions + ): GaxiosPromise; + signSshPublicKey( + params?: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options?: MethodOptions + ): GaxiosPromise; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + callback: BodyResponseCallback + ): void; + signSshPublicKey( + paramsOrCallback?: + | Params$Resource$Users$Projects$Locations$Signsshpublickey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Projects$Locations$Signsshpublickey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Users$Projects$Locations$Signsshpublickey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha/{+parent}:signSshPublicKey').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Users$Projects$Locations$Signsshpublickey + extends StandardParameters { + /** + * The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignSshPublicKeyRequest; + } + export class Resource$Users$Projects$Zones { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/oslogin/v1beta.ts b/src/apis/oslogin/v1beta.ts index 85f2206c02..fdcf95c853 100644 --- a/src/apis/oslogin/v1beta.ts +++ b/src/apis/oslogin/v1beta.ts @@ -522,9 +522,11 @@ export namespace oslogin_v1beta { export class Resource$Users$Projects { context: APIRequestContext; + locations: Resource$Users$Projects$Locations; zones: Resource$Users$Projects$Zones; constructor(context: APIRequestContext) { this.context = context; + this.locations = new Resource$Users$Projects$Locations(this.context); this.zones = new Resource$Users$Projects$Zones(this.context); } @@ -621,6 +623,121 @@ export namespace oslogin_v1beta { name?: string; } + export class Resource$Users$Projects$Locations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Signs an SSH public key for a user to authenticate to an instance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions + ): GaxiosPromise; + signSshPublicKey( + params?: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options?: MethodOptions + ): GaxiosPromise; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + params: Params$Resource$Users$Projects$Locations$Signsshpublickey, + callback: BodyResponseCallback + ): void; + signSshPublicKey( + callback: BodyResponseCallback + ): void; + signSshPublicKey( + paramsOrCallback?: + | Params$Resource$Users$Projects$Locations$Signsshpublickey + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Users$Projects$Locations$Signsshpublickey; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Users$Projects$Locations$Signsshpublickey; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://oslogin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1beta/{+parent}:signSshPublicKey').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Users$Projects$Locations$Signsshpublickey + extends StandardParameters { + /** + * The parent project and zone for the signing request. This is needed to properly ensure per-organization ISS processing and potentially to provide for the possibility of zone-specific certificates used in the signing process. + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SignSshPublicKeyRequest; + } + export class Resource$Users$Projects$Zones { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/places/v1.ts b/src/apis/places/v1.ts index 4744b0332e..b0589aa180 100644 --- a/src/apis/places/v1.ts +++ b/src/apis/places/v1.ts @@ -171,6 +171,10 @@ export namespace places_v1 { * All the information representing a Place. */ export interface Schema$GoogleMapsPlacesV1Place { + /** + * Output only. Information about the accessibility options a place offers. + */ + accessibilityOptions?: Schema$GoogleMapsPlacesV1PlaceAccessibilityOptions; /** * Output only. Repeated components for each locality level. */ @@ -251,10 +255,6 @@ export namespace places_v1 { * Output only. A human-readable phone number for the place, in national format. */ nationalPhoneNumber?: string | null; - /** - * Output only. The regular hours of operation. - */ - openingHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours; /** * Output only. Plus code of the place location lat/long. */ @@ -267,6 +267,14 @@ export namespace places_v1 { * Output only. A rating between 1.0 and 5.0, based on user reviews of this place. */ rating?: number | null; + /** + * Output only. The regular hours of operation. + */ + regularOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours; + /** + * Output only. Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. + */ + regularSecondaryOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours[]; /** * Output only. Specifies if the place supports reservations. */ @@ -275,10 +283,6 @@ export namespace places_v1 { * Output only. List of reviews about this place. */ reviews?: Schema$GoogleMapsPlacesV1Review[]; - /** - * Output only. Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place. - */ - secondaryOpeningHours?: Schema$GoogleMapsPlacesV1PlaceOpeningHours[]; /** * Output only. Specifies if the place serves beer. */ @@ -331,8 +335,13 @@ export namespace places_v1 { * Output only. The authoritative website for this place, e.g. a business' homepage. Note that for places that are part of a chain (e.g. an IKEA store), this will usually be the website for the individual store, not the overall chain. */ websiteUri?: string | null; + } + /** + * Information about the accessibility options a place offers. + */ + export interface Schema$GoogleMapsPlacesV1PlaceAccessibilityOptions { /** - * Output only. [Deprecated!] Specifies if the place has an entrance that is wheelchair-accessible. + * Places has wheelchair accessible entrance. */ wheelchairAccessibleEntrance?: boolean | null; } diff --git a/src/apis/playintegrity/v1.ts b/src/apis/playintegrity/v1.ts index 8a6321c2b4..9ec8875e16 100644 --- a/src/apis/playintegrity/v1.ts +++ b/src/apis/playintegrity/v1.ts @@ -125,7 +125,7 @@ export namespace playintegrity_v1 { } /** - * Contains a signal helping apps differentiating between likely genuine users and likely non-genuine traffic (such as accounts being used for fraud, accounts used by automated traffic, or accounts used in device farms) based on the presence and volume of Play store activity. + * (Restricted Access) Contains a signal helping apps differentiating between likely genuine and likely non-genuine user traffic. */ export interface Schema$AccountActivity { /** @@ -138,7 +138,7 @@ export namespace playintegrity_v1 { */ export interface Schema$AccountDetails { /** - * Details about the account activity for the user in the scope. + * (Restricted Access) Details about the account activity for the user in the scope. */ accountActivity?: Schema$AccountActivity; /** @@ -263,7 +263,7 @@ export namespace playintegrity_v1 { testingDetails?: Schema$TestingDetails; } /** - * Contains details of remediation guidance that the user can perform. See go/pia-interstitials-dd + * Contains details of remediation guidance that the user can perform. */ export interface Schema$UserRemediationDetails { /** diff --git a/src/apis/redis/v1.ts b/src/apis/redis/v1.ts index fda723bd22..14f0faf78f 100644 --- a/src/apis/redis/v1.ts +++ b/src/apis/redis/v1.ts @@ -124,6 +124,92 @@ export namespace redis_v1 { } } + export interface Schema$CertChain { + /** + * The certificates that form the CA chain, from leaf to root order. + */ + certificates?: string[] | null; + } + /** + * Redis cluster certificate authority + */ + export interface Schema$CertificateAuthority { + managedServerCa?: Schema$ManagedCertificateAuthority; + } + /** + * A cluster instance. + */ + export interface Schema$Cluster { + /** + * Optional. The authorization mode of the Redis cluster. If not provided, auth feature is disabled for the cluster. + */ + authorizationMode?: string | null; + /** + * Output only. The timestamp associated with the cluster creation request. + */ + createTime?: string | null; + /** + * Output only. Endpoints created on each given network, for Redis clients to connect to the cluster. Currently only one discovery endpoint is supported. + */ + discoveryEndpoints?: Schema$DiscoveryEndpoint[]; + /** + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` + */ + name?: string | null; + /** + * Required. Each PscConfig configures the consumer network where IPs will be designated to the cluster for client access through Private Service Connect Automation. Currently, only one PscConfig is supported. + */ + pscConfigs?: Schema$PscConfig[]; + /** + * Output only. PSC connections for discovery of the cluster topology and accessing the cluster. + */ + pscConnections?: Schema$PscConnection[]; + /** + * Optional. The number of replica nodes per shard. + */ + replicaCount?: number | null; + /** + * Required. Number of shards for the Redis cluster. + */ + shardCount?: number | null; + /** + * Output only. Redis memory size in GB for the entire cluster. + */ + sizeGb?: number | null; + /** + * Output only. The current state of this cluster. Can be CREATING, READY, UPDATING, DELETING and SUSPENDED + */ + state?: string | null; + /** + * Output only. Additional information about the current state of the cluster. + */ + stateInfo?: Schema$StateInfo; + /** + * Optional. The in-transit encryption for the Redis cluster. If not provided, encryption is disabled for the cluster. + */ + transitEncryptionMode?: string | null; + /** + * Output only. System assigned, unique identifier for the cluster. + */ + uid?: string | null; + } + /** + * Endpoints on each network, for Redis clients to connect to the cluster. + */ + export interface Schema$DiscoveryEndpoint { + /** + * Output only. Address of the exposed Redis endpoint used by clients to connect to the service. The address could be either IP or hostname. + */ + address?: string | null; + /** + * Output only. The port number of the exposed Redis endpoint. + */ + port?: number | null; + /** + * Output only. Customer configuration for where the endpoint is created and accessed from. + */ + pscConfig?: Schema$PscConfig; + } /** * 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); \} */ @@ -384,6 +470,23 @@ export namespace redis_v1 { */ authString?: string | null; } + /** + * Response for ListClusters. + */ + export interface Schema$ListClustersResponse { + /** + * A list of Redis clusters in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated. If in such an aggregated query a location is unavailable, a placeholder Redis entry is included in the response with the `name` field set to a value of the form `projects/{project_id\}/locations/{location_id\}/clusters/`- and the `status` field set to ERROR and `status_message` field set to "location not available for ListClusters". + */ + clusters?: Schema$Cluster[]; + /** + * Token to retrieve the next page of results, or empty if there are no more results in the list. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached. + */ + unreachable?: string[] | null; + } /** * Response for ListInstances. */ @@ -494,6 +597,12 @@ export namespace redis_v1 { */ startTime?: string | null; } + export interface Schema$ManagedCertificateAuthority { + /** + * The PEM encoded CA certificate chains for redis managed server authentication + */ + caCerts?: Schema$CertChain[]; + } /** * Node specific properties. */ @@ -532,6 +641,39 @@ export namespace redis_v1 { */ response?: {[key: string]: any} | null; } + /** + * Pre-defined metadata fields. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } /** * The output content */ @@ -562,6 +704,37 @@ export namespace redis_v1 { */ rdbSnapshotStartTime?: string | null; } + export interface Schema$PscConfig { + /** + * Required. The network where the IP address of the discovery endpoint will be reserved, in the form of projects/{network_project\}/global/networks/{network_id\}. + */ + network?: string | null; + } + /** + * Details of consumer resources in a PSC connection. + */ + export interface Schema$PscConnection { + /** + * Output only. The IP allocated on the consumer network for the PSC forwarding rule. + */ + address?: string | null; + /** + * Output only. The URI of the consumer side forwarding rule. Example: projects/{projectNumOrId\}/regions/us-east1/forwardingRules/{resourceId\}. + */ + forwardingRule?: string | null; + /** + * The consumer network where the IP address resides, in the form of projects/{project_id\}/global/networks/{network_id\}. + */ + network?: string | null; + /** + * Output only. The consumer project_id where the forwarding rule is created from. + */ + projectId?: string | null; + /** + * Output only. The PSC connection id of the forwarding rule connected to the service attachment. + */ + pscConnectionId?: string | null; + } /** * Operation metadata returned by the CLH during resource state reconciliation. */ @@ -588,6 +761,15 @@ export namespace redis_v1 { */ scheduleTime?: string | null; } + /** + * Represents additional information about the state of the cluster. + */ + export interface Schema$StateInfo { + /** + * Describes ongoing update on the cluster when cluster state is UPDATING. + */ + updateInfo?: Schema$UpdateInfo; + } /** * 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). */ @@ -651,6 +833,19 @@ export namespace redis_v1 { */ sha1Fingerprint?: string | null; } + /** + * Represents information about an updating cluster. + */ + export interface Schema$UpdateInfo { + /** + * Target number of replica nodes per shard. + */ + targetReplicaCount?: number | null; + /** + * Target number of shards for redis cluster + */ + targetShardCount?: number | null; + } /** * Request for UpgradeInstance. */ @@ -689,10 +884,12 @@ export namespace redis_v1 { export class Resource$Projects$Locations { context: APIRequestContext; + clusters: Resource$Projects$Locations$Clusters; instances: Resource$Projects$Locations$Instances; operations: Resource$Projects$Locations$Operations; constructor(context: APIRequestContext) { this.context = context; + this.clusters = new Resource$Projects$Locations$Clusters(this.context); this.instances = new Resource$Projects$Locations$Instances(this.context); this.operations = new Resource$Projects$Locations$Operations( this.context @@ -903,6 +1100,620 @@ export namespace redis_v1 { pageToken?: string; } + export class Resource$Projects$Locations$Clusters { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a Redis cluster based on the specified properties. The creation is executed asynchronously and callers may check the returned operation to track its progress. Once the operation is completed the Redis cluster will be fully functional. The completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Clusters$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Clusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a specific Redis cluster. Cluster stops serving and data is deleted. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Clusters$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Clusters$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the details of a specific Redis cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Clusters$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Clusters$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the details of certificate authority information for Redis cluster. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getCertificateAuthority( + params: Params$Resource$Projects$Locations$Clusters$Getcertificateauthority, + options: StreamMethodOptions + ): GaxiosPromise; + getCertificateAuthority( + params?: Params$Resource$Projects$Locations$Clusters$Getcertificateauthority, + options?: MethodOptions + ): GaxiosPromise; + getCertificateAuthority( + params: Params$Resource$Projects$Locations$Clusters$Getcertificateauthority, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCertificateAuthority( + params: Params$Resource$Projects$Locations$Clusters$Getcertificateauthority, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getCertificateAuthority( + params: Params$Resource$Projects$Locations$Clusters$Getcertificateauthority, + callback: BodyResponseCallback + ): void; + getCertificateAuthority( + callback: BodyResponseCallback + ): void; + getCertificateAuthority( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Getcertificateauthority + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Getcertificateauthority; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Clusters$Getcertificateauthority; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/certificateAuthority').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists all Redis clusters owned by a project in either the specified location (region) or all locations. The location should have the following format: * `projects/{project_id\}/locations/{location_id\}` If `location_id` is specified as `-` (wildcard), then all regions available to the project are queried, and the results are aggregated. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Clusters$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Clusters$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Clusters$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the metadata and configuration of a specific Redis cluster. Completed longrunning.Operation will contain the new cluster object in the response field. The returned operation is automatically deleted after a few hours, so there is no need to call DeleteOperation. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Clusters$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Clusters$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Clusters$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Clusters$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Clusters$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://redis.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Clusters$Create + extends StandardParameters { + /** + * Required. The logical name of the Redis cluster in the customer project with the following restrictions: * Must contain only lowercase letters, numbers, and hyphens. * Must start with a letter. * Must be between 1-63 characters. * Must end with a number or a letter. * Must be unique within the customer project / location + */ + clusterId?: string; + /** + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + */ + parent?: string; + /** + * Idempotent request UUID. + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + export interface Params$Resource$Projects$Locations$Clusters$Delete + extends StandardParameters { + /** + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + */ + name?: string; + /** + * Idempotent request UUID. + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Get + extends StandardParameters { + /** + * Required. Redis cluster resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` where `location_id` refers to a GCP region. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Getcertificateauthority + extends StandardParameters { + /** + * Required. Redis cluster certificate authority resource name using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}/certificateAuthority` where `location_id` refers to a GCP region. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$List + extends StandardParameters { + /** + * The maximum number of items to return. If not specified, a default value of 1000 will be used by the service. Regardless of the page_size value, the response may include a partial list and a caller should only rely on response's `next_page_token` to determine if there are more clusters left to be queried. + */ + pageSize?: number; + /** + * The `next_page_token` value returned from a previous ListClusters request, if any. + */ + pageToken?: string; + /** + * Required. The resource name of the cluster location using the form: `projects/{project_id\}/locations/{location_id\}` where `location_id` refers to a GCP region. + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Clusters$Patch + extends StandardParameters { + /** + * Required. Unique name of the resource in this scope including project and location using the form: `projects/{project_id\}/locations/{location_id\}/clusters/{cluster_id\}` + */ + name?: string; + /** + * Idempotent request UUID. + */ + requestId?: string; + /** + * Required. Mask of fields to update. At least one path must be supplied in this field. The elements of the repeated paths field may only include these fields from Cluster: * `size_gb` * `replica_count` + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + export class Resource$Projects$Locations$Instances { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/retail/v2alpha.ts b/src/apis/retail/v2alpha.ts index 5bf6d71cfa..0783103272 100644 --- a/src/apis/retail/v2alpha.ts +++ b/src/apis/retail/v2alpha.ts @@ -1265,6 +1265,49 @@ export namespace retail_v2alpha { */ priceInfo?: Schema$GoogleCloudRetailV2alphaPriceInfo; } + /** + * Project level logging config to control what level of log will be generated and written to Cloud Logging. + */ + export interface Schema$GoogleCloudRetailV2alphaLoggingConfig { + /** + * The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control. + */ + defaultLogGenerationRule?: Schema$GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule; + /** + * Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/x/loggingConfig + */ + name?: string | null; + /** + * Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule. + */ + serviceLogGenerationRules?: Schema$GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule[]; + } + /** + * The logging configurations for services supporting log generation. + */ + export interface Schema$GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule { + /** + * The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1. + */ + infoLogSampleRate?: number | null; + /** + * The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`. + */ + loggingLevel?: string | null; + } + /** + * The granular logging configurations for supported services. + */ + export interface Schema$GoogleCloudRetailV2alphaLoggingConfigServiceLogGenerationRule { + /** + * The log generation rule that applies to this service. + */ + logGenerationRule?: Schema$GoogleCloudRetailV2alphaLoggingConfigLogGenerationRule; + /** + * Required. Supported service names: "CatalogService", "CompletionService", "ControlService", "MerchantCenterStreaming", "ModelService", "PredictionService", "ProductService", "ServingConfigService", "UserEventService", + */ + serviceName?: string | null; + } /** * Represents a link between a Merchant Center account and a branch. After a link is established, products from the linked Merchant Center account are streamed to the linked branch. */ @@ -3865,6 +3908,99 @@ export namespace retail_v2alpha { } } + /** + * Gets the LoggingConfig of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getLoggingConfig( + params: Params$Resource$Projects$Getloggingconfig, + options: StreamMethodOptions + ): GaxiosPromise; + getLoggingConfig( + params?: Params$Resource$Projects$Getloggingconfig, + options?: MethodOptions + ): GaxiosPromise; + getLoggingConfig( + params: Params$Resource$Projects$Getloggingconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getLoggingConfig( + params: Params$Resource$Projects$Getloggingconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getLoggingConfig( + params: Params$Resource$Projects$Getloggingconfig, + callback: BodyResponseCallback + ): void; + getLoggingConfig( + callback: BodyResponseCallback + ): void; + getLoggingConfig( + paramsOrCallback?: + | Params$Resource$Projects$Getloggingconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Getloggingconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Getloggingconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + /** * Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service. * @@ -4053,6 +4189,99 @@ export namespace retail_v2alpha { ); } } + + /** + * Updates the LoggingConfig of the requested project. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + updateLoggingConfig( + params: Params$Resource$Projects$Updateloggingconfig, + options: StreamMethodOptions + ): GaxiosPromise; + updateLoggingConfig( + params?: Params$Resource$Projects$Updateloggingconfig, + options?: MethodOptions + ): GaxiosPromise; + updateLoggingConfig( + params: Params$Resource$Projects$Updateloggingconfig, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLoggingConfig( + params: Params$Resource$Projects$Updateloggingconfig, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + updateLoggingConfig( + params: Params$Resource$Projects$Updateloggingconfig, + callback: BodyResponseCallback + ): void; + updateLoggingConfig( + callback: BodyResponseCallback + ): void; + updateLoggingConfig( + paramsOrCallback?: + | Params$Resource$Projects$Updateloggingconfig + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Updateloggingconfig; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Updateloggingconfig; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://retail.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v2alpha/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } } export interface Params$Resource$Projects$Enrollsolution @@ -4067,6 +4296,13 @@ export namespace retail_v2alpha { */ requestBody?: Schema$GoogleCloudRetailV2alphaEnrollSolutionRequest; } + export interface Params$Resource$Projects$Getloggingconfig + extends StandardParameters { + /** + * Required. Full LoggingConfig resource name. Format: projects/{project_number\}/loggingConfig + */ + name?: string; + } export interface Params$Resource$Projects$Getretailproject extends StandardParameters { /** @@ -4081,6 +4317,22 @@ export namespace retail_v2alpha { */ parent?: string; } + export interface Params$Resource$Projects$Updateloggingconfig + extends StandardParameters { + /** + * Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/x/loggingConfig + */ + name?: string; + /** + * Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * default_log_generation_rule * per_service_log_generation_rules If not set, all supported fields are updated. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GoogleCloudRetailV2alphaLoggingConfig; + } export class Resource$Projects$Locations { context: APIRequestContext; diff --git a/src/apis/run/v1.ts b/src/apis/run/v1.ts index 2deb76c68e..66f7f6acfd 100644 --- a/src/apis/run/v1.ts +++ b/src/apis/run/v1.ts @@ -519,7 +519,7 @@ export namespace run_v1 { */ export interface Schema$EnvVar { /** - * Required. Name of the environment variable. Must be a C_IDENTIFIER. + * Required. Name of the environment variable. */ name?: string | null; /** @@ -1142,7 +1142,7 @@ export namespace run_v1 { */ export interface Schema$ObjectMeta { /** - * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/disable-default-uri`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. + * Unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. * `autoscaling.knative.dev/maxScale`: Revision. * `autoscaling.knative.dev/minScale`: Revision. * `run.googleapis.com/binary-authorization-breakglass`: Service, Job, * `run.googleapis.com/binary-authorization`: Service, Job, Execution. * `run.googleapis.com/client-name`: All resources. * `run.googleapis.com/cloudsql-instances`: Revision, Execution. * `run.googleapis.com/container-dependencies`: Revision. * `run.googleapis.com/cpu-throttling`: Revision. * `run.googleapis.com/custom-audiences`: Service. * `run.googleapis.com/description`: Service. * `run.googleapis.com/disable-default-url`: Service. * `run.googleapis.com/encryption-key-shutdown-hours`: Revision * `run.googleapis.com/encryption-key`: Revision, Execution. * `run.googleapis.com/execution-environment`: Revision, Execution. * `run.googleapis.com/gc-traffic-tags`: Service. * `run.googleapis.com/ingress`: Service. * `run.googleapis.com/launch-stage`: Service, Job. * `run.googleapis.com/network-interfaces`: Revision, Execution. * `run.googleapis.com/post-key-revocation-action-type`: Revision. * `run.googleapis.com/secrets`: Revision, Execution. * `run.googleapis.com/secure-session-agent`: Revision. * `run.googleapis.com/sessionAffinity`: Revision. * `run.googleapis.com/startup-cpu-boost`: Revision. * `run.googleapis.com/vpc-access-connector`: Revision, Execution. * `run.googleapis.com/vpc-access-egress`: Revision, Execution. */ annotations?: {[key: string]: string} | null; /** @@ -1582,7 +1582,7 @@ export namespace run_v1 { */ kind?: string | null; /** - * Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/disable-default-uri` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. + * Metadata associated with this Service, including name, namespace, labels, and annotations. In Cloud Run, annotations with 'run.googleapis.com/' and 'autoscaling.knative.dev' are restricted, and the accepted annotations will be different depending on the resource type. The following Cloud Run-specific annotations are accepted in Service.metadata.annotations. * `run.googleapis.com/binary-authorization-breakglass` * `run.googleapis.com/binary-authorization` * `run.googleapis.com/client-name` * `run.googleapis.com/custom-audiences` * `run.googleapis.com/description` * `run.googleapis.com/disable-default-url` * `run.googleapis.com/gc-traffic-tags` * `run.googleapis.com/ingress` * `run.googleapis.com/ingress` sets the ingress settings for the Service. See [the ingress settings documentation](/run/docs/securing/ingress) for details on configuring ingress settings. * `run.googleapis.com/ingress-status` is output-only and contains the currently active ingress settings for the Service. `run.googleapis.com/ingress-status` may differ from `run.googleapis.com/ingress` while the system is processing a change to `run.googleapis.com/ingress` or if the system failed to process a change to `run.googleapis.com/ingress`. When the system has processed all changes successfully `run.googleapis.com/ingress-status` and `run.googleapis.com/ingress` are equal. */ metadata?: Schema$ObjectMeta; /** @@ -1628,7 +1628,7 @@ export namespace run_v1 { */ latestReadyRevisionName?: string | null; /** - * Returns the generation last fully processed by the system. This will only match metadata.generation when reconciliation is complete. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. + * Returns the generation last seen by the system. Clients polling for completed reconciliation should poll until observedGeneration = metadata.generation and the Ready condition's status is True or False. */ observedGeneration?: number | null; /** diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index 723be4b9e1..2ad1265fa0 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -301,7 +301,7 @@ export namespace run_v2 { */ export interface Schema$GoogleCloudRunV2EnvVar { /** - * Required. Name of the environment variable. Must be a C_IDENTIFIER, and must not exceed 32768 characters. + * Required. Name of the environment variable. Must not exceed 32768 characters. */ name?: string | null; /** @@ -1120,10 +1120,6 @@ export namespace run_v2 { * Output only. Detailed status information for corresponding traffic targets. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. */ trafficStatuses?: Schema$GoogleCloudRunV2TrafficTargetStatus[]; - /** - * Optional. Override the traffic tag threshold limit. Garbage collection will start cleaning up non-serving tagged traffic targets based on creation item. The default value is 2000. - */ - trafficTagsCleanupThreshold?: string | null; /** * Output only. Server assigned unique identifier for the trigger. The value is a UUID4 string and guaranteed to remain unchanged until the resource is deleted. */ diff --git a/src/apis/safebrowsing/index.ts b/src/apis/safebrowsing/index.ts index 2a810160d4..2bea06ee12 100644 --- a/src/apis/safebrowsing/index.ts +++ b/src/apis/safebrowsing/index.ts @@ -15,18 +15,30 @@ import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; import {safebrowsing_v4} from './v4'; +import {safebrowsing_v5} from './v5'; export const VERSIONS = { v4: safebrowsing_v4.Safebrowsing, + v5: safebrowsing_v5.Safebrowsing, }; export function safebrowsing(version: 'v4'): safebrowsing_v4.Safebrowsing; export function safebrowsing( options: safebrowsing_v4.Options ): safebrowsing_v4.Safebrowsing; -export function safebrowsing( +export function safebrowsing(version: 'v5'): safebrowsing_v5.Safebrowsing; +export function safebrowsing( + options: safebrowsing_v5.Options +): safebrowsing_v5.Safebrowsing; +export function safebrowsing< + T = safebrowsing_v4.Safebrowsing | safebrowsing_v5.Safebrowsing, +>( this: GoogleConfigurable, - versionOrOptions: 'v4' | safebrowsing_v4.Options + versionOrOptions: + | 'v4' + | safebrowsing_v4.Options + | 'v5' + | safebrowsing_v5.Options ) { return getAPI('safebrowsing', versionOrOptions, VERSIONS, this); } @@ -34,6 +46,7 @@ export function safebrowsing( const auth = new AuthPlus(); export {auth}; export {safebrowsing_v4}; +export {safebrowsing_v5}; export { AuthPlus, GlobalOptions, diff --git a/src/apis/safebrowsing/v5.ts b/src/apis/safebrowsing/v5.ts new file mode 100644 index 0000000000..5196835af7 --- /dev/null +++ b/src/apis/safebrowsing/v5.ts @@ -0,0 +1,272 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace safebrowsing_v5 { + export interface Options extends GlobalOptions { + version: 'v5'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * Safe Browsing API + * + * Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const safebrowsing = google.safebrowsing('v5'); + * ``` + */ + export class Safebrowsing { + context: APIRequestContext; + hashes: Resource$Hashes; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.hashes = new Resource$Hashes(this.context); + } + } + + /** + * The full hash identified with one or more matches. + */ + export interface Schema$GoogleSecuritySafebrowsingV5FullHash { + /** + * The matching full hash. This is the SHA256 hash. The length will be exactly 32 bytes. + */ + fullHash?: string | null; + /** + * Unordered list. A repeated field identifying the details relevant to this full hash. + */ + fullHashDetails?: Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail[]; + } + /** + * Details about a matching full hash. An important note about forward compatibility: new threat types and threat attributes may be added by the server at any time; those additions are considered minor version changes. It is Google's policy not to expose minor version numbers in APIs (see https://cloud.google.com/apis/design/versioning), so clients MUST be prepared to receive FullHashDetail messages containing ThreatType enum values or ThreatAttribute enum values that are considered invalid by the client. Therefore, it is the client's responsibility to check for the validity of all ThreatType and ThreatAttribute enum values; if any value is considered invalid, the client MUST disregard the entire FullHashDetail message. + */ + export interface Schema$GoogleSecuritySafebrowsingV5FullHashFullHashDetail { + /** + * Unordered list. Additional attributes about those full hashes. This may be empty. + */ + attributes?: string[] | null; + /** + * The type of threat. This field will never be empty. + */ + threatType?: string | null; + } + /** + * The response returned after searching threat hashes. Note that if nothing is found, the server will return an OK status (HTTP status code 200) with the `full_hashes` field empty, rather than returning a NOT_FOUND status (HTTP status code 404). + */ + export interface Schema$GoogleSecuritySafebrowsingV5SearchHashesResponse { + /** + * The client-side cache duration. The client shall add this duration to the current time to determine the expiration time. The expiration time then applies to every hash prefix queried by the client in the request, regardless of how many full hashes are returned in the response. Even if the server returns no full hashes for a particular hash prefix, this fact should also be cached by the client. Important: the client must not assume that the server will return the same cache duration for all responses. The server may choose different cache durations for different responses depending on the situation. + */ + cacheDuration?: string | null; + /** + * Unordered list. The unordered list of full hashes found. + */ + fullHashes?: Schema$GoogleSecuritySafebrowsingV5FullHash[]; + } + + export class Resource$Hashes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Search for full hashes matching the specified prefixes. This is a custom method as described by guidance at https://google.aip.dev/136 + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + search( + params: Params$Resource$Hashes$Search, + options: StreamMethodOptions + ): GaxiosPromise; + search( + params?: Params$Resource$Hashes$Search, + options?: MethodOptions + ): GaxiosPromise; + search( + params: Params$Resource$Hashes$Search, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Hashes$Search, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + search( + params: Params$Resource$Hashes$Search, + callback: BodyResponseCallback + ): void; + search( + callback: BodyResponseCallback + ): void; + search( + paramsOrCallback?: + | Params$Resource$Hashes$Search + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || {}) as Params$Resource$Hashes$Search; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Hashes$Search; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://safebrowsing.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v5/hashes:search').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: [], + pathParams: [], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Hashes$Search extends StandardParameters { + /** + * Required. The hash prefixes to be looked up. + */ + hashPrefixes?: string[]; + } +} diff --git a/src/apis/sasportal/v1alpha1.ts b/src/apis/sasportal/v1alpha1.ts index bdf8b6b5cb..a756baaeab 100644 --- a/src/apis/sasportal/v1alpha1.ts +++ b/src/apis/sasportal/v1alpha1.ts @@ -783,7 +783,12 @@ export namespace sasportal_v1alpha1 { /** * Request for the SetupSasAnalytics rpc. */ - export interface Schema$SasPortalSetupSasAnalyticsRequest {} + export interface Schema$SasPortalSetupSasAnalyticsRequest { + /** + * Optional. User id to setup analytics for, if not provided the user id associated with the project is used. optional + */ + userId?: string | null; + } /** * Response returned by the long running operation for the SetupSasAnalytics rpc. */ diff --git a/src/apis/securitycenter/v1.ts b/src/apis/securitycenter/v1.ts index fcbe7acaf2..fd9c8b4be2 100644 --- a/src/apis/securitycenter/v1.ts +++ b/src/apis/securitycenter/v1.ts @@ -950,6 +950,10 @@ export namespace securitycenter_v1 { * Kubernetes resources associated with the finding. */ kubernetes?: Schema$Kubernetes; + /** + * The load balancers associated with the finding. + */ + loadBalancers?: Schema$LoadBalancer[]; /** * MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org */ @@ -998,6 +1002,10 @@ export namespace securitycenter_v1 { * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ securityMarks?: Schema$SecurityMarks; + /** + * The security posture associated with the finding. + */ + securityPosture?: Schema$SecurityPosture; /** * The severity of the finding. This field is managed by the source that writes the finding. */ @@ -1466,7 +1474,7 @@ export namespace securitycenter_v1 { resourceTypes?: string[] | null; } /** - * A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation. + * A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. */ export interface Schema$GoogleCloudSecuritycenterV1ResourceValueConfig { /** @@ -1773,6 +1781,10 @@ export namespace securitycenter_v1 { * Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. */ nodes?: Schema$Node[]; + /** + * Kubernetes objects related to the finding. + */ + objects?: Schema$Object[]; /** * Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. */ @@ -2027,6 +2039,15 @@ export namespace securitycenter_v1 { */ valuedResources?: Schema$ValuedResource[]; } + /** + * Contains information related to the load balancer associated with the finding. + */ + export interface Schema$LoadBalancer { + /** + * The name of the load balancer associated with the finding. + */ + name?: string | null; + } /** * A signature corresponding to memory page hashes. */ @@ -2112,6 +2133,27 @@ export namespace securitycenter_v1 { */ streamingConfig?: Schema$StreamingConfig; } + /** + * Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. + */ + export interface Schema$Object { + /** + * Kubernetes object group, such as "policy.k8s.io/v1". + */ + group?: string | null; + /** + * Kubernetes object kind, such as “Namespace”. + */ + kind?: string | null; + /** + * Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. + */ + name?: string | null; + /** + * Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + */ + ns?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -2416,6 +2458,31 @@ export namespace securitycenter_v1 { */ name?: string | null; } + /** + * Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. + */ + export interface Schema$SecurityPosture { + /** + * The name of the policy that has been updated, for example, `projects/{project_id\}/policies/{constraint_name\}`. + */ + changedPolicy?: string | null; + /** + * Name of the posture, for example, `organizations/{org_id\}/locations/{location\}/postures/{posture_name\}`. + */ + name?: string | null; + /** + * The name of the posture deployment, for example, `projects/{project_id\}/posturedeployments/{posture_deployment_id\}`. + */ + postureDeployment?: string | null; + /** + * The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id\}`. + */ + postureDeploymentResource?: string | null; + /** + * The version of the posture, for example, `c7cfa2a8`. + */ + revisionId?: string | null; + } /** * Identity delegation history of an authenticated service account. */ @@ -2486,7 +2553,7 @@ export namespace securitycenter_v1 { */ export interface Schema$Source { /** - * The canonical name of the finding. It's either "organizations/{organization_id\}/sources/{source_id\}", "folders/{folder_id\}/sources/{source_id\}" or "projects/{project_number\}/sources/{source_id\}", depending on the closest CRM ancestor of the resource associated with the finding. + * The canonical name of the finding source. It's either "organizations/{organization_id\}/sources/{source_id\}", "folders/{folder_id\}/sources/{source_id\}", or "projects/{project_number\}/sources/{source_id\}", depending on the closest CRM ancestor of the resource associated with the finding. */ canonicalName?: string | null; /** diff --git a/src/apis/securitycenter/v1beta1.ts b/src/apis/securitycenter/v1beta1.ts index 265bc21007..dadd726d67 100644 --- a/src/apis/securitycenter/v1beta1.ts +++ b/src/apis/securitycenter/v1beta1.ts @@ -746,6 +746,10 @@ export namespace securitycenter_v1beta1 { * Kubernetes resources associated with the finding. */ kubernetes?: Schema$Kubernetes; + /** + * The load balancers associated with the finding. + */ + loadBalancers?: Schema$LoadBalancer[]; /** * MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org */ @@ -794,6 +798,10 @@ export namespace securitycenter_v1beta1 { * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ securityMarks?: Schema$SecurityMarks; + /** + * The security posture associated with the finding. + */ + securityPosture?: Schema$SecurityPosture; /** * The severity of the finding. This field is managed by the source that writes the finding. */ @@ -1320,7 +1328,7 @@ export namespace securitycenter_v1beta1 { resourceTypes?: string[] | null; } /** - * A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation. + * A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. */ export interface Schema$GoogleCloudSecuritycenterV1ResourceValueConfig { /** @@ -1606,6 +1614,10 @@ export namespace securitycenter_v1beta1 { * Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. */ nodes?: Schema$Node[]; + /** + * Kubernetes objects related to the finding. + */ + objects?: Schema$Object[]; /** * Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. */ @@ -1709,6 +1721,15 @@ export namespace securitycenter_v1beta1 { */ sources?: Schema$Source[]; } + /** + * Contains information related to the load balancer associated with the finding. + */ + export interface Schema$LoadBalancer { + /** + * The name of the load balancer associated with the finding. + */ + name?: string | null; + } /** * A signature corresponding to memory page hashes. */ @@ -1769,6 +1790,27 @@ export namespace securitycenter_v1beta1 { */ nodes?: Schema$Node[]; } + /** + * Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. + */ + export interface Schema$Object { + /** + * Kubernetes object group, such as "policy.k8s.io/v1". + */ + group?: string | null; + /** + * Kubernetes object kind, such as “Namespace”. + */ + kind?: string | null; + /** + * Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. + */ + name?: string | null; + /** + * Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. + */ + ns?: string | null; + } /** * This resource represents a long-running operation that is the result of a network API call. */ @@ -1987,6 +2029,31 @@ export namespace securitycenter_v1beta1 { */ name?: string | null; } + /** + * Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. + */ + export interface Schema$SecurityPosture { + /** + * The name of the policy that has been updated, for example, `projects/{project_id\}/policies/{constraint_name\}`. + */ + changedPolicy?: string | null; + /** + * Name of the posture, for example, `organizations/{org_id\}/locations/{location\}/postures/{posture_name\}`. + */ + name?: string | null; + /** + * The name of the posture deployment, for example, `projects/{project_id\}/posturedeployments/{posture_deployment_id\}`. + */ + postureDeployment?: string | null; + /** + * The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id\}`. + */ + postureDeploymentResource?: string | null; + /** + * The version of the posture, for example, `c7cfa2a8`. + */ + revisionId?: string | null; + } /** * Identity delegation history of an authenticated service account. */ diff --git a/src/apis/securitycenter/v1beta2.ts b/src/apis/securitycenter/v1beta2.ts index 5ea1a73fe0..e13c462370 100644 --- a/src/apis/securitycenter/v1beta2.ts +++ b/src/apis/securitycenter/v1beta2.ts @@ -733,6 +733,10 @@ export namespace securitycenter_v1beta2 { * Kubernetes resources associated with the finding. */ kubernetes?: Schema$Kubernetes; + /** + * The load balancers associated with the finding. + */ + loadBalancers?: Schema$LoadBalancer[]; /** * MITRE ATT&CK tactics and techniques related to this finding. See: https://attack.mitre.org */ @@ -781,6 +785,10 @@ export namespace securitycenter_v1beta2 { * Output only. User specified security marks. These marks are entirely managed by the user and come from the SecurityMarks resource that belongs to the finding. */ securityMarks?: Schema$SecurityMarks; + /** + * The security posture associated with the finding. + */ + securityPosture?: Schema$SecurityPosture; /** * The severity of the finding. This field is managed by the source that writes the finding. */ @@ -1231,7 +1239,7 @@ export namespace securitycenter_v1beta2 { resourceTypes?: string[] | null; } /** - * A resource value config is a mapping configuration of user's tag values to resource values. Used by the attack path simulation. + * A resource value config (RVC) is a mapping configuration of user's resources to resource values. Used in Attack path simulations. */ export interface Schema$GoogleCloudSecuritycenterV1ResourceValueConfig { /** @@ -1416,6 +1424,10 @@ export namespace securitycenter_v1beta2 { * Provides Kubernetes [node](https://cloud.google.com/kubernetes-engine/docs/concepts/cluster-architecture#nodes) information. */ nodes?: Schema$Node[]; + /** + * Kubernetes objects related to the finding. + */ + objects?: Schema$Object[]; /** * Kubernetes [Pods](https://cloud.google.com/kubernetes-engine/docs/concepts/pod) associated with the finding. This field contains Pod records for each container that is owned by a Pod. */ @@ -1438,6 +1450,15 @@ export namespace securitycenter_v1beta2 { */ value?: string | null; } + /** + * Contains information related to the load balancer associated with the finding. + */ + export interface Schema$LoadBalancer { + /** + * The name of the load balancer associated with the finding. + */ + name?: string | null; + } /** * A signature corresponding to memory page hashes. */ @@ -1499,17 +1520,25 @@ export namespace securitycenter_v1beta2 { nodes?: Schema$Node[]; } /** - * Resource capturing onboarding information for a given CRM resource. + * Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview. */ - export interface Schema$OnboardingState { + export interface Schema$Object { + /** + * Kubernetes object group, such as "policy.k8s.io/v1". + */ + group?: string | null; /** - * The resource name of the OnboardingState. Format: organizations/{organization\}/onboardingState Format: folders/{folder\}/onboardingState Format: projects/{project\}/onboardingState + * Kubernetes object kind, such as “Namespace”. + */ + kind?: string | null; + /** + * Kubernetes object name. For details see https://kubernetes.io/docs/concepts/overview/working-with-objects/names/. */ name?: string | null; /** - * Describes the level a given organization, folder, or project is onboarded with SCC. If the resource wasn't onboarded, NOT_FOUND would have been thrown. + * Kubernetes object namespace. Must be a valid DNS label. Named "ns" to avoid collision with C++ namespace keyword. For details see https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. */ - onboardingLevel?: string | null; + ns?: string | null; } /** * A Kubernetes Pod. @@ -1704,6 +1733,31 @@ export namespace securitycenter_v1beta2 { */ name?: string | null; } + /** + * Represents a posture that is deployed on Google Cloud by the Security Command Center Posture Management service. A posture contains one or more policy sets. A policy set is a group of policies that enforce a set of security rules on Google Cloud. + */ + export interface Schema$SecurityPosture { + /** + * The name of the policy that has been updated, for example, `projects/{project_id\}/policies/{constraint_name\}`. + */ + changedPolicy?: string | null; + /** + * Name of the posture, for example, `organizations/{org_id\}/locations/{location\}/postures/{posture_name\}`. + */ + name?: string | null; + /** + * The name of the posture deployment, for example, `projects/{project_id\}/posturedeployments/{posture_deployment_id\}`. + */ + postureDeployment?: string | null; + /** + * The project, folder, or organization on which the posture is deployed, for example, `projects/{project_id\}`. + */ + postureDeploymentResource?: string | null; + /** + * The version of the posture, for example, `c7cfa2a8`. + */ + revisionId?: string | null; + } /** * Identity delegation history of an authenticated service account. */ @@ -2031,93 +2085,6 @@ export namespace securitycenter_v1beta2 { } } - /** - * Retrieve the OnboardingState of a resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getOnboardingState( - params: Params$Resource$Folders$Getonboardingstate, - options: StreamMethodOptions - ): GaxiosPromise; - getOnboardingState( - params?: Params$Resource$Folders$Getonboardingstate, - options?: MethodOptions - ): GaxiosPromise; - getOnboardingState( - params: Params$Resource$Folders$Getonboardingstate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Folders$Getonboardingstate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Folders$Getonboardingstate, - callback: BodyResponseCallback - ): void; - getOnboardingState( - callback: BodyResponseCallback - ): void; - getOnboardingState( - paramsOrCallback?: - | Params$Resource$Folders$Getonboardingstate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Folders$Getonboardingstate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Folders$Getonboardingstate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose. * @@ -3169,13 +3136,6 @@ export namespace securitycenter_v1beta2 { */ name?: string; } - export interface Params$Resource$Folders$Getonboardingstate - extends StandardParameters { - /** - * Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization\}/onboardingState * folders/{folder\}/onboardingState * projects/{project\}/onboardingState - */ - name?: string; - } export interface Params$Resource$Folders$Getrapidvulnerabilitydetectionsettings extends StandardParameters { /** @@ -4206,93 +4166,6 @@ export namespace securitycenter_v1beta2 { } } - /** - * Retrieve the OnboardingState of a resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getOnboardingState( - params: Params$Resource$Organizations$Getonboardingstate, - options: StreamMethodOptions - ): GaxiosPromise; - getOnboardingState( - params?: Params$Resource$Organizations$Getonboardingstate, - options?: MethodOptions - ): GaxiosPromise; - getOnboardingState( - params: Params$Resource$Organizations$Getonboardingstate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Organizations$Getonboardingstate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Organizations$Getonboardingstate, - callback: BodyResponseCallback - ): void; - getOnboardingState( - callback: BodyResponseCallback - ): void; - getOnboardingState( - paramsOrCallback?: - | Params$Resource$Organizations$Getonboardingstate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Organizations$Getonboardingstate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Organizations$Getonboardingstate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose. * @@ -5431,13 +5304,6 @@ export namespace securitycenter_v1beta2 { */ name?: string; } - export interface Params$Resource$Organizations$Getonboardingstate - extends StandardParameters { - /** - * Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization\}/onboardingState * folders/{folder\}/onboardingState * projects/{project\}/onboardingState - */ - name?: string; - } export interface Params$Resource$Organizations$Getrapidvulnerabilitydetectionsettings extends StandardParameters { /** @@ -6470,93 +6336,6 @@ export namespace securitycenter_v1beta2 { } } - /** - * Retrieve the OnboardingState of a resource. - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. - * @param callback - Optional callback that handles the response. - * @returns A promise if used with async/await, or void if used with a callback. - */ - getOnboardingState( - params: Params$Resource$Projects$Getonboardingstate, - options: StreamMethodOptions - ): GaxiosPromise; - getOnboardingState( - params?: Params$Resource$Projects$Getonboardingstate, - options?: MethodOptions - ): GaxiosPromise; - getOnboardingState( - params: Params$Resource$Projects$Getonboardingstate, - options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Projects$Getonboardingstate, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - getOnboardingState( - params: Params$Resource$Projects$Getonboardingstate, - callback: BodyResponseCallback - ): void; - getOnboardingState( - callback: BodyResponseCallback - ): void; - getOnboardingState( - paramsOrCallback?: - | Params$Resource$Projects$Getonboardingstate - | BodyResponseCallback - | BodyResponseCallback, - optionsOrCallback?: - | MethodOptions - | StreamMethodOptions - | BodyResponseCallback - | BodyResponseCallback, - callback?: - | BodyResponseCallback - | BodyResponseCallback - ): void | GaxiosPromise | GaxiosPromise { - let params = (paramsOrCallback || - {}) as Params$Resource$Projects$Getonboardingstate; - let options = (optionsOrCallback || {}) as MethodOptions; - - if (typeof paramsOrCallback === 'function') { - callback = paramsOrCallback; - params = {} as Params$Resource$Projects$Getonboardingstate; - options = {}; - } - - if (typeof optionsOrCallback === 'function') { - callback = optionsOrCallback; - options = {}; - } - - const rootUrl = - options.rootUrl || 'https://securitycenter.googleapis.com/'; - const parameters = { - options: Object.assign( - { - url: (rootUrl + '/v1beta2/{+name}').replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', - }, - options - ), - params, - requiredParams: ['name'], - pathParams: ['name'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Get the RapidVulnerabilityDetectionSettings resource. In the returned settings response, a missing field only indicates that it was not explicitly set, so no assumption should be made about these fields. In other words, GetRapidVulnerabilityDetectionSettings does not calculate the effective service settings for the resource, which accounts for inherited settings and defaults. Instead, use CalculateRapidVulnerabilityDetectionSettings for this purpose. * @@ -7609,13 +7388,6 @@ export namespace securitycenter_v1beta2 { */ name?: string; } - export interface Params$Resource$Projects$Getonboardingstate - extends StandardParameters { - /** - * Required. The name of the OnboardingState to retrieve. Formats: * organizations/{organization\}/onboardingState * folders/{folder\}/onboardingState * projects/{project\}/onboardingState - */ - name?: string; - } export interface Params$Resource$Projects$Getrapidvulnerabilitydetectionsettings extends StandardParameters { /** diff --git a/src/apis/spanner/v1.ts b/src/apis/spanner/v1.ts index 98601ec226..7c812a14e0 100644 --- a/src/apis/spanner/v1.ts +++ b/src/apis/spanner/v1.ts @@ -1504,7 +1504,7 @@ export namespace spanner_v1 { */ partitionOptions?: Schema$PartitionOptions; /** - * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. The query plan of a root partitionable query has a single distributed union operator. A distributed union operator conceptually divides one or more tables into multiple splits, remotely evaluates a subquery independently on each split, and then unions all results. This must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. + * Required. The query request to generate partitions for. The request will fail if the query is not root partitionable. For a query to be root partitionable, it needs to satisfy a few conditions. For example, the first operator in the query execution plan must be a distributed union operator. For more information about other conditions, see [Read data in parallel](https://cloud.google.com/spanner/docs/reads#read_data_in_parallel). The query request must not contain DML commands, such as INSERT, UPDATE, or DELETE. Use ExecuteStreamingSql with a PartitionedDml transaction for large, partition-friendly DML operations. */ sql?: string | null; /** @@ -7682,7 +7682,7 @@ export namespace spanner_v1 { } /** - * Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or result in additional rows if using generated or commit timestamp-based keys. We recommend structuring your mutation groups to be idempotent to avoid this issue. + * Batches the supplied mutation groups in a collection of efficient transactions. All mutations in a group are committed atomically. However, mutations across groups can be committed non-atomically in an unspecified order and thus, they must be independent of each other. Partial failure is possible, i.e., some groups may have been committed successfully, while some may have failed. The results of individual batches are streamed into the response as the batches are applied. BatchWrite requests are not replay protected, meaning that each mutation group may be applied more than once. Replays of non-idempotent mutations may have undesirable effects. For example, replays of an insert mutation may produce an already exists error or if you use generated or commit timestamp-based keys, it may result in additional rows being added to the mutation's table. We recommend structuring your mutation groups to be idempotent to avoid this issue. * * @param params - Parameters for request * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index cf345cedab..4529ad6569 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -758,6 +758,10 @@ export namespace storage_v1 { * The content generation of this object. Used for object versioning. */ generation?: string | null; + /** + * This is the time (in the future) when the soft-deleted object will no longer be restorable. It is equal to the soft delete time plus the current soft delete retention duration of the bucket. + */ + hardDeleteTime?: string | null; /** * The ID of the object, including the bucket name, object name, and generation number. */ @@ -810,6 +814,10 @@ export namespace storage_v1 { * Content-Length of the data in bytes. */ size?: string | null; + /** + * The time at which the object became soft-deleted in RFC 3339 format. + */ + softDeleteTime?: string | null; /** * Storage class of the object. */ @@ -823,7 +831,7 @@ export namespace storage_v1 { */ timeCreated?: string | null; /** - * The deletion time of the object in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. + * The time at which the object became noncurrent in RFC 3339 format. Will be returned if and only if this version of the object has been deleted. */ timeDeleted?: string | null; /** @@ -6342,6 +6350,10 @@ export namespace storage_v1 { * Name of the bucket in which the object resides. */ bucket?: string; + /** + * If true, copies the source object's ACL; otherwise, uses the bucket's default object ACL. The default is false. + */ + copySourceAcl?: boolean; /** * Selects a specific revision of this object. */ diff --git a/src/apis/tagmanager/v2.ts b/src/apis/tagmanager/v2.ts index 299a1dc6db..8a774e1726 100644 --- a/src/apis/tagmanager/v2.ts +++ b/src/apis/tagmanager/v2.ts @@ -680,6 +680,10 @@ export namespace tagmanager_v2 { * A workspace entity that may represent a tag, trigger, variable, or folder in addition to its status in the workspace. */ export interface Schema$Entity { + /** + * The built in variable being represented by the entity. + */ + builtInVariable?: Schema$BuiltInVariable; /** * Represents how the entity has been changed in the workspace. */ @@ -688,10 +692,18 @@ export namespace tagmanager_v2 { * The client being represented by the entity. */ client?: Schema$Client; + /** + * The custom template being represented by the entity. + */ + customTemplate?: Schema$CustomTemplate; /** * The folder being represented by the entity. */ folder?: Schema$Folder; + /** + * The gtag config being represented by the entity. + */ + gtagConfig?: Schema$GtagConfig; /** * The tag being represented by the entity. */ @@ -708,6 +720,10 @@ export namespace tagmanager_v2 { * The variable being represented by the entity. */ variable?: Schema$Variable; + /** + * The zone being represented by the entity. + */ + zone?: Schema$Zone; } /** * Represents a Google Tag Manager Environment. Note that a user can create, delete and update environments of type USER, but can only update the enable_debug and url fields of environments of other types. diff --git a/src/apis/translate/v3.ts b/src/apis/translate/v3.ts index 6974c8835d..10c0c07f34 100644 --- a/src/apis/translate/v3.ts +++ b/src/apis/translate/v3.ts @@ -159,7 +159,7 @@ export namespace translate_v3 { */ enableShadowRemovalNativePdf?: boolean | null; /** - * Optional. + * Optional. The file format conversion map that is applied to all input files. The map key is the original mime_type. The map value is the target mime_type of translated documents. Supported file format conversion includes: - `application/pdf` to `application/vnd.openxmlformats-officedocument.wordprocessingml.document` If nothing specified, output files will be in the same format as the original file. */ formatConversions?: {[key: string]: string} | null; /** diff --git a/src/apis/translate/v3beta1.ts b/src/apis/translate/v3beta1.ts index 76adf34233..d9c9855bc7 100644 --- a/src/apis/translate/v3beta1.ts +++ b/src/apis/translate/v3beta1.ts @@ -159,7 +159,7 @@ export namespace translate_v3beta1 { */ enableShadowRemovalNativePdf?: boolean | null; /** - * Optional. + * Optional. File format conversion map to be applied to all input files. Map's key is the original mime_type. Map's value is the target mime_type of translated documents. Supported file format conversion includes: - `application/pdf` to `application/vnd.openxmlformats-officedocument.wordprocessingml.document` If nothing specified, output files will be in the same format as the original file. */ formatConversions?: {[key: string]: string} | null; /** diff --git a/src/apis/vmwareengine/README.md b/src/apis/vmwareengine/README.md new file mode 100644 index 0000000000..7d626c6c58 --- /dev/null +++ b/src/apis/vmwareengine/README.md @@ -0,0 +1,37 @@ +Google Inc. logo + +# vmwareengine + +> The Google VMware Engine API lets you programmatically manage VMware environments. + +## Support status +**Note**: Google provides multiple libraries for this service. This library is in +maintenance mode, and will continue to be made available for users who have +existing applications. If you're building a new application, or modernizing a +legacy application, please use [@google-cloud/vmwareengine](https://www.npmjs.com/package/@google-cloud/vmwareengine) instead. +The [@google-cloud/vmwareengine](https://www.npmjs.com/package/@google-cloud/vmwareengine) library is faster, easier to use, and better maintained. + +To learn more, see [Client Libraries Explained](https://cloud.google.com/apis/docs/client-libraries-explained). + +## Installation + +```sh +$ npm install @googleapis/vmwareengine +``` + +## Usage +All documentation and usage information can be found on [GitHub](https://github.com/googleapis/google-api-nodejs-client). +Information on classes can be found in [Googleapis Documentation](https://googleapis.dev/nodejs/googleapis/latest/vmwareengine/classes/Vmwareengine.html). + +## License +This library is licensed under Apache 2.0. Full license text is available in [LICENSE](https://github.com/googleapis/google-api-nodejs-client/blob/main/LICENSE). + +## Contributing +We love contributions! Before submitting a Pull Request, it's always good to start with a new issue first. To learn more, see [CONTRIBUTING](https://github.com/google/google-api-nodejs-client/blob/main/.github/CONTRIBUTING.md). + +## Questions/problems? +* Ask your development related questions on [StackOverflow](http://stackoverflow.com/questions/tagged/google-api-nodejs-client). +* If you've found an bug/issue, please [file it on GitHub](https://github.com/googleapis/google-api-nodejs-client/issues). + + +*Crafted with ❤️ by the Google Node.js team* diff --git a/src/apis/vmwareengine/index.ts b/src/apis/vmwareengine/index.ts new file mode 100644 index 0000000000..ba77f88966 --- /dev/null +++ b/src/apis/vmwareengine/index.ts @@ -0,0 +1,46 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/*! THIS FILE IS AUTO-GENERATED */ + +import {AuthPlus, getAPI, GoogleConfigurable} from 'googleapis-common'; +import {vmwareengine_v1} from './v1'; + +export const VERSIONS = { + v1: vmwareengine_v1.Vmwareengine, +}; + +export function vmwareengine(version: 'v1'): vmwareengine_v1.Vmwareengine; +export function vmwareengine( + options: vmwareengine_v1.Options +): vmwareengine_v1.Vmwareengine; +export function vmwareengine( + this: GoogleConfigurable, + versionOrOptions: 'v1' | vmwareengine_v1.Options +) { + return getAPI('vmwareengine', versionOrOptions, VERSIONS, this); +} + +const auth = new AuthPlus(); +export {auth}; +export {vmwareengine_v1}; +export { + AuthPlus, + GlobalOptions, + APIRequestContext, + GoogleConfigurable, + StreamMethodOptions, + GaxiosPromise, + MethodOptions, + BodyResponseCallback, +} from 'googleapis-common'; diff --git a/src/apis/vmwareengine/package.json b/src/apis/vmwareengine/package.json new file mode 100644 index 0000000000..da50b63ca5 --- /dev/null +++ b/src/apis/vmwareengine/package.json @@ -0,0 +1,43 @@ +{ + "name": "@googleapis/vmwareengine", + "version": "0.1.0", + "description": "vmwareengine", + "main": "build/index.js", + "types": "build/index.d.ts", + "keywords": [ + "google" + ], + "author": "Google LLC", + "license": "Apache-2.0", + "homepage": "https://github.com/googleapis/google-api-nodejs-client", + "bugs": { + "url": "https://github.com/googleapis/google-api-nodejs-client/issues" + }, + "repository": { + "type": "git", + "url": "https://github.com/googleapis/google-api-nodejs-client.git" + }, + "engines": { + "node": ">=12.0.0" + }, + "scripts": { + "fix": "gts fix", + "lint": "gts check", + "compile": "tsc -p .", + "prepare": "npm run compile", + "webpack": "webpack" + }, + "dependencies": { + "googleapis-common": "^7.0.0" + }, + "devDependencies": { + "@microsoft/api-documenter": "^7.8.10", + "@microsoft/api-extractor": "^7.8.10", + "gts": "^5.0.0", + "null-loader": "^4.0.0", + "ts-loader": "^9.0.0", + "typescript": "~4.8.4", + "webpack": "^5.0.0", + "webpack-cli": "^5.0.0" + } +} diff --git a/src/apis/vmwareengine/tsconfig.json b/src/apis/vmwareengine/tsconfig.json new file mode 100644 index 0000000000..e081090496 --- /dev/null +++ b/src/apis/vmwareengine/tsconfig.json @@ -0,0 +1,10 @@ +{ + "extends": "./node_modules/gts/tsconfig-google.json", + "compilerOptions": { + "rootDir": ".", + "outDir": "build" + }, + "include": [ + "*.ts", + ] +} diff --git a/src/apis/vmwareengine/v1.ts b/src/apis/vmwareengine/v1.ts new file mode 100644 index 0000000000..e7e730833f --- /dev/null +++ b/src/apis/vmwareengine/v1.ts @@ -0,0 +1,6637 @@ +// Copyright 2020 Google LLC +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +/* eslint-disable @typescript-eslint/no-explicit-any */ +/* eslint-disable @typescript-eslint/no-unused-vars */ +/* eslint-disable @typescript-eslint/no-empty-interface */ +/* eslint-disable @typescript-eslint/no-namespace */ +/* eslint-disable no-irregular-whitespace */ + +import { + OAuth2Client, + JWT, + Compute, + UserRefreshClient, + BaseExternalAccountClient, + GaxiosPromise, + GoogleConfigurable, + createAPIRequest, + MethodOptions, + StreamMethodOptions, + GlobalOptions, + GoogleAuth, + BodyResponseCallback, + APIRequestContext, +} from 'googleapis-common'; +import {Readable} from 'stream'; + +export namespace vmwareengine_v1 { + export interface Options extends GlobalOptions { + version: 'v1'; + } + + interface StandardParameters { + /** + * Auth client or API Key for the request + */ + auth?: + | string + | OAuth2Client + | JWT + | Compute + | UserRefreshClient + | BaseExternalAccountClient + | GoogleAuth; + + /** + * V1 error format. + */ + '$.xgafv'?: string; + /** + * OAuth access token. + */ + access_token?: string; + /** + * Data format for response. + */ + alt?: string; + /** + * JSONP + */ + callback?: string; + /** + * Selector specifying which fields to include in a partial response. + */ + fields?: string; + /** + * 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. + */ + key?: string; + /** + * OAuth 2.0 token for the current user. + */ + oauth_token?: string; + /** + * Returns response with indentations and line breaks. + */ + prettyPrint?: boolean; + /** + * 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. + */ + quotaUser?: string; + /** + * Legacy upload protocol for media (e.g. "media", "multipart"). + */ + uploadType?: string; + /** + * Upload protocol for media (e.g. "raw", "multipart"). + */ + upload_protocol?: string; + } + + /** + * VMware Engine API + * + * The Google VMware Engine API lets you programmatically manage VMware environments. + * + * @example + * ```js + * const {google} = require('googleapis'); + * const vmwareengine = google.vmwareengine('v1'); + * ``` + */ + export class Vmwareengine { + context: APIRequestContext; + projects: Resource$Projects; + + constructor(options: GlobalOptions, google?: GoogleConfigurable) { + this.context = { + _options: options || {}, + google, + }; + + this.projects = new Resource$Projects(this.context); + } + } + + /** + * 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. + */ + export interface Schema$AuditConfig { + /** + * The configuration for logging of each type of permission. + */ + auditLogConfigs?: Schema$AuditLogConfig[]; + /** + * 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. + */ + service?: string | null; + } + /** + * 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. + */ + export interface Schema$AuditLogConfig { + /** + * Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members. + */ + exemptedMembers?: string[] | null; + /** + * The log type that this config enables. + */ + logType?: string | null; + } + /** + * Associates `members`, or principals, with a `role`. + */ + export interface Schema$Binding { + /** + * 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). + */ + condition?: Schema$Expr; + /** + * Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid\}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid\}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid\}.svc.id.goog[{namespace\}/{kubernetes-sa\}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid\}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain\}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `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. + */ + members?: string[] | null; + /** + * Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. + */ + role?: string | null; + } + /** + * A cluster in a private cloud. + */ + export interface Schema$Cluster { + /** + * Output only. Creation time of this resource. + */ + createTime?: string | null; + /** + * Output only. True if the cluster is a management cluster; false otherwise. There can only be one management cluster in a private cloud and it has to be the first one. + */ + management?: boolean | null; + /** + * Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + */ + name?: string | null; + /** + * Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). + */ + nodeTypeConfigs?: {[key: string]: Schema$NodeTypeConfig} | null; + /** + * Output only. State of the resource. + */ + state?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + } + /** + * Credentials for a private cloud. + */ + export interface Schema$Credentials { + /** + * Initial password. + */ + password?: string | null; + /** + * Initial username. + */ + username?: string | null; + } + /** + * 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); \} + */ + export interface Schema$Empty {} + /** + * 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. + */ + export interface Schema$Expr { + /** + * Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. + */ + description?: string | null; + /** + * Textual representation of an expression in Common Expression Language syntax. + */ + expression?: string | null; + /** + * Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. + */ + location?: string | null; + /** + * 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. + */ + title?: string | null; + } + /** + * Details about a HCX Cloud Manager appliance. + */ + export interface Schema$Hcx { + /** + * Fully qualified domain name of the appliance. + */ + fqdn?: string | null; + /** + * Internal IP address of the appliance. + */ + internalIp?: string | null; + /** + * Output only. The state of the appliance. + */ + state?: string | null; + /** + * Version of the appliance. + */ + version?: string | null; + } + /** + * HCX activation key. A default key is created during private cloud provisioning, but this behavior is subject to change and you should always verify active keys. Use VmwareEngine.ListHcxActivationKeys to retrieve existing keys and VmwareEngine.CreateHcxActivationKey to create new ones. + */ + export interface Schema$HcxActivationKey { + /** + * Output only. HCX activation key. + */ + activationKey?: string | null; + /** + * Output only. Creation time of HCX activation key. + */ + createTime?: string | null; + /** + * Output only. The resource name of this HcxActivationKey. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key` + */ + name?: string | null; + /** + * Output only. State of HCX activation key. + */ + state?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + } + /** + * Response message for VmwareEngine.ListClusters + */ + export interface Schema$ListClustersResponse { + /** + * A list of private cloud clusters. + */ + clusters?: Schema$Cluster[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * Response message for VmwareEngine.ListHcxActivationKeys + */ + export interface Schema$ListHcxActivationKeysResponse { + /** + * List of HCX activation keys. + */ + hcxActivationKeys?: Schema$HcxActivationKey[]; + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * The response message for Locations.ListLocations. + */ + export interface Schema$ListLocationsResponse { + /** + * A list of locations that matches the specified filter in the request. + */ + locations?: Schema$Location[]; + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + } + /** + * Response message for VmwareEngine.ListNetworkPolicies + */ + export interface Schema$ListNetworkPoliciesResponse { + /** + * A list of network policies. + */ + networkPolicies?: Schema$NetworkPolicy[]; + /** + * A token, which can be send as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * Response message for VmwareEngine.ListNodeTypes + */ + export interface Schema$ListNodeTypesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of Node Types. + */ + nodeTypes?: Schema$NodeType[]; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * The response message for Operations.ListOperations. + */ + export interface Schema$ListOperationsResponse { + /** + * The standard List next-page token. + */ + nextPageToken?: string | null; + /** + * A list of operations that matches the specified filter in the request. + */ + operations?: Schema$Operation[]; + } + /** + * Response message for VmwareEngine.ListPrivateClouds + */ + export interface Schema$ListPrivateCloudsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of private clouds. + */ + privateClouds?: Schema$PrivateCloud[]; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * Response message for VmwareEngine.ListPrivateConnectionPeeringRoutes + */ + export interface Schema$ListPrivateConnectionPeeringRoutesResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of peering routes. + */ + peeringRoutes?: Schema$PeeringRoute[]; + } + /** + * Response message for VmwareEngine.ListPrivateConnections + */ + export interface Schema$ListPrivateConnectionsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of private connections. + */ + privateConnections?: Schema$PrivateConnection[]; + /** + * Unreachable resources. + */ + unreachable?: string[] | null; + } + /** + * Response message for VmwareEngine.ListSubnets + */ + export interface Schema$ListSubnetsResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * A list of subnets. + */ + subnets?: Schema$Subnet[]; + /** + * Locations that could not be reached when making an aggregated query using wildcards. + */ + unreachable?: string[] | null; + } + /** + * Response message for VmwareEngine.ListVmwareEngineNetworks + */ + export interface Schema$ListVmwareEngineNetworksResponse { + /** + * A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. + */ + nextPageToken?: string | null; + /** + * Unreachable resources. + */ + unreachable?: string[] | null; + /** + * A list of VMware Engine networks. + */ + vmwareEngineNetworks?: Schema$VmwareEngineNetwork[]; + } + /** + * A resource that represents a Google Cloud location. + */ + export interface Schema$Location { + /** + * The friendly name for this location, typically a nearby city name. For example, "Tokyo". + */ + displayName?: string | null; + /** + * Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"\} + */ + labels?: {[key: string]: string} | null; + /** + * The canonical id for this location. For example: `"us-east1"`. + */ + locationId?: string | null; + /** + * Service-specific metadata. For example the available capacity at the given location. + */ + metadata?: {[key: string]: any} | null; + /** + * Resource name for the location, which may vary between implementations. For example: `"projects/example-project/locations/us-east1"` + */ + name?: string | null; + } + /** + * Management cluster configuration. + */ + export interface Schema$ManagementCluster { + /** + * Required. The user-provided identifier of the new `Cluster`. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + clusterId?: string | null; + /** + * Required. The map of cluster node types in this cluster, where the key is canonical identifier of the node type (corresponds to the `NodeType`). + */ + nodeTypeConfigs?: {[key: string]: Schema$NodeTypeConfig} | null; + } + /** + * Network configuration in the consumer project with which the peering has to be done. + */ + export interface Schema$NetworkConfig { + /** + * Required. Management CIDR used by VMware management appliances. + */ + managementCidr?: string | null; + /** + * Output only. The IP address layout version of the management IP address range. Possible versions include: * `managementIpAddressLayoutVersion=1`: Indicates the legacy IP address layout used by some existing private clouds. This is no longer supported for new private clouds as it does not support all features. * `managementIpAddressLayoutVersion=2`: Indicates the latest IP address layout used by all newly created private clouds. This version supports all current features. + */ + managementIpAddressLayoutVersion?: number | null; + /** + * Optional. The relative resource name of the VMware Engine network attached to the private cloud. Specify the name in the following form: `projects/{project\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` where `{project\}` can either be a project number or a project ID. + */ + vmwareEngineNetwork?: string | null; + /** + * Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` + */ + vmwareEngineNetworkCanonical?: string | null; + } + /** + * Represents a network policy resource. Network policies are regional resources. You can use a network policy to enable or disable internet access and external IP access. Network policies are associated with a VMware Engine network, which might span across regions. For a given region, a network policy applies to all private clouds in the VMware Engine network associated with the policy. + */ + export interface Schema$NetworkPolicy { + /** + * Output only. Creation time of this resource. + */ + createTime?: string | null; + /** + * Optional. User-provided description for this network policy. + */ + description?: string | null; + /** + * Required. IP address range in CIDR notation used to create internet access and external IP access. An RFC 1918 CIDR block, with a "/26" prefix, is required. The range cannot overlap with any prefixes either in the consumer VPC network or in use by the private clouds attached to that VPC network. + */ + edgeServicesCidr?: string | null; + /** + * Network service that allows External IP addresses to be assigned to VMware workloads. This service can only be enabled when `internet_access` is also enabled. + */ + externalIp?: Schema$NetworkService; + /** + * Network service that allows VMware workloads to access the internet. + */ + internetAccess?: Schema$NetworkService; + /** + * Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + */ + name?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + /** + * Optional. The relative resource name of the VMware Engine network. Specify the name in the following form: `projects/{project\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` where `{project\}` can either be a project number or a project ID. + */ + vmwareEngineNetwork?: string | null; + /** + * Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` + */ + vmwareEngineNetworkCanonical?: string | null; + } + /** + * Represents a network service that is managed by a `NetworkPolicy` resource. A network service provides a way to control an aspect of external access to VMware workloads. For example, whether the VMware workloads in the private clouds governed by a network policy can access or be accessed from the internet. + */ + export interface Schema$NetworkService { + /** + * True if the service is enabled; false otherwise. + */ + enabled?: boolean | null; + /** + * Output only. State of the service. New values may be added to this enum when appropriate. + */ + state?: string | null; + } + /** + * Describes node type. + */ + export interface Schema$NodeType { + /** + * Output only. List of possible values of custom core count. + */ + availableCustomCoreCounts?: number[] | null; + /** + * Output only. The amount of storage available, defined in GB. + */ + diskSizeGb?: number | null; + /** + * Output only. The friendly name for this node type. For example: ve1-standard-72 + */ + displayName?: string | null; + /** + * Output only. The amount of physical memory available, defined in GB. + */ + memoryGb?: number | null; + /** + * Output only. The resource name of this node type. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72` + */ + name?: string | null; + /** + * Output only. The canonical identifier of the node type (corresponds to the `NodeType`). For example: standard-72. + */ + nodeTypeId?: string | null; + /** + * Output only. The total number of CPU cores in a single node. + */ + totalCoreCount?: number | null; + /** + * Output only. The total number of virtual CPUs in a single node. + */ + virtualCpuCount?: number | null; + } + /** + * Information about the type and number of nodes associated with the cluster. + */ + export interface Schema$NodeTypeConfig { + /** + * Optional. Customized number of cores available to each node of the type. This number must always be one of `nodeType.availableCustomCoreCounts`. If zero is provided max value from `nodeType.availableCustomCoreCounts` will be used. + */ + customCoreCount?: number | null; + /** + * Required. The number of nodes of this type in the cluster + */ + nodeCount?: number | null; + } + /** + * Details about a NSX Manager appliance. + */ + export interface Schema$Nsx { + /** + * Fully qualified domain name of the appliance. + */ + fqdn?: string | null; + /** + * Internal IP address of the appliance. + */ + internalIp?: string | null; + /** + * Output only. The state of the appliance. + */ + state?: string | null; + /** + * Version of the appliance. + */ + version?: string | null; + } + /** + * This resource represents a long-running operation that is the result of a network API call. + */ + export interface Schema$Operation { + /** + * 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. + */ + done?: boolean | null; + /** + * The error result of the operation in case of failure or cancellation. + */ + error?: Schema$Status; + /** + * 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. + */ + metadata?: {[key: string]: any} | null; + /** + * 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\}`. + */ + name?: string | null; + /** + * The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. + */ + response?: {[key: string]: any} | null; + } + /** + * Represents the metadata of the long-running operation. + */ + export interface Schema$OperationMetadata { + /** + * Output only. API version used to start the operation. + */ + apiVersion?: string | null; + /** + * Output only. The time the operation was created. + */ + createTime?: string | null; + /** + * Output only. The time the operation finished running. + */ + endTime?: string | null; + /** + * Output only. True if the user has requested cancellation of the operation; false otherwise. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. + */ + requestedCancellation?: boolean | null; + /** + * Output only. Human-readable status of the operation, if any. + */ + statusMessage?: string | null; + /** + * Output only. Server-defined resource path for the target of the operation. + */ + target?: string | null; + /** + * Output only. Name of the verb executed by the operation. + */ + verb?: string | null; + } + /** + * Exchanged network peering route. + */ + export interface Schema$PeeringRoute { + /** + * Output only. Destination range of the peering route in CIDR notation. + */ + destRange?: string | null; + /** + * Output only. Direction of the routes exchanged with the peer network, from the VMware Engine network perspective: * Routes of direction `INCOMING` are imported from the peer network. * Routes of direction `OUTGOING` are exported from the intranet VPC network of the VMware Engine network. + */ + direction?: string | null; + /** + * Output only. True if the peering route has been imported from a peered VPC network; false otherwise. The import happens if the field `NetworkPeering.importCustomRoutes` is true for this network, `NetworkPeering.exportCustomRoutes` is true for the peer VPC network, and the import does not result in a route conflict. + */ + imported?: boolean | null; + /** + * Output only. Region containing the next hop of the peering route. This field only applies to dynamic routes in the peer VPC network. + */ + nextHopRegion?: string | null; + /** + * Output only. The priority of the peering route. + */ + priority?: string | null; + /** + * Output only. Type of the route in the peer VPC network. + */ + type?: string | null; + } + /** + * 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/). + */ + export interface Schema$Policy { + /** + * Specifies cloud audit logging configuration for this policy. + */ + auditConfigs?: Schema$AuditConfig[]; + /** + * 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`. + */ + bindings?: Schema$Binding[]; + /** + * `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. + */ + etag?: string | null; + /** + * 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). + */ + version?: number | null; + } + /** + * Represents a private cloud resource. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional. + */ + export interface Schema$PrivateCloud { + /** + * Output only. Creation time of this resource. + */ + createTime?: string | null; + /** + * Output only. Time when the resource was scheduled for deletion. + */ + deleteTime?: string | null; + /** + * User-provided description for this private cloud. + */ + description?: string | null; + /** + * Output only. Time when the resource will be irreversibly deleted. + */ + expireTime?: string | null; + /** + * Output only. HCX appliance. + */ + hcx?: Schema$Hcx; + /** + * Required. Input only. The management cluster for this private cloud. This field is required during creation of the private cloud to provide details for the default cluster. The following fields can't be changed after private cloud creation: `ManagementCluster.clusterId`, `ManagementCluster.nodeTypeId`. + */ + managementCluster?: Schema$ManagementCluster; + /** + * Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + name?: string | null; + /** + * Required. Network configuration of the private cloud. + */ + networkConfig?: Schema$NetworkConfig; + /** + * Output only. NSX appliance. + */ + nsx?: Schema$Nsx; + /** + * Output only. State of the resource. New values may be added to this enum when appropriate. + */ + state?: string | null; + /** + * Optional. Type of the private cloud. Defaults to STANDARD. + */ + type?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + /** + * Output only. Vcenter appliance. + */ + vcenter?: Schema$Vcenter; + } + /** + * Private connection resource that provides connectivity for VMware Engine private clouds. + */ + export interface Schema$PrivateConnection { + /** + * Output only. Creation time of this resource. + */ + createTime?: string | null; + /** + * Optional. User-provided description for this private connection. + */ + description?: string | null; + /** + * Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection` + */ + name?: string | null; + /** + * Output only. VPC network peering id between given network VPC and VMwareEngineNetwork. + */ + peeringId?: string | null; + /** + * Output only. Peering state between service network and VMware Engine network. + */ + peeringState?: string | null; + /** + * Optional. Routing Mode. Default value is set to GLOBAL. For type = PRIVATE_SERVICE_ACCESS, this field can be set to GLOBAL or REGIONAL, for other types only GLOBAL is supported. + */ + routingMode?: string | null; + /** + * Required. Service network to create private connection. Specify the name in the following form: `projects/{project\}/global/networks/{network_id\}` For type = PRIVATE_SERVICE_ACCESS, this field represents servicenetworking VPC, e.g. projects/project-tp/global/networks/servicenetworking. For type = NETAPP_CLOUD_VOLUME, this field represents NetApp service VPC, e.g. projects/project-tp/global/networks/netapp-tenant-vpc. For type = DELL_POWERSCALE, this field represent Dell service VPC, e.g. projects/project-tp/global/networks/dell-tenant-vpc. For type= THIRD_PARTY_SERVICE, this field could represent a consumer VPC or any other producer VPC to which the VMware Engine Network needs to be connected, e.g. projects/project/global/networks/vpc. + */ + serviceNetwork?: string | null; + /** + * Output only. State of the private connection. + */ + state?: string | null; + /** + * Required. Private connection type. + */ + type?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + /** + * Required. The relative resource name of Legacy VMware Engine network. Specify the name in the following form: `projects/{project\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` where `{project\}`, `{location\}` will be same as specified in private connection resource name and `{vmware_engine_network_id\}` will be in the form of `{location\}`-default e.g. projects/project/locations/us-central1/vmwareEngineNetworks/us-central1-default. + */ + vmwareEngineNetwork?: string | null; + /** + * Output only. The canonical name of the VMware Engine network in the form: `projects/{project_number\}/locations/{location\}/vmwareEngineNetworks/{vmware_engine_network_id\}` + */ + vmwareEngineNetworkCanonical?: string | null; + } + /** + * Request message for VmwareEngine.ResetNsxCredentials + */ + export interface Schema$ResetNsxCredentialsRequest { + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Request message for VmwareEngine.ResetVcenterCredentials + */ + export interface Schema$ResetVcenterCredentialsRequest { + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Request message for `SetIamPolicy` method. + */ + export interface Schema$SetIamPolicyRequest { + /** + * 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. + */ + policy?: Schema$Policy; + /** + * 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"` + */ + updateMask?: string | null; + } + /** + * 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). + */ + export interface Schema$Status { + /** + * The status code, which should be an enum value of google.rpc.Code. + */ + code?: number | null; + /** + * A list of messages that carry the error details. There is a common set of message types for APIs to use. + */ + details?: Array<{[key: string]: any}> | null; + /** + * 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. + */ + message?: string | null; + } + /** + * Subnet in a private cloud. Either `management` subnets (such as vMotion) that are read-only, or `userDefined`, which can also be updated. + */ + export interface Schema$Subnet { + /** + * The IP address of the gateway of this subnet. Must fall within the IP prefix defined above. + */ + gatewayIp?: string | null; + /** + * The IP address range of the subnet in CIDR format '10.0.0.0/24'. + */ + ipCidrRange?: string | null; + /** + * Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` + */ + name?: string | null; + /** + * Output only. The state of the resource. + */ + state?: string | null; + /** + * Output only. The type of the subnet. For example "management" or "userDefined". + */ + type?: string | null; + } + /** + * Request message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsRequest { + /** + * 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). + */ + permissions?: string[] | null; + } + /** + * Response message for `TestIamPermissions` method. + */ + export interface Schema$TestIamPermissionsResponse { + /** + * A subset of `TestPermissionsRequest.permissions` that the caller is allowed. + */ + permissions?: string[] | null; + } + /** + * Request message for VmwareEngine.UndeletePrivateCloud + */ + export interface Schema$UndeletePrivateCloudRequest { + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string | null; + } + /** + * Details about a vCenter Server management appliance. + */ + export interface Schema$Vcenter { + /** + * Fully qualified domain name of the appliance. + */ + fqdn?: string | null; + /** + * Internal IP address of the appliance. + */ + internalIp?: string | null; + /** + * Output only. The state of the appliance. + */ + state?: string | null; + /** + * Version of the appliance. + */ + version?: string | null; + } + /** + * VMware Engine network resource that provides connectivity for VMware Engine private clouds. + */ + export interface Schema$VmwareEngineNetwork { + /** + * Output only. Creation time of this resource. + */ + createTime?: string | null; + /** + * User-provided description for this VMware Engine network. + */ + description?: string | null; + /** + * Checksum that may be sent on update and delete requests to ensure that the user-provided value is up to date before the server processes a request. The server computes checksums based on the value of other fields in the request. + */ + etag?: string | null; + /** + * Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + */ + name?: string | null; + /** + * Output only. State of the VMware Engine network. + */ + state?: string | null; + /** + * Required. VMware Engine network type. + */ + type?: string | null; + /** + * Output only. System-generated unique identifier for the resource. + */ + uid?: string | null; + /** + * Output only. Last update time of this resource. + */ + updateTime?: string | null; + /** + * Output only. VMware Engine service VPC networks that provide connectivity from a private cloud to customer projects, the internet, and other Google Cloud services. + */ + vpcNetworks?: Schema$VpcNetwork[]; + } + /** + * Represents a VMware Engine VPC network that is managed by a VMware Engine network resource. + */ + export interface Schema$VpcNetwork { + /** + * Output only. The relative resource name of the service VPC network this VMware Engine network is attached to. For example: `projects/123123/global/networks/my-network` + */ + network?: string | null; + /** + * Output only. Type of VPC network (INTRANET, INTERNET, or GOOGLE_CLOUD) + */ + type?: string | null; + } + + export class Resource$Projects { + context: APIRequestContext; + locations: Resource$Projects$Locations; + constructor(context: APIRequestContext) { + this.context = context; + this.locations = new Resource$Projects$Locations(this.context); + } + } + + export class Resource$Projects$Locations { + context: APIRequestContext; + networkPolicies: Resource$Projects$Locations$Networkpolicies; + nodeTypes: Resource$Projects$Locations$Nodetypes; + operations: Resource$Projects$Locations$Operations; + privateClouds: Resource$Projects$Locations$Privateclouds; + privateConnections: Resource$Projects$Locations$Privateconnections; + vmwareEngineNetworks: Resource$Projects$Locations$Vmwareenginenetworks; + constructor(context: APIRequestContext) { + this.context = context; + this.networkPolicies = new Resource$Projects$Locations$Networkpolicies( + this.context + ); + this.nodeTypes = new Resource$Projects$Locations$Nodetypes(this.context); + this.operations = new Resource$Projects$Locations$Operations( + this.context + ); + this.privateClouds = new Resource$Projects$Locations$Privateclouds( + this.context + ); + this.privateConnections = + new Resource$Projects$Locations$Privateconnections(this.context); + this.vmwareEngineNetworks = + new Resource$Projects$Locations$Vmwareenginenetworks(this.context); + } + + /** + * Gets information about a location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists information about the supported locations for this service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/locations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Get + extends StandardParameters { + /** + * Resource name for the location. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$List + extends StandardParameters { + /** + * 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). + */ + filter?: string; + /** + * The resource that owns the locations collection, if applicable. + */ + name?: string; + /** + * The maximum number of results to return. If not set, the service selects a default. + */ + pageSize?: number; + /** + * A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Networkpolicies { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new network policy in a given VMware Engine network of a project and location (region). A new network policy cannot be created if another network policy already exists in the same scope. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Networkpolicies$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Networkpolicies$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Networkpolicies$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Networkpolicies$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Networkpolicies$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Networkpolicies$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Networkpolicies$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Networkpolicies$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/networkPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a `NetworkPolicy` resource. A network policy cannot be deleted when `NetworkService.state` is set to `RECONCILING` for either its external IP or internet access service. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Networkpolicies$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Networkpolicies$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Networkpolicies$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Networkpolicies$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Networkpolicies$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Networkpolicies$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Networkpolicies$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Networkpolicies$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `NetworkPolicy` resource by its resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Networkpolicies$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Networkpolicies$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Networkpolicies$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Networkpolicies$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Networkpolicies$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Networkpolicies$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Networkpolicies$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Networkpolicies$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `NetworkPolicy` resources in a specified project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Networkpolicies$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Networkpolicies$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Networkpolicies$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Networkpolicies$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Networkpolicies$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Networkpolicies$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Networkpolicies$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Networkpolicies$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/networkPolicies').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Modifies a `NetworkPolicy` resource. Only the following fields can be updated: `internet_access`, `external_ip`, `edge_services_cidr`. Only fields specified in `updateMask` are applied. When updating a network policy, the external IP network service can only be disabled if there are no external IP addresses present in the scope of the policy. Also, a `NetworkService` cannot be updated when `NetworkService.state` is set to `RECONCILING`. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Networkpolicies$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Networkpolicies$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Networkpolicies$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Networkpolicies$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Networkpolicies$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Networkpolicies$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Networkpolicies$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Networkpolicies$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Networkpolicies$Create + extends StandardParameters { + /** + * Required. The user-provided identifier of the network policy to be created. This identifier must be unique within parent `projects/{my-project\}/locations/{us-central1\}/networkPolicies` and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + networkPolicyId?: string; + /** + * Required. The resource name of the location (region) to create the new network policy in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1` + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkPolicy; + } + export interface Params$Resource$Projects$Locations$Networkpolicies$Delete + extends StandardParameters { + /** + * Required. The resource name of the network policy to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Networkpolicies$Get + extends StandardParameters { + /** + * Required. The resource name of the network policy to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Networkpolicies$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of network policies, you can exclude the ones named `example-policy` by specifying `name != "example-policy"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-policy") (createTime \> "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-policy-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "example-policy-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of network policies to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListNetworkPolicies` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNetworkPolicies` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the location (region) to query for network policies. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Networkpolicies$Patch + extends StandardParameters { + /** + * Output only. The resource name of this network policy. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/networkPolicies/my-network-policy` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the `NetworkPolicy` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$NetworkPolicy; + } + + export class Resource$Projects$Locations$Nodetypes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single `NodeType`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Nodetypes$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Nodetypes$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Nodetypes$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nodetypes$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Nodetypes$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nodetypes$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nodetypes$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nodetypes$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists node types + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Nodetypes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Nodetypes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Nodetypes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nodetypes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Nodetypes$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Nodetypes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Nodetypes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Nodetypes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/nodeTypes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Nodetypes$Get + extends StandardParameters { + /** + * Required. The resource name of the node type to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-proj/locations/us-central1-a/nodeTypes/standard-72` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Nodetypes$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of node types, you can exclude the ones named `standard-72` by specifying `name != "standard-72"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "standard-72") (virtual_cpu_count \> 2) ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "standard-96") AND (virtual_cpu_count \> 2) OR (name = "standard-72") ``` + */ + filter?: string; + /** + * The maximum number of node types to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListNodeTypes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListNodeTypes` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the location to be queried for node types. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Operations { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Operations$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Operations$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Operations$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Operations$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Operations$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Operations$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Operations$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Operations$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Operations$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}/operations').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Operations$Delete + extends StandardParameters { + /** + * The name of the operation resource to be deleted. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$Get + extends StandardParameters { + /** + * The name of the operation resource. + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Operations$List + extends StandardParameters { + /** + * The standard list filter. + */ + filter?: string; + /** + * The name of the operation's parent resource. + */ + name?: string; + /** + * The standard list page size. + */ + pageSize?: number; + /** + * The standard list page token. + */ + pageToken?: string; + } + + export class Resource$Projects$Locations$Privateclouds { + context: APIRequestContext; + clusters: Resource$Projects$Locations$Privateclouds$Clusters; + hcxActivationKeys: Resource$Projects$Locations$Privateclouds$Hcxactivationkeys; + subnets: Resource$Projects$Locations$Privateclouds$Subnets; + constructor(context: APIRequestContext) { + this.context = context; + this.clusters = new Resource$Projects$Locations$Privateclouds$Clusters( + this.context + ); + this.hcxActivationKeys = + new Resource$Projects$Locations$Privateclouds$Hcxactivationkeys( + this.context + ); + this.subnets = new Resource$Projects$Locations$Privateclouds$Subnets( + this.context + ); + } + + /** + * Creates a new `PrivateCloud` resource in a given project and location. Private clouds of type `STANDARD` and `TIME_LIMITED` are zonal resources, `STRETCHED` private clouds are regional. Creating a private cloud also creates a [management cluster](https://cloud.google.com/vmware-engine/docs/concepts-vmware-components) for that private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Privateclouds$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Privateclouds$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Privateclouds$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/privateClouds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Schedules a `PrivateCloud` resource for deletion. A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` set to `DELETED` and `expireTime` set to the time when deletion is final and can no longer be reversed. The delete operation is marked as done as soon as the `PrivateCloud` is successfully scheduled for deletion (this also applies when `delayHours` is set to zero), and the operation is not kept in pending state until `PrivateCloud` is purged. `PrivateCloud` can be restored using `UndeletePrivateCloud` method before the `expireTime` elapses. When `expireTime` is reached, deletion is final and all private cloud resources are irreversibly removed and billing stops. During the final removal process, `PrivateCloud.state` is set to `PURGING`. `PrivateCloud` can be polled using standard `GET` method for the whole period of deletion and purging. It will not be returned only when it is completely purged. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Privateclouds$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Privateclouds$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `PrivateCloud` resource by its resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Privateclouds$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateclouds$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Privateclouds$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `PrivateCloud` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateclouds$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateclouds$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateclouds$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Privateclouds$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/privateClouds').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Privateclouds$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Privateclouds$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resets credentials of the NSX appliance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resetNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials, + options: StreamMethodOptions + ): GaxiosPromise; + resetNsxCredentials( + params?: Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials, + options?: MethodOptions + ): GaxiosPromise; + resetNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials, + callback: BodyResponseCallback + ): void; + resetNsxCredentials(callback: BodyResponseCallback): void; + resetNsxCredentials( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+privateCloud}:resetNsxCredentials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['privateCloud'], + pathParams: ['privateCloud'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Resets credentials of the Vcenter appliance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + resetVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials, + options: StreamMethodOptions + ): GaxiosPromise; + resetVcenterCredentials( + params?: Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials, + options?: MethodOptions + ): GaxiosPromise; + resetVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + resetVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials, + callback: BodyResponseCallback + ): void; + resetVcenterCredentials( + callback: BodyResponseCallback + ): void; + resetVcenterCredentials( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+privateCloud}:resetVcenterCredentials' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + }, + options + ), + params, + requiredParams: ['privateCloud'], + pathParams: ['privateCloud'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of credentials for NSX appliance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials, + options: StreamMethodOptions + ): GaxiosPromise; + showNsxCredentials( + params?: Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials, + options?: MethodOptions + ): GaxiosPromise; + showNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showNsxCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials, + callback: BodyResponseCallback + ): void; + showNsxCredentials( + callback: BodyResponseCallback + ): void; + showNsxCredentials( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+privateCloud}:showNsxCredentials').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['privateCloud'], + pathParams: ['privateCloud'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets details of credentials for Vcenter appliance. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + showVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials, + options: StreamMethodOptions + ): GaxiosPromise; + showVcenterCredentials( + params?: Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials, + options?: MethodOptions + ): GaxiosPromise; + showVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + showVcenterCredentials( + params: Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials, + callback: BodyResponseCallback + ): void; + showVcenterCredentials( + callback: BodyResponseCallback + ): void; + showVcenterCredentials( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/v1/{+privateCloud}:showVcenterCredentials' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['privateCloud'], + pathParams: ['privateCloud'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Privateclouds$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Restores a private cloud that was previously scheduled for deletion by `DeletePrivateCloud`. A `PrivateCloud` resource scheduled for deletion has `PrivateCloud.state` set to `DELETED` and `PrivateCloud.expireTime` set to the time when deletion can no longer be reversed. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + undelete( + params: Params$Resource$Projects$Locations$Privateclouds$Undelete, + options: StreamMethodOptions + ): GaxiosPromise; + undelete( + params?: Params$Resource$Projects$Locations$Privateclouds$Undelete, + options?: MethodOptions + ): GaxiosPromise; + undelete( + params: Params$Resource$Projects$Locations$Privateclouds$Undelete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Privateclouds$Undelete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + undelete( + params: Params$Resource$Projects$Locations$Privateclouds$Undelete, + callback: BodyResponseCallback + ): void; + undelete(callback: BodyResponseCallback): void; + undelete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Undelete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Undelete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Undelete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}:undelete').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateclouds$Create + extends StandardParameters { + /** + * Required. The resource name of the location to create the new private cloud in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a` + */ + parent?: string; + /** + * Required. The user-provided identifier of the private cloud to be created. This identifier must be unique among each `PrivateCloud` within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + privateCloudId?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. True if you want the request to be validated and not executed; false otherwise. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$PrivateCloud; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Delete + extends StandardParameters { + /** + * Optional. Time delay of the deletion specified in hours. The default value is `3`. Specifying a non-zero value for this field changes the value of `PrivateCloud.state` to `DELETED` and sets `expire_time` to the planned deletion time. Deletion can be cancelled before `expire_time` elapses using VmwareEngine.UndeletePrivateCloud. Specifying a value of `0` for this field instead begins the deletion process and ceases billing immediately. During the final deletion process, the value of `PrivateCloud.state` becomes `PURGING`. + */ + delayHours?: number; + /** + * Optional. If set to true, cascade delete is enabled and all children of this private cloud resource are also deleted. When this flag is set to false, the private cloud will not be deleted if there are any children other than the management cluster. The management cluster is always deleted. + */ + force?: boolean; + /** + * Required. The resource name of the private cloud to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + name?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Get + extends StandardParameters { + /** + * Required. The resource name of the private cloud to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of private clouds, you can exclude the ones named `example-pc` by specifying `name != "example-pc"`. You can also filter nested fields. For example, you could specify `networkConfig.managementCidr = "192.168.0.0/24"` to include private clouds only if they have a matching address in their network configuration. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-pc") (createTime \> "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "private-cloud-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "private-cloud-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of private clouds to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListPrivateClouds` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateClouds` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the private cloud to be queried for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Patch + extends StandardParameters { + /** + * Output only. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + name?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PrivateCloud; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Resetnsxcredentials + extends StandardParameters { + /** + * Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + privateCloud?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetNsxCredentialsRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Resetvcentercredentials + extends StandardParameters { + /** + * Required. The resource name of the private cloud to reset credentials for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + privateCloud?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$ResetVcenterCredentialsRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Setiampolicy + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Shownsxcredentials + extends StandardParameters { + /** + * Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + privateCloud?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Showvcentercredentials + extends StandardParameters { + /** + * Required. The resource name of the private cloud to be queried for credentials. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + privateCloud?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Testiampermissions + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Undelete + extends StandardParameters { + /** + * Required. The resource name of the private cloud scheduled for deletion. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + name?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$UndeletePrivateCloudRequest; + } + + export class Resource$Projects$Locations$Privateclouds$Clusters { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new cluster in a given private cloud. Creating a new cluster provides additional nodes for use in the parent private cloud and requires sufficient [node quota](https://cloud.google.com/vmware-engine/quotas). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a `Cluster` resource. To avoid unintended data loss, migrate or gracefully shut down any workloads running on the cluster before deletion. You cannot delete the management cluster of a private cloud using this method. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `Cluster` resource by its resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `Cluster` resources in a given private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/clusters').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Modifies a `Cluster` resource. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Create + extends StandardParameters { + /** + * Required. The user-provided identifier of the new `Cluster`. This identifier must be unique among clusters within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + clusterId?: string; + /** + * Required. The resource name of the private cloud to create a new cluster in. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + parent?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Optional. True if you want the request to be validated and not executed; false otherwise. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Delete + extends StandardParameters { + /** + * Required. The resource name of the cluster to delete. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + */ + name?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Get + extends StandardParameters { + /** + * Required. The cluster resource name to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$List + extends StandardParameters { + /** + * To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-cluster") (nodeCount = "3") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-cluster-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "example-cluster-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of clusters to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListClusters` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListClusters` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the private cloud to query for clusters. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Patch + extends StandardParameters { + /** + * Output only. The resource name of this cluster. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/clusters/my-cluster` + */ + name?: string; + /** + * Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the `Cluster` resource by the update. The fields specified in the `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + /** + * Optional. True if you want the request to be validated and not executed; false otherwise. + */ + validateOnly?: boolean; + + /** + * Request body metadata + */ + requestBody?: Schema$Cluster; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Setiampolicy + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Clusters$Testiampermissions + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Privateclouds$Hcxactivationkeys { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new HCX activation key in a given private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hcxActivationKeys').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `HcxActivationKey` resource by its resource name. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + getIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy, + options?: MethodOptions + ): GaxiosPromise; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + getIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy, + callback: BodyResponseCallback + ): void; + getIamPolicy(callback: BodyResponseCallback): void; + getIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:getIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `HcxActivationKey` resources in a given private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/hcxActivationKeys').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy, + options: StreamMethodOptions + ): GaxiosPromise; + setIamPolicy( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy, + options?: MethodOptions + ): GaxiosPromise; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + setIamPolicy( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy, + callback: BodyResponseCallback + ): void; + setIamPolicy(callback: BodyResponseCallback): void; + setIamPolicy( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:setIamPolicy').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * 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. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions, + options: StreamMethodOptions + ): GaxiosPromise; + testIamPermissions( + params?: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions, + options?: MethodOptions + ): GaxiosPromise; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + testIamPermissions( + params: Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions, + callback: BodyResponseCallback + ): void; + testIamPermissions( + callback: BodyResponseCallback + ): void; + testIamPermissions( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+resource}:testIamPermissions').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['resource'], + pathParams: ['resource'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Create + extends StandardParameters { + /** + * Required. The user-provided identifier of the `HcxActivationKey` to be created. This identifier must be unique among `HcxActivationKey` resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + hcxActivationKeyId?: string; + /** + * Required. The resource name of the private cloud to create the key for. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud` + */ + parent?: string; + /** + * A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$HcxActivationKey; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Get + extends StandardParameters { + /** + * Required. The resource name of the HCX activation key to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud/hcxActivationKeys/my-key` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Getiampolicy + extends StandardParameters { + /** + * 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). + */ + 'options.requestedPolicyVersion'?: number; + /** + * 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. + */ + resource?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$List + extends StandardParameters { + /** + * The maximum number of HCX activation keys to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListHcxActivationKeys` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListHcxActivationKeys` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the private cloud to be queried for HCX activation keys. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateClouds/my-cloud` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Setiampolicy + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$SetIamPolicyRequest; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Hcxactivationkeys$Testiampermissions + extends StandardParameters { + /** + * 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. + */ + resource?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$TestIamPermissionsRequest; + } + + export class Resource$Projects$Locations$Privateclouds$Subnets { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets details of a single subnet. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateclouds$Subnets$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Subnets$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Subnets$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Subnets$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists subnets in a given private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateclouds$Subnets$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Subnets$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Subnets$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Subnets$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/subnets').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Updates the parameters of a single subnet. Only fields specified in `update_mask` are applied. *Note*: This API is synchronous and always returns a successful `google.longrunning.Operation` (LRO). The returned LRO will only have `done` and `response` fields. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateclouds$Subnets$Get + extends StandardParameters { + /** + * Required. The resource name of the subnet to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Subnets$List + extends StandardParameters { + /** + * The maximum number of subnets to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListSubnetsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSubnetsRequest` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the private cloud to be queried for subnets. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateclouds$Subnets$Patch + extends StandardParameters { + /** + * Output only. The resource name of this subnet. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud/subnets/my-subnet` + */ + name?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the `Subnet` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$Subnet; + } + + export class Resource$Projects$Locations$Privateconnections { + context: APIRequestContext; + peeringRoutes: Resource$Projects$Locations$Privateconnections$Peeringroutes; + constructor(context: APIRequestContext) { + this.context = context; + this.peeringRoutes = + new Resource$Projects$Locations$Privateconnections$Peeringroutes( + this.context + ); + } + + /** + * Creates a new private connection that can be used for accessing private Clouds. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Privateconnections$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Privateconnections$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Privateconnections$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateconnections$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Privateconnections$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/privateConnections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a `PrivateConnection` resource. When a private connection is deleted for a VMware Engine network, the connected network becomes inaccessible to that VMware Engine network. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Privateconnections$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Privateconnections$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Privateconnections$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateconnections$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Privateconnections$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `PrivateConnection` resource by its resource name. The resource contains details of the private connection, such as connected network, routing mode and state. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Privateconnections$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Privateconnections$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Privateconnections$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateconnections$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Privateconnections$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `PrivateConnection` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateconnections$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateconnections$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateconnections$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateconnections$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateconnections$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/privateConnections').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Modifies a `PrivateConnection` resource. Only `description` and `routing_mode` fields can be updated. Only fields specified in `updateMask` are applied. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Privateconnections$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Privateconnections$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Privateconnections$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateconnections$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Privateconnections$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateconnections$Create + extends StandardParameters { + /** + * Required. The resource name of the location to create the new private connection in. Private connection is a regional resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1` + */ + parent?: string; + /** + * Required. The user-provided identifier of the new private connection. This identifier must be unique among private connection resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + privateConnectionId?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PrivateConnection; + } + export interface Params$Resource$Projects$Locations$Privateconnections$Delete + extends StandardParameters { + /** + * Required. The resource name of the private connection to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Privateconnections$Get + extends StandardParameters { + /** + * Required. The resource name of the private connection to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Privateconnections$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of private connections, you can exclude the ones named `example-connection` by specifying `name != "example-connection"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-connection") (createTime \> "2022-09-22T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-connection-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "example-connection-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of private connections to return in one page. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListPrivateConnections` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnections` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the location to query for private connections. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Privateconnections$Patch + extends StandardParameters { + /** + * Output only. The resource name of the private connection. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1/privateConnections/my-connection` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the `PrivateConnection` resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$PrivateConnection; + } + + export class Resource$Projects$Locations$Privateconnections$Peeringroutes { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Lists the private connection routes exchanged over a peering connection. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/peeringRoutes').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + } + + export interface Params$Resource$Projects$Locations$Privateconnections$Peeringroutes$List + extends StandardParameters { + /** + * The maximum number of peering routes to return in one page. The service may return fewer than this value. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListPrivateConnectionPeeringRoutes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrivateConnectionPeeringRoutes` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the private connection to retrieve peering routes from. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-west1/privateConnections/my-connection` + */ + parent?: string; + } + + export class Resource$Projects$Locations$Vmwareenginenetworks { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new VMware Engine network that can be used by a private cloud. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + create( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Create, + options: StreamMethodOptions + ): GaxiosPromise; + create( + params?: Params$Resource$Projects$Locations$Vmwareenginenetworks$Create, + options?: MethodOptions + ): GaxiosPromise; + create( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Create, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + create( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Create, + callback: BodyResponseCallback + ): void; + create(callback: BodyResponseCallback): void; + create( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vmwareenginenetworks$Create + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vmwareenginenetworks$Create; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vmwareenginenetworks$Create; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/vmwareEngineNetworks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Deletes a `VmwareEngineNetwork` resource. You can only delete a VMware Engine network after all resources that refer to it are deleted. For example, a private cloud, a network peering, and a network policy can all refer to the same VMware Engine network. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + delete( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete, + options: StreamMethodOptions + ): GaxiosPromise; + delete( + params?: Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete, + options?: MethodOptions + ): GaxiosPromise; + delete( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + delete( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete, + callback: BodyResponseCallback + ): void; + delete(callback: BodyResponseCallback): void; + delete( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'DELETE', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Retrieves a `VmwareEngineNetwork` resource by its resource name. The resource contains details of the VMware Engine network, such as its VMware Engine network type, peered networks in a service project, and state (for example, `CREATING`, `ACTIVE`, `DELETING`). + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + get( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Get, + options: StreamMethodOptions + ): GaxiosPromise; + get( + params?: Params$Resource$Projects$Locations$Vmwareenginenetworks$Get, + options?: MethodOptions + ): GaxiosPromise; + get( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vmwareenginenetworks$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vmwareenginenetworks$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vmwareenginenetworks$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists `VmwareEngineNetwork` resources in a given project and location. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + list( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$List, + options: StreamMethodOptions + ): GaxiosPromise; + list( + params?: Params$Resource$Projects$Locations$Vmwareenginenetworks$List, + options?: MethodOptions + ): GaxiosPromise; + list( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$List, + callback: BodyResponseCallback + ): void; + list( + callback: BodyResponseCallback + ): void; + list( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vmwareenginenetworks$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | GaxiosPromise + | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vmwareenginenetworks$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vmwareenginenetworks$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+parent}/vmwareEngineNetworks').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest( + parameters + ); + } + } + + /** + * Modifies a VMware Engine network resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + patch( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch, + options: StreamMethodOptions + ): GaxiosPromise; + patch( + params?: Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch, + options?: MethodOptions + ): GaxiosPromise; + patch( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + patch( + params: Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch, + callback: BodyResponseCallback + ): void; + patch(callback: BodyResponseCallback): void; + patch( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): void | GaxiosPromise | GaxiosPromise { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = + {} as Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://vmwareengine.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1/{+name}').replace(/([^:]\/)\/+/g, '$1'), + method: 'PATCH', + }, + options + ), + params, + requiredParams: ['name'], + pathParams: ['name'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Projects$Locations$Vmwareenginenetworks$Create + extends StandardParameters { + /** + * Required. The resource name of the location to create the new VMware Engine network in. A VMware Engine network of type `LEGACY` is a regional resource, and a VMware Engine network of type `STANDARD` is a global resource. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global` + */ + parent?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. The user-provided identifier of the new VMware Engine network. This identifier must be unique among VMware Engine network resources within the parent and becomes the final token in the name URI. The identifier must meet the following requirements: * For networks of type LEGACY, adheres to the format: `{region-id\}-default`. Replace `{region-id\}` with the region where you want to create the VMware Engine network. For example, "us-central1-default". * Only contains 1-63 alphanumeric characters and hyphens * Begins with an alphabetical character * Ends with a non-hyphen character * Not formatted as a UUID * Complies with [RFC 1034](https://datatracker.ietf.org/doc/html/rfc1034) (section 3.5) + */ + vmwareEngineNetworkId?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VmwareEngineNetwork; + } + export interface Params$Resource$Projects$Locations$Vmwareenginenetworks$Delete + extends StandardParameters { + /** + * Optional. Checksum used to ensure that the user-provided value is up to date before the server processes the request. The server compares provided checksum with the current checksum of the resource. If the user-provided value is out of date, this request returns an `ABORTED` error. + */ + etag?: string; + /** + * Required. The resource name of the VMware Engine network to be deleted. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + } + export interface Params$Resource$Projects$Locations$Vmwareenginenetworks$Get + extends StandardParameters { + /** + * Required. The resource name of the VMware Engine network to retrieve. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + */ + name?: string; + } + export interface Params$Resource$Projects$Locations$Vmwareenginenetworks$List + extends StandardParameters { + /** + * A filter expression that matches resources returned in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be `=`, `!=`, `\>`, or `<`. For example, if you are filtering a list of network peerings, you can exclude the ones named `example-network` by specifying `name != "example-network"`. To filter on multiple expressions, provide each separate expression within parentheses. For example: ``` (name = "example-network") (createTime \> "2021-04-12T08:15:10.40Z") ``` By default, each expression is an `AND` expression. However, you can include `AND` and `OR` expressions explicitly. For example: ``` (name = "example-network-1") AND (createTime \> "2021-04-12T08:15:10.40Z") OR (name = "example-network-2") ``` + */ + filter?: string; + /** + * Sorts list results by a certain order. By default, returned results are ordered by `name` in ascending order. You can also sort results in descending order based on the `name` value using `orderBy="name desc"`. Currently, only ordering by `name` is supported. + */ + orderBy?: string; + /** + * The maximum number of results to return in one page. The maximum value is coerced to 1000. The default value of this field is 500. + */ + pageSize?: number; + /** + * A page token, received from a previous `ListVmwareEngineNetworks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListVmwareEngineNetworks` must match the call that provided the page token. + */ + pageToken?: string; + /** + * Required. The resource name of the location to query for VMware Engine networks. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global` + */ + parent?: string; + } + export interface Params$Resource$Projects$Locations$Vmwareenginenetworks$Patch + extends StandardParameters { + /** + * Output only. The resource name of the VMware Engine network. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/vmwareEngineNetworks/my-network` + */ + name?: string; + /** + * Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). + */ + requestId?: string; + /** + * Required. Field mask is used to specify the fields to be overwritten in the VMware Engine network resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. Only the following fields can be updated: `description`. + */ + updateMask?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$VmwareEngineNetwork; + } +} diff --git a/src/apis/vmwareengine/webpack.config.js b/src/apis/vmwareengine/webpack.config.js new file mode 100644 index 0000000000..30d5b4a71a --- /dev/null +++ b/src/apis/vmwareengine/webpack.config.js @@ -0,0 +1,79 @@ +// Copyright 2019 Google LLC +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +// Use `npm run webpack` to produce Webpack bundle for this library. + +const path = require('path'); + +module.exports = { + entry: './index.ts', + resolve: { + extensions: ['.ts', '.js', '.json'], + fallback: { + crypto: false, + child_process: false, + fs: false, + http2: false, + buffer: 'browserify', + process: false, + os: false, + querystring: false, + path: false, + stream: 'stream-browserify', + url: false, + util: false, + zlib: false, + }, + }, + output: { + library: 'Vmwareengine', + filename: 'vmwareengine.min.js', + path: path.resolve(__dirname, 'dist'), + }, + module: { + rules: [ + { + test: /node_modules[\\/]google-auth-library[\\/]src[\\/]crypto[\\/]node[\\/]crypto/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]https-proxy-agent[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gcp-metadata[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]gtoken[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]pkginfo[\\/]/, + use: 'null-loader', + }, + { + test: /node_modules[\\/]semver[\\/]/, + use: 'null-loader', + }, + { + test: /\.ts$/, + use: 'ts-loader', + exclude: /node_modules/, + }, + ], + }, + mode: 'production', + plugins: [], +}; diff --git a/src/apis/youtube/v3.ts b/src/apis/youtube/v3.ts index 54282336db..2265facfee 100644 --- a/src/apis/youtube/v3.ts +++ b/src/apis/youtube/v3.ts @@ -5714,6 +5714,10 @@ export namespace youtube_v3 { * Return the channels within the specified guide category ID. */ categoryId?: string; + /** + * Return the channel associated with a YouTube handle. UNIMPLEMENTED. + */ + forHandle?: string; /** * Return the channel associated with a YouTube username. */ diff --git a/src/index.ts b/src/index.ts index a51dd0e035..a43a442d5a 100644 --- a/src/index.ts +++ b/src/index.ts @@ -75,6 +75,7 @@ export {artifactregistry_v1beta2} from './apis/artifactregistry/v1beta2'; export {assuredworkloads_v1} from './apis/assuredworkloads/v1'; export {assuredworkloads_v1beta1} from './apis/assuredworkloads/v1beta1'; export {authorizedbuyersmarketplace_v1} from './apis/authorizedbuyersmarketplace/v1'; +export {backupdr_v1} from './apis/backupdr/v1'; export {baremetalsolution_v1} from './apis/baremetalsolution/v1'; export {baremetalsolution_v1alpha1} from './apis/baremetalsolution/v1alpha1'; export {baremetalsolution_v2} from './apis/baremetalsolution/v2'; @@ -209,6 +210,7 @@ export {displayvideo_v1beta} from './apis/displayvideo/v1beta'; export {displayvideo_v1beta2} from './apis/displayvideo/v1beta2'; export {displayvideo_v1dev} from './apis/displayvideo/v1dev'; export {displayvideo_v2} from './apis/displayvideo/v2'; +export {displayvideo_v3} from './apis/displayvideo/v3'; export {dlp_v2} from './apis/dlp/v2'; export {dns_v1} from './apis/dns/v1'; export {dns_v1beta2} from './apis/dns/v1beta2'; @@ -405,6 +407,7 @@ export {run_v2} from './apis/run/v2'; export {runtimeconfig_v1} from './apis/runtimeconfig/v1'; export {runtimeconfig_v1beta1} from './apis/runtimeconfig/v1beta1'; export {safebrowsing_v4} from './apis/safebrowsing/v4'; +export {safebrowsing_v5} from './apis/safebrowsing/v5'; export {sasportal_v1alpha1} from './apis/sasportal/v1alpha1'; export {script_v1} from './apis/script/v1'; export {searchads360_v0} from './apis/searchads360/v0'; @@ -478,6 +481,7 @@ export {vision_v1p1beta1} from './apis/vision/v1p1beta1'; export {vision_v1p2beta1} from './apis/vision/v1p2beta1'; export {vmmigration_v1} from './apis/vmmigration/v1'; export {vmmigration_v1alpha1} from './apis/vmmigration/v1alpha1'; +export {vmwareengine_v1} from './apis/vmwareengine/v1'; export {vpcaccess_v1} from './apis/vpcaccess/v1'; export {vpcaccess_v1beta1} from './apis/vpcaccess/v1beta1'; export {webfonts_v1} from './apis/webfonts/v1';