diff --git a/disclaimers.json b/disclaimers.json index e0915d20a32..3be6b11360f 100644 --- a/disclaimers.json +++ b/disclaimers.json @@ -870,5 +870,9 @@ { "api": "storagebatchoperations", "package": "@google-cloud/storagebatchoperations" + }, + { + "api": "vectorsearch", + "package": "@google-cloud/vectorsearch" } ] \ No newline at end of file diff --git a/discovery/cloudshell-v1.json b/discovery/cloudshell-v1.json index 7fea848f5dd..5b170c8ec6e 100644 --- a/discovery/cloudshell-v1.json +++ b/discovery/cloudshell-v1.json @@ -218,7 +218,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -416,7 +416,7 @@ } } }, - "revision": "20251105", + "revision": "20251204", "rootUrl": "https://cloudshell.googleapis.com/", "schemas": { "AddPublicKeyMetadata": { @@ -598,7 +598,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/composer-v1beta1.json b/discovery/composer-v1beta1.json index d983efd692a..ec7af53c8c6 100644 --- a/discovery/composer-v1beta1.json +++ b/discovery/composer-v1beta1.json @@ -742,71 +742,6 @@ } }, "resources": { - "dags": { - "resources": { - "dagRuns": { - "resources": { - "taskInstances": { - "methods": { - "analyzeTask": { - "description": "Start a new task analysis operation.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/dags/{dagsId}/dagRuns/{dagRunsId}/taskInstances/{taskInstancesId}:analyzeTask", - "httpMethod": "POST", - "id": "composer.projects.locations.environments.dags.dagRuns.taskInstances.analyzeTask", - "parameterOrder": [ - "taskInstance" - ], - "parameters": { - "taskInstance": { - "description": "Required. Fully qualified task instance resource name in the form: projects/{project}/locations/{location}/environments/{environment}/dags/{dag}/dagRuns/{dag_run}/taskInstances/{task_instance_with_optional_map_index}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/dags/[^/]+/dagRuns/[^/]+/taskInstances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+taskInstance}:analyzeTask", - "request": { - "$ref": "AnalyzeTaskRequest" - }, - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "getAnalyzeTaskOperation": { - "description": "Retrieve task analysis operation for a task instance if it exists.", - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/environments/{environmentsId}/dags/{dagsId}/dagRuns/{dagRunsId}/taskInstances/{taskInstancesId}:getAnalyzeTaskOperation", - "httpMethod": "GET", - "id": "composer.projects.locations.environments.dags.dagRuns.taskInstances.getAnalyzeTaskOperation", - "parameterOrder": [ - "taskInstance" - ], - "parameters": { - "taskInstance": { - "description": "Required. Fully qualified task instance resource name in the form: projects/{project}/locations/{location}/environments/{environment}/dags/{dag}/dagRuns/{dag_run}/taskInstances/{task_instance_with_optional_map_index}", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/environments/[^/]+/dags/[^/]+/dagRuns/[^/]+/taskInstances/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1beta1/{+taskInstance}:getAnalyzeTaskOperation", - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - }, "userWorkloadsConfigMaps": { "methods": { "create": { @@ -1296,7 +1231,7 @@ } } }, - "revision": "20251114", + "revision": "20251130", "rootUrl": "https://composer.googleapis.com/", "schemas": { "AirflowMetadataRetentionPolicyConfig": { diff --git a/discovery/contactcenteraiplatform-v1alpha1.json b/discovery/contactcenteraiplatform-v1alpha1.json index a03cd27056e..b7ebbb81dd5 100644 --- a/discovery/contactcenteraiplatform-v1alpha1.json +++ b/discovery/contactcenteraiplatform-v1alpha1.json @@ -109,6 +109,34 @@ "resources": { "locations": { "methods": { + "generateShifts": { + "description": "Generates shifts constrained by various parameters.", + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}:generateShifts", + "httpMethod": "POST", + "id": "contactcenteraiplatform.projects.locations.generateShifts", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. Name of the parent resource associated with the request. Format: projects/{project}/locations/{location}", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1alpha1/{+parent}:generateShifts", + "request": { + "$ref": "GenerateShiftsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "get": { "description": "Gets information about a location.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}", @@ -523,7 +551,7 @@ } } }, - "revision": "20251115", + "revision": "20251204", "rootUrl": "https://contactcenteraiplatform.googleapis.com/", "schemas": { "AdminUser": { @@ -740,18 +768,154 @@ }, "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" + }, + "DateList": { + "description": "List of dates.", + "id": "DateList", + "properties": { + "values": { + "description": "Optional. Values in the list.", + "items": { + "$ref": "Date" + }, + "type": "array" + } + }, + "type": "object" + }, + "DateTime": { + "description": "Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations.", + "id": "DateTime", + "properties": { + "day": { + "description": "Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day.", + "format": "int32", + "type": "integer" + }, + "hours": { + "description": "Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value \"24:00:00\" for scenarios like business closing time.", + "format": "int32", + "type": "integer" + }, + "minutes": { + "description": "Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0.", + "format": "int32", + "type": "integer" + }, + "month": { + "description": "Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month.", + "format": "int32", + "type": "integer" + }, + "nanos": { + "description": "Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0.", + "format": "int32", + "type": "integer" + }, + "seconds": { + "description": "Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + }, + "timeZone": { + "$ref": "TimeZone", + "description": "Time zone." + }, + "utcOffset": { + "description": "UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 }.", + "format": "google-duration", + "type": "string" + }, + "year": { + "description": "Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "Early": { "description": "LINT.IfChange First Channel to receive the updates. Meant to dev/test instances", "id": "Early", "properties": {}, "type": "object" }, + "EmployeeInfo": { + "description": "Information about a particular employee for planning purposes.", + "id": "EmployeeInfo", + "properties": { + "id": { + "description": "Required. Unique ID of this employee.", + "type": "string" + }, + "unwantedEventIntervals": { + "description": "Optional. A list of unwanted event intervals for this employee. The start time of the interval must be in the planning horizon.", + "items": { + "$ref": "UnwantedEventInterval" + }, + "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" }, + "EventTemplate": { + "description": "Template specifying rules for generating a single event that occurs during a shift. An event may represent a meeting, break, lunch, etc.", + "id": "EventTemplate", + "properties": { + "durationMinutes": { + "description": "Required. Fixed duration in minutes of this event.", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "Required. Unique ID of this template.", + "type": "string" + }, + "maximumMinutesAfterShiftStart": { + "description": "Optional. Maximum number of minutes after the beginning of a shift that this event can start.", + "format": "int32", + "type": "integer" + }, + "minimumMinutesAfterShiftStart": { + "description": "Optional. Minimum number of minutes after the beginning of a shift that this event can start.", + "format": "int32", + "type": "integer" + }, + "startTimeIncrementMinutes": { + "description": "Required. The time increment (in minutes) used to generate the set of possible event start times between `minimum_minutes_after_shift_start` and `maximum_minutes_after_shift_start`. For example, if the minimum minutes after shift start are 30, maximum minutes after shift start are 45, and the start time increment is 5 minutes, the event can take place 30, 35, 40, or 45 minutes after the start of the shift.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "FeatureConfig": { "id": "FeatureConfig", "properties": { @@ -762,6 +926,39 @@ }, "type": "object" }, + "GenerateShiftsRequest": { + "description": "Request with constraints for generating shifts. The shifts generated must adhere to these constraints.", + "id": "GenerateShiftsRequest", + "properties": { + "employeeInfo": { + "description": "Optional. Employee information that should be considered when generating shifts.", + "items": { + "$ref": "EmployeeInfo" + }, + "type": "array" + }, + "planningHorizon": { + "$ref": "PlanningHorizon", + "description": "Required. The solver will generate the maximum number of shifts per shift template." + }, + "shiftTemplates": { + "description": "Required. Set of shift templates specifying rules for generating shifts. A shift template can be used for generating multiple shifts.", + "items": { + "$ref": "ShiftTemplate" + }, + "type": "array" + }, + "solverConfig": { + "$ref": "SolverConfig", + "description": "Optional. Parameters for the solver." + }, + "workforceDemands": { + "$ref": "WorkforceDemandList", + "description": "Required. All the workforce demands that the generated shifts need to cover. The planning horizon is defined between the earliest start time and the latest end time across all the entries. This field cannot be empty." + } + }, + "type": "object" + }, "GoogleCloudCommonOperationMetadata": { "description": "Represents the metadata of the long-running operation.", "id": "GoogleCloudCommonOperationMetadata", @@ -1046,6 +1243,21 @@ }, "type": "object" }, + "PlanningHorizon": { + "description": "Specifies the time interval during which the solver should generate shifts. The start time must be before the end time.", + "id": "PlanningHorizon", + "properties": { + "endTime": { + "$ref": "DateTime", + "description": "Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored." + }, + "startTime": { + "$ref": "DateTime", + "description": "Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored." + } + }, + "type": "object" + }, "PrivateAccess": { "description": "Defines ingress and egress private traffic settings for CCAIP instances.", "id": "PrivateAccess", @@ -1241,6 +1453,101 @@ }, "type": "object" }, + "ShiftTemplate": { + "description": "Template specifying rules for generating shifts. A shift is a unit of work that specifies a start time, end time, and may contain events (e.g. lunch, breaks etc.). Shifts will be assigned to specific dates in the response.", + "id": "ShiftTemplate", + "properties": { + "assignableEmployeeIds": { + "description": "Optional. A list of specific employee IDs that can be assigned to shifts generated by this template. If this field is present, there will be `EmployeeSchedule`s in the response for which the `EmployeeSchedule.employee_id` field is set to one of the IDs in this list. The number of employee schedules with an assigned employee ID will be between `minimum_employee_count` and `maximum_employee_count`. If this field is empty, between `minimum_employee_count` and `maximum_employee_count` employees can be assigned to shifts generated by this template and the employee schedules won't have an assigned employee ID. Currently, only one assignable employee ID is supported.", + "items": { + "type": "string" + }, + "type": "array" + }, + "daysOffCountPerWeek": { + "description": "Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday.", + "format": "int32", + "type": "integer" + }, + "daysOffDates": { + "$ref": "DateList", + "description": "Fixed dates when shifts from this template should not be generated." + }, + "durationMinutes": { + "description": "Required. Fixed duration of a shift generated by this template.", + "format": "int32", + "type": "integer" + }, + "earliestStartTime": { + "$ref": "TimeOfDay", + "description": "Required. Earliest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored." + }, + "eventTemplates": { + "description": "Optional. Rules for generating events for each shift. Exactly one event will be included in each shift for each `EventTemplate` specified.", + "items": { + "$ref": "EventTemplate" + }, + "type": "array" + }, + "id": { + "description": "Required. Unique ID of this template.", + "type": "string" + }, + "latestStartTime": { + "$ref": "TimeOfDay", + "description": "Required. Latest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. If this value is less than the `earliest_start_time`, it may imply an overnight shift." + }, + "maximumEmployeeCount": { + "description": "Required. Maximum number of employees that can be assigned to all shifts generated by this template on working days.", + "format": "int32", + "type": "integer" + }, + "minimumEmployeeCount": { + "description": "Optional. Minimum number of employees that can be assigned to all shifts generated by this template on working days.", + "format": "int32", + "type": "integer" + }, + "minimumIntereventGapMinutes": { + "description": "Optional. Minimum minutes between the end of one event and the start of the next.", + "format": "int32", + "type": "integer" + }, + "startTimeIncrementMinutes": { + "description": "Optional. The time increment (in minutes) used to generate the set of possible start times between `earliest_start_time` and `latest_start_time`. For example, if the earliest start time is 8:00, the latest start time is 8:30, and the start time increment is 10 minutes, then all possible start times for this shift template are: 8:00, 8:10, 8:20, and 8:30.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "SolverConfig": { + "description": "Specifies additional parameters for the solver generating shifts.", + "id": "SolverConfig", + "properties": { + "maximumProcessingDuration": { + "description": "Optional. Maximum time the solver should spend on the problem. If not set, defaults to 1 minute. The choice of a time limit should depend on the size of the problem. To give an example, when solving a 7-day instance with 2 `ShiftTemplates`, each with ~20 possible start times and holding 2 events with ~30 possible start times, and two days off per week, recommended values are: <10s for fast solutions (and likely suboptimal), (10s, 300s) for good quality solutions, and >300s for an exhaustive search. Larger instances may require longer time limits. This value is not a hard limit and it does not account for the communication overhead. The expected latency to solve the problem may slightly exceed this value.", + "format": "google-duration", + "type": "string" + }, + "scheduleType": { + "description": "Required. Specifies the type of schedule to generate.", + "enum": [ + "SCHEDULE_TYPE_UNSPECIFIED", + "SINGLE_SHIFT", + "WEEKLY_WITH_FIXED_EVENTS", + "WEEKLY_WITH_VARIABLE_EVENTS" + ], + "enumDescriptions": [ + "Unspecified schedule type. Should not be used.", + "Each `EmployeeSchedule` will include exactly one shift.", + "`EmployeeSchedule`s will include several shifts to generate a week-long schedule. The start and end time of events in a particular `EmployeeSchedule` will be identical. All the shifts have the same start and end time.", + "`EmployeeSchedule`s will include several shifts to generate a week-long schedule. The start and end time of events in a particular `EmployeeSchedule` can vary. All the shifts have the same start and end time. This option may result in longer solve times." + ], + "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", @@ -1295,6 +1602,21 @@ }, "type": "object" }, + "TimeZone": { + "description": "Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones).", + "id": "TimeZone", + "properties": { + "id": { + "description": "IANA Time Zone Database time zone. For example \"America/New_York\".", + "type": "string" + }, + "version": { + "description": "Optional. IANA Time Zone Database version number. For example \"2019a\".", + "type": "string" + } + }, + "type": "object" + }, "URIs": { "description": "Message storing the URIs of the ContactCenter.", "id": "URIs", @@ -1318,6 +1640,22 @@ }, "type": "object" }, + "UnwantedEventInterval": { + "description": "Specifies a time interval during which the overlap with events (generated from event templates) should be minimal.", + "id": "UnwantedEventInterval", + "properties": { + "durationMinutes": { + "description": "Required. Duration of the event.", + "format": "int32", + "type": "integer" + }, + "startTime": { + "$ref": "DateTime", + "description": "Required. Start time of the event." + } + }, + "type": "object" + }, "WeeklySchedule": { "description": "Message representing a weekly schedule.", "id": "WeeklySchedule", @@ -1364,6 +1702,40 @@ } }, "type": "object" + }, + "WorkforceDemand": { + "description": "Specifies the number of employees required to cover the demand in the given time interval. The length of the interval must be strictly positive.", + "id": "WorkforceDemand", + "properties": { + "employeeCount": { + "description": "Optional. Number of employees needed to cover the demand for this interval.", + "format": "int32", + "type": "integer" + }, + "endTime": { + "$ref": "DateTime", + "description": "Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored." + }, + "startTime": { + "$ref": "DateTime", + "description": "Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored." + } + }, + "type": "object" + }, + "WorkforceDemandList": { + "description": "List of workforce demands.", + "id": "WorkforceDemandList", + "properties": { + "values": { + "description": "Optional. Values in the list.", + "items": { + "$ref": "WorkforceDemand" + }, + "type": "array" + } + }, + "type": "object" } }, "servicePath": "", diff --git a/discovery/container-v1beta1.json b/discovery/container-v1beta1.json index dabdbf8c4b2..79a1ba7b973 100644 --- a/discovery/container-v1beta1.json +++ b/discovery/container-v1beta1.json @@ -2741,7 +2741,7 @@ } } }, - "revision": "20251104", + "revision": "20251125", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5101,6 +5101,43 @@ }, "type": "object" }, + "DisruptionEvent": { + "description": "DisruptionEvent is a notification sent to customers about the disruption event of a resource.", + "id": "DisruptionEvent", + "properties": { + "disruptionType": { + "description": "The type of the disruption event.", + "enum": [ + "DISRUPTION_TYPE_UNSPECIFIED", + "POD_NOT_ENOUGH_PDB", + "POD_PDB_VIOLATION" + ], + "enumDescriptions": [ + "DISRUPTION_TYPE_UNSPECIFIED indicates the disruption type is unspecified.", + "POD_NOT_ENOUGH_PDB indicates there are still running pods on the node during node drain because their evictions are blocked by PDB.", + "POD_PDB_VIOLATION indicates that there are force pod evictions during node drain which violate the PDB." + ], + "type": "string" + }, + "pdbBlockedNode": { + "description": "The node whose drain is blocked by PDB. This field is set for both POD_PDB_VIOLATION and POD_NOT_ENOUGH_PDB event.", + "type": "string" + }, + "pdbBlockedPod": { + "description": "The pods whose evictions are blocked by PDB. This field is set for both POD_PDB_VIOLATION and POD_NOT_ENOUGH_PDB event.", + "items": { + "$ref": "PdbBlockedPod" + }, + "type": "array" + }, + "pdbViolationTimeout": { + "description": "The timeout in seconds for which the node drain is blocked by PDB. After this timeout, pods are forcefully evicted. This field is only populated when event_type is POD_PDB_VIOLATION.", + "format": "google-duration", + "type": "string" + } + }, + "type": "object" + }, "DnsCacheConfig": { "description": "Configuration for NodeLocal DNSCache", "id": "DnsCacheConfig", @@ -7203,6 +7240,17 @@ }, "type": "object" }, + "NodeDrainConfig": { + "description": "NodeDrainConfig contains the node drain related configurations for this nodepool.", + "id": "NodeDrainConfig", + "properties": { + "respectPdbDuringNodePoolDeletion": { + "description": "Whether to respect PDB during node pool deletion.", + "type": "boolean" + } + }, + "type": "object" + }, "NodeKernelModuleLoading": { "description": "Configuration for kernel module loading on nodes.", "id": "NodeKernelModuleLoading", @@ -7411,8 +7459,7 @@ "type": "string" }, "subnetwork": { - "description": "Output only. The subnetwork path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork for the node pool is picked based on the IP utilization during node pool creation and is immutable.", - "readOnly": true, + "description": "The subnetwork path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork for the node pool is picked based on the IP utilization during node pool creation and is immutable.", "type": "string" } }, @@ -7485,6 +7532,10 @@ "$ref": "NodeNetworkConfig", "description": "Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults." }, + "nodeDrainConfig": { + "$ref": "NodeDrainConfig", + "description": "Specifies the node drain configuration for this node pool." + }, "placementPolicy": { "$ref": "PlacementPolicy", "description": "Specifies the node placement policy." @@ -8050,6 +8101,21 @@ }, "type": "object" }, + "PdbBlockedPod": { + "description": "The namespace/name of the pod whose eviction is blocked by PDB.", + "id": "PdbBlockedPod", + "properties": { + "name": { + "description": "The name of the pod.", + "type": "string" + }, + "namespace": { + "description": "The namespace of the pod.", + "type": "string" + } + }, + "type": "object" + }, "PlacementPolicy": { "description": "PlacementPolicy defines the placement policy used by the node pool.", "id": "PlacementPolicy", @@ -9806,6 +9872,10 @@ "description": "The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/*/locations/*/clusters/*/nodePools/*`.", "type": "string" }, + "nodeDrainConfig": { + "$ref": "NodeDrainConfig", + "description": "The desired node drain configuration for nodes in the node pool." + }, "nodeNetworkConfig": { "$ref": "NodeNetworkConfig", "description": "Node network config." @@ -10040,6 +10110,10 @@ "description": "A brief description of the event.", "type": "string" }, + "disruptionEvent": { + "$ref": "DisruptionEvent", + "description": "The information about the disruption event. This field is only populated when event_type is DISRUPTION_EVENT." + }, "endTime": { "description": "The time when the operation ended.", "format": "google-datetime", @@ -10051,13 +10125,15 @@ "EVENT_TYPE_UNSPECIFIED", "END_OF_SUPPORT", "COS_MILESTONE_VERSION_UPDATE", - "UPGRADE_LIFECYCLE" + "UPGRADE_LIFECYCLE", + "DISRUPTION_EVENT" ], "enumDescriptions": [ "EVENT_TYPE_UNSPECIFIED indicates the event type is unspecified.", "END_OF_SUPPORT indicates GKE version reaches end of support, check standard_support_end_time and extended_support_end_time for more details.", "COS_MILESTONE_VERSION_UPDATE indicates that the COS node image will update COS milestone version for new patch versions starting with the one in the description.", - "UPGRADE_LIFECYCLE indicates the event is about the upgrade lifecycle." + "UPGRADE_LIFECYCLE indicates the event is about the upgrade lifecycle.", + "DISRUPTION_EVENT indicates the event is about the disruption." ], "type": "string" }, diff --git a/discovery/dataform-v1.json b/discovery/dataform-v1.json index 61469356286..1762bc7ee64 100644 --- a/discovery/dataform-v1.json +++ b/discovery/dataform-v1.json @@ -458,7 +458,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2467,7 +2467,7 @@ } } }, - "revision": "20251111", + "revision": "20251202", "rootUrl": "https://dataform.googleapis.com/", "schemas": { "ActionErrorTable": { @@ -2902,6 +2902,11 @@ "readOnly": true, "type": "string" }, + "privateResourceMetadata": { + "$ref": "PrivateResourceMetadata", + "description": "Output only. Metadata indicating whether this resource is user-scoped. `CompilationResult` resource is `user_scoped` only if it is sourced from a workspace.", + "readOnly": true + }, "releaseConfig": { "description": "Immutable. The name of the release config to compile. Must be in the format `projects/*/locations/*/repositories/*/releaseConfigs/*`.", "type": "string" @@ -3513,7 +3518,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -3986,6 +3991,18 @@ }, "type": "object" }, + "PrivateResourceMetadata": { + "description": "Metadata used to identify if a resource is user scoped.", + "id": "PrivateResourceMetadata", + "properties": { + "userScoped": { + "description": "Output only. If true, this resource is user-scoped, meaning it is either a workspace or sourced from a workspace.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, "PullGitCommitsRequest": { "description": "`PullGitCommits` request message.", "id": "PullGitCommitsRequest", @@ -4759,6 +4776,11 @@ "readOnly": true, "type": "string" }, + "privateResourceMetadata": { + "$ref": "PrivateResourceMetadata", + "description": "Output only. Metadata indicating whether this resource is user-scoped. `WorkflowInvocation` resource is `user_scoped` only if it is sourced from a compilation result and the compilation result is user-scoped.", + "readOnly": true + }, "resolvedCompilationResult": { "description": "Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/*/locations/*/repositories/*/compilationResults/*`.", "readOnly": true, @@ -4885,6 +4907,11 @@ "name": { "description": "Identifier. The workspace's name.", "type": "string" + }, + "privateResourceMetadata": { + "$ref": "PrivateResourceMetadata", + "description": "Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`.", + "readOnly": true } }, "type": "object" diff --git a/discovery/datafusion-v1.json b/discovery/datafusion-v1.json index 73fc6a6e5d7..c500de36f15 100644 --- a/discovery/datafusion-v1.json +++ b/discovery/datafusion-v1.json @@ -940,7 +940,7 @@ } } }, - "revision": "20251106", + "revision": "20251203", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1261,6 +1261,10 @@ "$ref": "MaintenancePolicy", "description": "Optional. Configure the maintenance policy for this instance." }, + "monitoringConfig": { + "$ref": "MonitoringConfig", + "description": "Optional. The monitoring configuration for this instance." + }, "name": { "description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.", "readOnly": true, @@ -1618,6 +1622,17 @@ }, "type": "object" }, + "MonitoringConfig": { + "description": "Monitoring configuration for a Data Fusion instance.", + "id": "MonitoringConfig", + "properties": { + "enableInstanceV2Metrics": { + "description": "Optional. Option to enable the instance v2 metrics for this instance. This field is supported only in CDF versions 6.11.1.1 and above.", + "type": "boolean" + } + }, + "type": "object" + }, "NetworkConfig": { "description": "Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources.", "id": "NetworkConfig", diff --git a/discovery/datafusion-v1beta1.json b/discovery/datafusion-v1beta1.json index 2225ee33c66..1ab54451505 100644 --- a/discovery/datafusion-v1beta1.json +++ b/discovery/datafusion-v1beta1.json @@ -1138,7 +1138,7 @@ } } }, - "revision": "20251106", + "revision": "20251203", "rootUrl": "https://datafusion.googleapis.com/", "schemas": { "Accelerator": { @@ -1474,6 +1474,10 @@ "$ref": "MaintenancePolicy", "description": "Optional. Configure the maintenance policy for this instance." }, + "monitoringConfig": { + "$ref": "MonitoringConfig", + "description": "Optional. The monitoring configuration for this instance." + }, "name": { "description": "Output only. The name of this instance is in the form of projects/{project}/locations/{location}/instances/{instance}.", "readOnly": true, @@ -1849,6 +1853,17 @@ }, "type": "object" }, + "MonitoringConfig": { + "description": "Monitoring configuration for a Data Fusion instance.", + "id": "MonitoringConfig", + "properties": { + "enableInstanceV2Metrics": { + "description": "Optional. Option to enable the instance v2 metrics for this instance. This field is supported only in CDF versions 6.11.1.1 and above.", + "type": "boolean" + } + }, + "type": "object" + }, "Namespace": { "description": "Represents the information of a namespace", "id": "Namespace", diff --git a/discovery/dataplex-v1.json b/discovery/dataplex-v1.json index 0940e3a7f46..c177e8d8dc9 100644 --- a/discovery/dataplex-v1.json +++ b/discovery/dataplex-v1.json @@ -728,7 +728,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -870,7 +870,7 @@ "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", - "" + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -3041,7 +3041,7 @@ "Returns entry only, without aspects.", "Returns all required aspects as well as the keys of all non-required aspects.", "Returns aspects matching custom fields in GetEntryRequest. If the number of aspects exceeds 100, the first 100 will be returned.", - "" + "Returns all aspects. If the number of aspects exceeds 100, the first 100 will be returned." ], "location": "query", "type": "string" @@ -7209,7 +7209,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -7229,7 +7229,7 @@ } } }, - "revision": "20251113", + "revision": "20251128", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -8715,7 +8715,12 @@ "GoogleCloudDataplexV1DataDocumentationSpec": { "description": "DataDocumentation scan related spec.", "id": "GoogleCloudDataplexV1DataDocumentationSpec", - "properties": {}, + "properties": { + "catalogPublishingEnabled": { + "description": "Optional. Whether to publish result to Dataplex Catalog.", + "type": "boolean" + } + }, "type": "object" }, "GoogleCloudDataplexV1DataProfileResult": { @@ -14402,7 +14407,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/developerconnect-v1.json b/discovery/developerconnect-v1.json index 93b540eeeb0..61f7bba1713 100644 --- a/discovery/developerconnect-v1.json +++ b/discovery/developerconnect-v1.json @@ -1606,7 +1606,7 @@ } } }, - "revision": "20251113", + "revision": "20251201", "rootUrl": "https://developerconnect.googleapis.com/", "schemas": { "AccountConnector": { @@ -1735,7 +1735,7 @@ "description": "Required. An access token with the minimum `repository` access. It can either be a workspace, project or repository access token. It's recommended to use a system account to generate the credentials." }, "webhookSecretSecretVersion": { - "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate and create webhooks.", + "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate and create webhooks.", "type": "string" }, "workspace": { @@ -1775,7 +1775,7 @@ "type": "string" }, "webhookSecretSecretVersion": { - "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "description": "Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.", "type": "string" } }, @@ -2134,7 +2134,7 @@ "type": "string" }, "privateKeySecretVersion": { - "description": "Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "description": "Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).", "type": "string" }, "serverVersion": { @@ -2151,7 +2151,7 @@ "type": "string" }, "webhookSecretSecretVersion": { - "description": "Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*`.", + "description": "Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).", "type": "string" } }, @@ -2170,7 +2170,7 @@ "description": "Required. A GitLab personal access token with the minimum `read_api` scope access and a minimum role of `reporter`. The GitLab Projects visible to this Personal Access Token will control which Projects Developer Connect has access to." }, "webhookSecretSecretVersion": { - "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.", "type": "string" } }, @@ -2206,7 +2206,7 @@ "type": "string" }, "webhookSecretSecretVersion": { - "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*`. This is used to validate webhooks.", + "description": "Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location). This is used to validate webhooks.", "type": "string" } }, @@ -2717,7 +2717,7 @@ "id": "OAuthCredential", "properties": { "oauthTokenSecretVersion": { - "description": "Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*`.", + "description": "Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).", "type": "string" }, "username": { @@ -3019,7 +3019,7 @@ "id": "UserCredential", "properties": { "userTokenSecretVersion": { - "description": "Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*`.", + "description": "Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/*/secrets/*/versions/*` or `projects/*/locations/*/secrets/*/versions/*` (if regional secrets are supported in that location).", "type": "string" }, "username": { diff --git a/discovery/dialogflow-v3beta1.json b/discovery/dialogflow-v3beta1.json index 9bcff66f863..2c8c325815a 100644 --- a/discovery/dialogflow-v3beta1.json +++ b/discovery/dialogflow-v3beta1.json @@ -5165,7 +5165,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5427,7 +5427,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5446,7 +5446,7 @@ } } }, - "revision": "20251105", + "revision": "20251203", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14142,9 +14142,17 @@ ], "type": "string" }, + "defaultRaiSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings", + "description": "Optional. Immutable. Default RAI settings to be annotated on the agent, so that users will be able to restore their RAI configurations to the default settings. Read-only field for the API proto only." + }, "promptSecuritySettings": { "$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings", "description": "Optional. Settings for prompt security checks." + }, + "raiSettings": { + "$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings", + "description": "Optional. Settings for Responsible AI checks." } }, "type": "object" @@ -14175,6 +14183,63 @@ }, "type": "object" }, + "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings": { + "description": "Settings for Responsible AI.", + "id": "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings", + "properties": { + "categoryFilters": { + "description": "Optional. RAI blocking configurations.", + "items": { + "$ref": "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettingsCategoryFilter" + }, + "type": "array" + } + }, + "type": "object" + }, + "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettingsCategoryFilter": { + "description": "Configuration of the sensitivity level for blocking an RAI category.", + "id": "GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettingsCategoryFilter", + "properties": { + "category": { + "description": "RAI category to configure.", + "enum": [ + "SAFETY_CATEGORY_UNSPECIFIED", + "DANGEROUS_CONTENT", + "HATE_SPEECH", + "HARASSMENT", + "SEXUALLY_EXPLICIT_CONTENT" + ], + "enumDescriptions": [ + "Unspecified.", + "Dangerous content.", + "Hate speech.", + "Harassment.", + "Sexually explicit content." + ], + "type": "string" + }, + "filterLevel": { + "description": "Blocking sensitivity level to configure for the RAI category.", + "enum": [ + "SAFETY_FILTER_LEVEL_UNSPECIFIED", + "BLOCK_NONE", + "BLOCK_FEW", + "BLOCK_SOME", + "BLOCK_MOST" + ], + "enumDescriptions": [ + "Unspecified -- uses default sensitivity levels.", + "Block no text -- effectively disables the category.", + "Block a few suspicious texts.", + "Block some suspicious texts.", + "Block most suspicious texts." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudDialogflowCxV3beta1SearchConfig": { "description": "Search configuration for UCS search queries.", "id": "GoogleCloudDialogflowCxV3beta1SearchConfig", @@ -22453,7 +22518,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/displayvideo-v3.json b/discovery/displayvideo-v3.json index 5c2945adaa9..7bcf627f026 100644 --- a/discovery/displayvideo-v3.json +++ b/discovery/displayvideo-v3.json @@ -1130,18 +1130,18 @@ "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", + "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": "Required. The ID of the advertiser the campaign belongs to.", + "description": "Output only. The unique ID of the advertiser the campaign belongs to.", "format": "int64", "location": "path", "pattern": "^[^/]+$", @@ -1149,7 +1149,123 @@ "type": "string" }, "campaignId": { - "description": "Required. The ID of the campaign to list assigned targeting options for.", + "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" + ] + } + } + }, + "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": "^[^/]+$", @@ -1157,61 +1273,72 @@ "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.", + "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: * `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`.", + "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. 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.", + "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 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.", + "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}/campaigns/{+campaignId}:listAssignedTargetingOptions", + "path": "v3/advertisers/{+advertiserId}/channels", "response": { - "$ref": "BulkListCampaignAssignedTargetingOptionsResponse" + "$ref": "ListChannelsResponse" }, "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}", + "description": "Updates a channel. Returns the updated channel if successful.", + "flatPath": "v3/advertisers/{advertisersId}/channels/{channelId}", "httpMethod": "PATCH", - "id": "displayvideo.advertisers.campaigns.patch", + "id": "displayvideo.advertisers.channels.patch", "parameterOrder": [ "advertiserId", - "campaignId" + "channelId" ], "parameters": { "advertiserId": { - "description": "Output only. The unique ID of the advertiser the campaign belongs to.", + "description": "The ID of the advertiser that owns the created channel.", "format": "int64", "location": "path", "pattern": "^[^/]+$", "required": true, "type": "string" }, - "campaignId": { - "description": "Output only. The unique ID of the campaign. Assigned by the system.", + "channelId": { + "description": "Output only. The unique ID of the channel. Assigned by the system.", "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" + }, "updateMask": { "description": "Required. The mask to control which fields to update.", "format": "google-fieldmask", @@ -1219,561 +1346,45 @@ "type": "string" } }, - "path": "v3/advertisers/{+advertiserId}/campaigns/{+campaignId}", + "path": "v3/advertisers/{+advertiserId}/channels/{channelId}", "request": { - "$ref": "Campaign" + "$ref": "Channel" }, "response": { - "$ref": "Campaign" + "$ref": "Channel" }, "scopes": [ - "https://www.googleapis.com/auth/display-video", - "https://www.googleapis.com/auth/display-video-mediaplanning" + "https://www.googleapis.com/auth/display-video" ] } }, "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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" - ] + "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" }, - "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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" + "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", @@ -2270,796 +1881,102 @@ }, "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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", - "TARGETING_TYPE_CONTENT_THEME_EXCLUSION" - ], - "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.", - "Filter website content by content themes (for example, religion). Only supported for Advertiser resources. Targeting of this type cannot be created or updated using the API. This targeting is only inherited by child YouTube and Demand Gen line item resources." - ], - "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" - ] - } - } + "$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" + ] + }, + "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" + ] } } }, @@ -3373,35 +2290,6 @@ "https://www.googleapis.com/auth/display-video" ] }, - "generateDefault": { - "description": "Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.", - "flatPath": "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}", @@ -9268,7 +8156,7 @@ } } }, - "revision": "20251118", + "revision": "20251201", "rootUrl": "https://displayvideo.googleapis.com/", "schemas": { "ActiveViewVideoViewabilityMetricConfig": { @@ -12701,40 +11589,6 @@ }, "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", @@ -17348,92 +16202,6 @@ }, "type": "object" }, - "GenerateDefaultLineItemRequest": { - "description": "Request message for LineItemService.GenerateDefaultLineItem.", - "id": "GenerateDefaultLineItemRequest", - "properties": { - "containsEuPoliticalAds": { - "description": "Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.", - "enum": [ - "EU_POLITICAL_ADVERTISING_STATUS_UNKNOWN", - "CONTAINS_EU_POLITICAL_ADVERTISING", - "DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING" - ], - "enumDescriptions": [ - "Unknown.", - "Contains EU political advertising.", - "Does not contain EU political advertising." - ], - "type": "string" - }, - "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", @@ -19883,24 +18651,6 @@ }, "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": { @@ -20105,23 +18855,6 @@ }, "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": { diff --git a/discovery/drive-v3.json b/discovery/drive-v3.json index 34667a9c9e0..bf6f9e6db9d 100644 --- a/discovery/drive-v3.json +++ b/discovery/drive-v3.json @@ -265,6 +265,76 @@ } } }, + "approvals": { + "methods": { + "get": { + "description": "Gets an Approval by ID.", + "flatPath": "files/{fileId}/approvals/{approvalId}", + "httpMethod": "GET", + "id": "drive.approvals.get", + "parameterOrder": [ + "fileId", + "approvalId" + ], + "parameters": { + "approvalId": { + "description": "Required. The ID of the Approval.", + "location": "path", + "required": true, + "type": "string" + }, + "fileId": { + "description": "Required. The ID of the file the Approval is on.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "files/{fileId}/approvals/{approvalId}", + "response": { + "$ref": "Approval" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + }, + "list": { + "description": "Lists the Approvals on a file.", + "flatPath": "files/{fileId}/approvals", + "httpMethod": "GET", + "id": "drive.approvals.list", + "parameterOrder": [ + "fileId" + ], + "parameters": { + "fileId": { + "description": "Required. The ID of the file the Approval is on.", + "location": "path", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Approvals to return. When not set, at most 100 Approvals will be returned.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response.", + "location": "query", + "type": "string" + } + }, + "path": "files/{fileId}/approvals", + "response": { + "$ref": "ApprovalList" + }, + "scopes": [ + "https://www.googleapis.com/auth/drive" + ] + } + } + }, "apps": { "methods": { "get": { @@ -2720,7 +2790,7 @@ } } }, - "revision": "20251114", + "revision": "20251201", "rootUrl": "https://www.googleapis.com/", "schemas": { "About": { @@ -3086,6 +3156,100 @@ }, "type": "object" }, + "Approval": { + "description": "Metadata for an approval. An approval is a review/approve process for a Drive item.", + "id": "Approval", + "properties": { + "approvalId": { + "description": "The Approval ID.", + "type": "string" + }, + "completeTime": { + "description": "Output only. The time time the approval was completed.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "createTime": { + "description": "Output only. The time the approval was created.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "dueTime": { + "description": "The time that the approval is due.", + "format": "google-datetime", + "type": "string" + }, + "initiator": { + "$ref": "User", + "description": "The user that requested the Approval." + }, + "kind": { + "description": "This is always drive#approval.", + "type": "string" + }, + "modifyTime": { + "description": "Output only. The most recent time the approval was modified.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "reviewerResponses": { + "description": "The responses made on the Approval by reviewers.", + "items": { + "$ref": "ReviewerResponse" + }, + "type": "array" + }, + "status": { + "description": "Output only. The status of the approval at the time this resource was requested.", + "enum": [ + "STATUS_UNSPECIFIED", + "IN_PROGRESS", + "APPROVED", + "CANCELLED", + "DECLINED" + ], + "enumDescriptions": [ + "Approval status has not been set or was set to an invalid value.", + "The approval process has started and not finished.", + "The approval process is finished and the target was approved.", + "The approval process was cancelled before it finished.", + "The approval process is finished and the target was declined." + ], + "readOnly": true, + "type": "string" + }, + "targetFileId": { + "description": "Target file id of the approval.", + "type": "string" + } + }, + "type": "object" + }, + "ApprovalList": { + "description": "The response of an Approvals list request.", + "id": "ApprovalList", + "properties": { + "items": { + "description": "The list of Approvals. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.", + "items": { + "$ref": "Approval" + }, + "type": "array" + }, + "kind": { + "description": "This is always drive#approvalList", + "type": "string" + }, + "nextPageToken": { + "description": "The page token for the next page of Approvals. This will be absent if the end of the Approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.", + "type": "string" + } + }, + "type": "object" + }, "Change": { "description": "A change to a file or shared drive.", "id": "Change", @@ -4896,6 +5060,37 @@ }, "type": "object" }, + "ReviewerResponse": { + "description": "A response on an Approval made by a specific Reviewer.", + "id": "ReviewerResponse", + "properties": { + "kind": { + "description": "This is always drive#reviewerResponse.", + "type": "string" + }, + "response": { + "description": "A Reviewer’s Response for the Approval.", + "enum": [ + "RESPONSE_UNSPECIFIED", + "NO_RESPONSE", + "APPROVED", + "DECLINED" + ], + "enumDescriptions": [ + "Response was set to an unrecognized value.", + "The reviewer has not yet responded", + "The Reviewer has approved the item.", + "The Reviewer has declined the item." + ], + "type": "string" + }, + "reviewer": { + "$ref": "User", + "description": "The user that is responsible for this response." + } + }, + "type": "object" + }, "Revision": { "description": "The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision.", "id": "Revision", diff --git a/discovery/healthcare-v1.json b/discovery/healthcare-v1.json index 51f3cda55d9..14987a2ce0c 100644 --- a/discovery/healthcare-v1.json +++ b/discovery/healthcare-v1.json @@ -3829,7 +3829,7 @@ ] }, "bulk-export": { - "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", @@ -4212,11 +4212,16 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", "required": true, "type": "string" + }, + "resourceType": { + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/resourcelist.html)).", + "location": "query", + "type": "string" } }, "path": "v1/{+parent}/fhir/_search", "request": { - "$ref": "SearchResourcesRequest" + "$ref": "HttpBody" }, "response": { "$ref": "HttpBody" @@ -4252,7 +4257,7 @@ }, "path": "v1/{+parent}/fhir/{resourceType}/_search", "request": { - "$ref": "SearchResourcesRequest" + "$ref": "HttpBody" }, "response": { "$ref": "HttpBody" @@ -5077,7 +5082,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5137,7 +5142,7 @@ } } }, - "revision": "20251022", + "revision": "20251117", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7028,6 +7033,18 @@ "description": "Optional. Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, + "includeSourceStore": { + "description": "Optional. If true, the source store name will be included as a column in the BigQuery schema.", + "type": "boolean" + }, + "schemaFlattened": { + "$ref": "SchemaFlattened", + "description": "Optional. Setting this field will use flattened DICOM instances schema for the BigQuery table. The flattened schema will have one column for each DICOM tag." + }, + "schemaJson": { + "$ref": "SchemaJSON", + "description": "Optional. Setting this field will store all the DICOM tags as a JSON type in a single column." + }, "tableUri": { "description": "Optional. BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId`", "type": "string" @@ -7723,7 +7740,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -8052,6 +8069,16 @@ "format": "int64", "type": "string" }, + "secondaryFailure": { + "description": "The number of secondary units that failed in the operation.", + "format": "int64", + "type": "string" + }, + "secondarySuccess": { + "description": "The number of secondary units that succeeded in the operation.", + "format": "int64", + "type": "string" + }, "success": { "description": "The number of units that succeeded in the operation.", "format": "int64", @@ -8371,6 +8398,12 @@ }, "type": "object" }, + "SchemaFlattened": { + "description": "Using this field will flatten the DICOM instances into a BigQuery table. The table will have one column for each DICOM tag. The column name will be the DICOM tag's textual representation.", + "id": "SchemaFlattened", + "properties": {}, + "type": "object" + }, "SchemaGroup": { "description": "An HL7v2 logical group construct.", "id": "SchemaGroup", @@ -8403,6 +8436,12 @@ }, "type": "object" }, + "SchemaJSON": { + "description": "Using this field will set the schema such that all DICOM tags will be included in the BigQuery table as a single JSON type column. The BigQuery table schema will include the following columns: * `StudyInstanceUID` (Type: STRING): DICOM Tag 0020000D. * `SeriesInstanceUID` (Type: STRING): DICOM Tag 0020000E. * `SOPInstanceUID` (Type: STRING): DICOM Tag 00080018. * `SourceDicomStore` (Type: STRING): The name of the source DICOM store. This field is only included if the `include_source_store` option is set to true. * `Metadata` (Type: JSON): All DICOM tags for the instance, stored in a single JSON object. * `StructuredStorageSize` (Type: INTEGER): Size of the structured storage in bytes. * `DroppedTags` (Type: STRING, Repeated: Yes): List of tags that were dropped during the conversion. * `StorageClass` (Type: STRING): The storage class of the instance. * `LastUpdated` (Type: TIMESTAMP): Timestamp of the last update to the instance. * `BlobStorageSize` (Type: INTEGER): Size of the blob storage in bytes. * `Type` (Type: STRING): Indicates the type of operation (e.g., INSERT, DELETE).", + "id": "SchemaJSON", + "properties": {}, + "type": "object" + }, "SchemaPackage": { "description": "A schema package contains a set of schemas and type definitions.", "id": "SchemaPackage", @@ -8494,17 +8533,6 @@ }, "type": "object" }, - "SearchResourcesRequest": { - "description": "Request to search the resources in the specified FHIR store.", - "id": "SearchResourcesRequest", - "properties": { - "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html)), [R5](https://hl7.org/fhir/R5/resourcelist.html)).", - "type": "string" - } - }, - "type": "object" - }, "Segment": { "description": "A segment in a structured format.", "id": "Segment", @@ -8950,7 +8978,7 @@ "type": "boolean" }, "enabledImplementationGuides": { - "description": "Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", + "description": "Optional. A list of implementation guide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type - FHIRPath constraints (only when `enable_fhirpath_profile_validation` is true) When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", "items": { "type": "string" }, diff --git a/discovery/healthcare-v1beta1.json b/discovery/healthcare-v1beta1.json index d9a9a7b8d10..1dcc3a6ae5a 100644 --- a/discovery/healthcare-v1beta1.json +++ b/discovery/healthcare-v1beta1.json @@ -4323,7 +4323,7 @@ ] }, "bulk-export": { - "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export. The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", + "description": "Bulk exports all resources from the FHIR store to the specified destination. Implements the FHIR implementation guide [system level $export](https://build.fhir.org/ig/HL7/bulk-data/export.html#endpoint---system-level-export). The following headers must be set in the request: * `Accept`: specifies the format of the `OperationOutcome` response. Only `application/fhir+json` is supported. * `Prefer`: specifies whether the response is immediate or asynchronous. Must be to `respond-async` because only asynchronous responses are supported. Specify the destination for the server to write result files by setting the Cloud Storage location bulk_export_gcs_destination on the FHIR store. URI of an existing Cloud Storage directory where the server writes result files, in the format gs://{bucket-id}/{path/to/destination/dir}. If there is no trailing slash, the service appends one when composing the object path. The user is responsible for creating the Cloud Storage bucket referenced. Supports the following query parameters: * `_type`: string of comma-delimited FHIR resource types. If provided, only the resources of the specified type(s) are exported. * `_since`: if provided, only the resources that are updated after the specified time are exported. * `_outputFormat`: optional, specify ndjson to export data in NDJSON format. Exported file names use the format: {export_id}_{resource_type}.ndjson. On success, the `Content-Location` header of the response is set to a URL that the user can use to query the status of the export. The URL is in the format: `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}/operations/{export_id}`. See get-fhir-operation-status for more information. Errors generated by the FHIR store contain a JSON-encoded `OperationOutcome` resource describing the reason for the error.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}/fhir/$export", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.fhirStores.fhir.bulk-export", @@ -4706,11 +4706,16 @@ "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$", "required": true, "type": "string" + }, + "resourceType": { + "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).", + "location": "query", + "type": "string" } }, "path": "v1beta1/{+parent}/fhir/_search", "request": { - "$ref": "SearchResourcesRequest" + "$ref": "HttpBody" }, "response": { "$ref": "HttpBody" @@ -4746,7 +4751,7 @@ }, "path": "v1beta1/{+parent}/fhir/{resourceType}/_search", "request": { - "$ref": "SearchResourcesRequest" + "$ref": "HttpBody" }, "response": { "$ref": "HttpBody" @@ -5624,7 +5629,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -5684,7 +5689,7 @@ } } }, - "revision": "20251022", + "revision": "20251117", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -7906,10 +7911,26 @@ "description": "The BigQuery table where the server writes output.", "id": "GoogleCloudHealthcareV1beta1DicomBigQueryDestination", "properties": { + "changeDataCaptureConfig": { + "$ref": "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig", + "description": "Optional. Setting this field will enable BigQuery's Change Data Capture (CDC) on the destination tables with JSON schema. Set this field if you want to only keep the latest version of each instance. Updates and deletes to an existing' instance will overwrite the corresponding row. See https://cloud.google.com/bigquery/docs/change-data-capture for details. Note that this field is only supported with the SchemaJSON option. The SchemaFlattened option is not compatible with CDC." + }, "force": { "description": "Use `write_disposition` instead. If `write_disposition` is specified, this parameter is ignored. force=false is equivalent to write_disposition=WRITE_EMPTY and force=true is equivalent to write_disposition=WRITE_TRUNCATE.", "type": "boolean" }, + "includeSourceStore": { + "description": "Optional. If true, the source store name will be included as a column in the BigQuery schema.", + "type": "boolean" + }, + "schemaFlattened": { + "$ref": "SchemaFlattened", + "description": "Optional. Setting this field will use flattened DICOM instances schema for the BigQuery table. The flattened schema will have one column for each DICOM tag." + }, + "schemaJson": { + "$ref": "SchemaJSON", + "description": "Optional. Setting this field will store all the DICOM tags as a JSON type in a single column." + }, "tableUri": { "description": "BigQuery URI to a table, up to 2000 characters long, in the format `bq://projectId.bqDatasetId.tableId`", "type": "string" @@ -7933,6 +7954,12 @@ }, "type": "object" }, + "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig": { + "description": "BigQuery Change Data Capture configuration.", + "id": "GoogleCloudHealthcareV1beta1DicomChangeDataCaptureConfig", + "properties": {}, + "type": "object" + }, "GoogleCloudHealthcareV1beta1DicomGcsDestination": { "description": "The Cloud Storage location where the server writes the output and the export configuration.", "id": "GoogleCloudHealthcareV1beta1DicomGcsDestination", @@ -8709,7 +8736,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -9425,6 +9452,12 @@ }, "type": "object" }, + "SchemaFlattened": { + "description": "Using this field will flatten the DICOM instances into a BigQuery table. The table will have one column for each DICOM tag. The column name will be the DICOM tag's textual representation.", + "id": "SchemaFlattened", + "properties": {}, + "type": "object" + }, "SchemaGroup": { "description": "An HL7v2 logical group construct.", "id": "SchemaGroup", @@ -9457,6 +9490,12 @@ }, "type": "object" }, + "SchemaJSON": { + "description": "Using this field will set the schema such that all DICOM tags will be included in the BigQuery table as a single JSON type column. The BigQuery table schema will include the following columns: * `StudyInstanceUID` (Type: STRING): DICOM Tag 0020000D. * `SeriesInstanceUID` (Type: STRING): DICOM Tag 0020000E. * `SOPInstanceUID` (Type: STRING): DICOM Tag 00080018. * `SourceDicomStore` (Type: STRING): The name of the source DICOM store. This field is only included if the `include_source_store` option is set to true. * `Metadata` (Type: JSON): All DICOM tags for the instance, stored in a single JSON object. * `StructuredStorageSize` (Type: INTEGER): Size of the structured storage in bytes. * `DroppedTags` (Type: STRING, Repeated: Yes): List of tags that were dropped during the conversion. * `StorageClass` (Type: STRING): The storage class of the instance. * `LastUpdated` (Type: TIMESTAMP): Timestamp of the last update to the instance. * `BlobStorageSize` (Type: INTEGER): Size of the blob storage in bytes. * `Type` (Type: STRING): Indicates the type of operation (e.g., INSERT, DELETE). This field is *omitted* if `ChangeDataCaptureConfig` is enabled.", + "id": "SchemaJSON", + "properties": {}, + "type": "object" + }, "SchemaPackage": { "description": "A schema package contains a set of schemas and type definitions.", "id": "SchemaPackage", @@ -9577,17 +9616,6 @@ }, "type": "object" }, - "SearchResourcesRequest": { - "description": "Request to search the resources in the specified FHIR store.", - "id": "SearchResourcesRequest", - "properties": { - "resourceType": { - "description": "Optional. The FHIR resource type to search, such as Patient or Observation. For a complete list, see the FHIR Resource Index ([DSTU2](https://hl7.org/fhir/DSTU2/resourcelist.html), [STU3](https://hl7.org/fhir/STU3/resourcelist.html), [R4](https://hl7.org/fhir/R4/resourcelist.html), [R5](https://hl7.org/fhir/R5/resourcelist.html)).", - "type": "string" - } - }, - "type": "object" - }, "Segment": { "description": "A segment in a structured format.", "id": "Segment", @@ -10061,7 +10089,7 @@ "type": "boolean" }, "enabledImplementationGuides": { - "description": "A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", + "description": "A list of ImplementationGuide URLs in this FHIR store that are used to configure the profiles to use for validation. For example, to use the US Core profiles for validation, set `enabled_implementation_guides` to `[\"http://hl7.org/fhir/us/core/ImplementationGuide/ig\"]`. If `enabled_implementation_guides` is empty or omitted, then incoming resources are only required to conform to the base FHIR profiles. Otherwise, a resource must conform to at least one profile listed in the `global` property of one of the enabled ImplementationGuides. The Cloud Healthcare API does not currently enforce all of the rules in a StructureDefinition. The following rules are supported: - min/max - minValue/maxValue - maxLength - type - fixed[x] - pattern[x] on simple types - slicing, when using \"value\" as the discriminator type - FHIRPath constraints (only when `enable_fhirpath_profile_validation` is true) When a URL cannot be resolved (for example, in a type assertion), the server does not return an error.", "items": { "type": "string" }, diff --git a/discovery/ids-v1.json b/discovery/ids-v1.json index b17330fe4ed..1814647e5b6 100644 --- a/discovery/ids-v1.json +++ b/discovery/ids-v1.json @@ -478,7 +478,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -498,7 +498,7 @@ } } }, - "revision": "20251022", + "revision": "20251201", "rootUrl": "https://ids.googleapis.com/", "schemas": { "CancelOperationRequest": { @@ -680,7 +680,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/logging-v2.json b/discovery/logging-v2.json index dac18c3cdf1..23b1061bbda 100644 --- a/discovery/logging-v2.json +++ b/discovery/logging-v2.json @@ -1383,7 +1383,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -3477,7 +3477,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -4852,7 +4852,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -6317,7 +6317,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -8130,7 +8130,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to \"projects/example/locations/-\".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to \"projects/example/locations/-\".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -9152,7 +9152,7 @@ } } }, - "revision": "20251107", + "revision": "20251128", "rootUrl": "https://logging.googleapis.com/", "schemas": { "AppHub": { @@ -10123,7 +10123,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/notebooks-v2.json b/discovery/notebooks-v2.json index c123316d9f7..83fe4dc17a0 100644 --- a/discovery/notebooks-v2.json +++ b/discovery/notebooks-v2.json @@ -951,7 +951,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -971,7 +971,7 @@ } } }, - "revision": "20251029", + "revision": "20251121", "rootUrl": "https://notebooks.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -996,9 +996,11 @@ "NVIDIA_L4", "NVIDIA_H100_80GB", "NVIDIA_H100_MEGA_80GB", + "NVIDIA_H200_141GB", "NVIDIA_TESLA_T4_VWS", "NVIDIA_TESLA_P100_VWS", - "NVIDIA_TESLA_P4_VWS" + "NVIDIA_TESLA_P4_VWS", + "NVIDIA_B200" ], "enumDescriptions": [ "Accelerator type is not specified.", @@ -1011,9 +1013,11 @@ "Accelerator type is Nvidia Tesla L4.", "Accelerator type is Nvidia Tesla H100 - 80GB.", "Accelerator type is Nvidia Tesla H100 - MEGA 80GB.", + "Accelerator type is Nvidia Tesla H200 - 141GB.", "Accelerator type is NVIDIA Tesla T4 Virtual Workstations.", "Accelerator type is NVIDIA Tesla P100 Virtual Workstations.", - "Accelerator type is NVIDIA Tesla P4 Virtual Workstations." + "Accelerator type is NVIDIA Tesla P4 Virtual Workstations.", + "Accelerator type is NVIDIA B200." ], "type": "string" } @@ -1083,14 +1087,16 @@ "PD_STANDARD", "PD_SSD", "PD_BALANCED", - "PD_EXTREME" + "PD_EXTREME", + "HYPERDISK_BALANCED" ], "enumDescriptions": [ "Disk type not set.", "Standard persistent disk type.", "SSD persistent disk type.", "Balanced persistent disk type.", - "Extreme persistent disk type." + "Extreme persistent disk type.", + "Hyperdisk Balanced persistent disk type." ], "type": "string" }, @@ -1259,14 +1265,16 @@ "PD_STANDARD", "PD_SSD", "PD_BALANCED", - "PD_EXTREME" + "PD_EXTREME", + "HYPERDISK_BALANCED" ], "enumDescriptions": [ "Disk type not set.", "Standard persistent disk type.", "SSD persistent disk type.", "Balanced persistent disk type.", - "Extreme persistent disk type." + "Extreme persistent disk type.", + "Hyperdisk Balanced persistent disk type." ], "type": "string" }, @@ -1785,7 +1793,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/run-v2.json b/discovery/run-v2.json index 0a7246a9f9a..c0e7a6b8742 100644 --- a/discovery/run-v2.json +++ b/discovery/run-v2.json @@ -1329,7 +1329,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -2177,7 +2177,7 @@ } } }, - "revision": "20251107", + "revision": "20251202", "rootUrl": "https://run.googleapis.com/", "schemas": { "GoogleCloudRunV2BinaryAuthorization": { @@ -2363,7 +2363,8 @@ "NON_ZERO_EXIT_CODE", "CANCELLED", "CANCELLING", - "DELETED" + "DELETED", + "FLEX_START_PENDING" ], "enumDescriptions": [ "Default value.", @@ -2371,7 +2372,8 @@ "A task reached its retry limit and the last attempt failed due to the user container exiting with a non-zero exit code.", "The execution was cancelled by users.", "The execution is in the process of being cancelled.", - "The execution was deleted." + "The execution was deleted.", + "A Flex priority execution is waiting for a start time." ], "readOnly": true, "type": "string" @@ -3418,6 +3420,14 @@ "$ref": "GoogleCloudRunV2Service" }, "type": "array" + }, + "unreachable": { + "description": "Output only. For global requests, returns the list of regions that could not be reached within the deadline.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" @@ -4982,7 +4992,7 @@ "type": "string" }, "customAudiences": { - "description": "One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences.", + "description": "Not supported, and ignored by Cloud Run.", "items": { "type": "string" }, @@ -5108,6 +5118,11 @@ "description": "Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run.", "readOnly": true }, + "threatDetectionEnabled": { + "description": "Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool.", + "readOnly": true, + "type": "boolean" + }, "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, @@ -6195,6 +6210,10 @@ "description": "Maven `artifactId` value used when uploading the artifact to Artifact Registry.", "type": "string" }, + "deployFolder": { + "description": "Optional. Path to a folder containing the files to upload to Artifact Registry. This can be either an absolute path, e.g. `/workspace/my-app/target/`, or a relative path from /workspace, e.g. `my-app/target/`. This field is mutually exclusive with the `path` field.", + "type": "string" + }, "groupId": { "description": "Maven `groupId` value used when uploading the artifact to Artifact Registry.", "type": "string" @@ -6867,7 +6886,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/searchads360-v0.json b/discovery/searchads360-v0.json index 36074af638b..22e29b0271e 100644 --- a/discovery/searchads360-v0.json +++ b/discovery/searchads360-v0.json @@ -260,7 +260,7 @@ } } }, - "revision": "20251116", + "revision": "20251204", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -1879,6 +1879,10 @@ "description": "Resource name of the geo target constant that represents a metro.", "type": "string" }, + "geoTargetPostalCode": { + "description": "Resource name of the geo target constant that represents a postal code.", + "type": "string" + }, "geoTargetRegion": { "description": "Resource name of the geo target constant that represents a region.", "type": "string" @@ -4625,7 +4629,7 @@ "id": "GoogleAdsSearchads360V0Resources__AdGroupBidModifier", "properties": { "bidModifier": { - "description": "The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type.", + "description": "The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Use 0 to opt out of a Device type.", "format": "double", "type": "number" }, diff --git a/discovery/sqladmin-v1.json b/discovery/sqladmin-v1.json index 361ea0476f4..3318aabb0ce 100644 --- a/discovery/sqladmin-v1.json +++ b/discovery/sqladmin-v1.json @@ -954,6 +954,38 @@ "https://www.googleapis.com/auth/sqlservice.admin" ] }, + "addEntraIdCertificate": { + "description": "Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version.", + "flatPath": "v1/projects/{project}/instances/{instance}/addEntraIdCertificate", + "httpMethod": "POST", + "id": "sql.instances.addEntraIdCertificate", + "parameterOrder": [ + "project", + "instance" + ], + "parameters": { + "instance": { + "description": "Required. Cloud SQL instance ID. This does not include the project ID.", + "location": "path", + "required": true, + "type": "string" + }, + "project": { + "description": "Required. Project ID of the project that contains the instance.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "v1/projects/{project}/instances/{instance}/addEntraIdCertificate", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/sqlservice.admin" + ] + }, "addServerCa": { "description": "Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate.", "flatPath": "v1/projects/{project}/instances/{instance}/addServerCa", @@ -2758,7 +2790,7 @@ } } }, - "revision": "20251107", + "revision": "20251201", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -6786,7 +6818,7 @@ "type": "object" }, "PasswordValidationPolicy": { - "description": "Database instance local user password validation policy", + "description": "Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access.", "id": "PasswordValidationPolicy", "properties": { "complexity": { @@ -6811,7 +6843,7 @@ "type": "boolean" }, "enablePasswordPolicy": { - "description": "Whether the password policy is enabled or not.", + "description": "Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords.", "type": "boolean" }, "minLength": { @@ -6844,6 +6876,42 @@ }, "type": "object" }, + "PerformanceCaptureConfig": { + "description": "Performance Capture configuration.", + "id": "PerformanceCaptureConfig", + "properties": { + "enabled": { + "description": "Optional. Enable or disable the Performance Capture feature.", + "type": "boolean" + }, + "probeThreshold": { + "description": "Optional. The minimum number of consecutive readings above threshold that triggers instance state capture.", + "format": "int32", + "type": "integer" + }, + "probingIntervalSeconds": { + "description": "Optional. The time interval in seconds between any two probes.", + "format": "int32", + "type": "integer" + }, + "runningThreadsThreshold": { + "description": "Optional. The minimum number of server threads running to trigger the capture on primary.", + "format": "int32", + "type": "integer" + }, + "secondsBehindSourceThreshold": { + "description": "Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica.", + "format": "int32", + "type": "integer" + }, + "transactionDurationThreshold": { + "description": "Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PointInTimeRestoreContext": { "description": "The context to perform a point-in-time recovery of an instance managed by Backup and Disaster Recovery (DR) Service.", "id": "PointInTimeRestoreContext", @@ -6915,6 +6983,19 @@ "readOnly": true, "type": "string" }, + "pscAutoConnections": { + "description": "Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.", + "items": { + "$ref": "PscAutoConnectionConfig" + }, + "readOnly": true, + "type": "array" + }, + "pscServiceAttachmentLink": { + "description": "Output only. The Private Service Connect (PSC) service attachment of the read pool node.", + "readOnly": true, + "type": "string" + }, "state": { "description": "Output only. The current state of the read pool node.", "enum": [ @@ -7690,6 +7771,10 @@ "$ref": "PasswordValidationPolicy", "description": "The local user password validation policy of the instance." }, + "performanceCaptureConfig": { + "$ref": "PerformanceCaptureConfig", + "description": "Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations." + }, "pricingPlan": { "description": "The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.", "enum": [ diff --git a/discovery/sqladmin-v1beta4.json b/discovery/sqladmin-v1beta4.json index 9556a441819..ea563c55b96 100644 --- a/discovery/sqladmin-v1beta4.json +++ b/discovery/sqladmin-v1beta4.json @@ -978,9 +978,6 @@ } }, "path": "sql/v1beta4/projects/{project}/instances/{instance}/addEntraIdCertificate", - "request": { - "$ref": "SqlInstancesAddEntraIdCertificateRequest" - }, "response": { "$ref": "Operation" }, @@ -2798,7 +2795,7 @@ } } }, - "revision": "20251107", + "revision": "20251201", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -6827,7 +6824,7 @@ "type": "object" }, "PasswordValidationPolicy": { - "description": "Database instance local user password validation policy", + "description": "Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access.", "id": "PasswordValidationPolicy", "properties": { "complexity": { @@ -6852,7 +6849,7 @@ "type": "boolean" }, "enablePasswordPolicy": { - "description": "Whether the password policy is enabled or not.", + "description": "Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords.", "type": "boolean" }, "minLength": { @@ -6885,6 +6882,42 @@ }, "type": "object" }, + "PerformanceCaptureConfig": { + "description": "Performance Capture configuration.", + "id": "PerformanceCaptureConfig", + "properties": { + "enabled": { + "description": "Optional. Enable or disable the Performance Capture.", + "type": "boolean" + }, + "probeThreshold": { + "description": "Optional. The minimum number of consecutive readings above threshold that triggers instance state capture.", + "format": "int32", + "type": "integer" + }, + "probingIntervalSeconds": { + "description": "Optional. The time interval in seconds between any two probes.", + "format": "int32", + "type": "integer" + }, + "runningThreadsThreshold": { + "description": "Optional. The minimum number of server threads running to trigger the capture on primary.", + "format": "int32", + "type": "integer" + }, + "secondsBehindSourceThreshold": { + "description": "Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica.", + "format": "int32", + "type": "integer" + }, + "transactionDurationThreshold": { + "description": "Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "PointInTimeRestoreContext": { "description": "Context to perform a point-in-time restore of an instance managed by Backup and Disaster Recovery (DR) Service.", "id": "PointInTimeRestoreContext", @@ -6956,6 +6989,19 @@ "readOnly": true, "type": "string" }, + "pscAutoConnections": { + "description": "Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node.", + "items": { + "$ref": "PscAutoConnectionConfig" + }, + "readOnly": true, + "type": "array" + }, + "pscServiceAttachmentLink": { + "description": "Output only. The Private Service Connect (PSC) service attachment of the read pool node.", + "readOnly": true, + "type": "string" + }, "state": { "description": "Output only. The current state of the read pool node.", "enum": [ @@ -7731,6 +7777,10 @@ "$ref": "PasswordValidationPolicy", "description": "The local user password validation policy of the instance." }, + "performanceCaptureConfig": { + "$ref": "PerformanceCaptureConfig", + "description": "Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations." + }, "pricingPlan": { "description": "The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances.", "enum": [ @@ -8013,12 +8063,6 @@ }, "type": "object" }, - "SqlInstancesAddEntraIdCertificateRequest": { - "description": "Request for AddEntraIdCertificate RPC.", - "id": "SqlInstancesAddEntraIdCertificateRequest", - "properties": {}, - "type": "object" - }, "SqlInstancesExecuteSqlResponse": { "description": "Execute SQL statements response.", "id": "SqlInstancesExecuteSqlResponse", diff --git a/discovery/storage-v1.json b/discovery/storage-v1.json index c642b4dca63..d8921a0e4ea 100644 --- a/discovery/storage-v1.json +++ b/discovery/storage-v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], - "etag": "\"3131343633323936333034313936343439353533\"", + "etag": "\"39373339343838363630393031393634343537\"", "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" @@ -4549,7 +4549,7 @@ } } }, - "revision": "20250925", + "revision": "20251118", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -5500,6 +5500,10 @@ "description": "A Compose request.", "id": "ComposeRequest", "properties": { + "deleteSourceObjects": { + "description": "If true, the source objects will be deleted.", + "type": "boolean" + }, "destination": { "$ref": "Object", "description": "Properties of the resulting object." diff --git a/discovery/tpu-v1.json b/discovery/tpu-v1.json index 207a5200722..2f30ac683cd 100644 --- a/discovery/tpu-v1.json +++ b/discovery/tpu-v1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -184,8 +184,10 @@ }, "resources": { "acceleratorTypes": { + "deprecated": true, "methods": { "get": { + "deprecated": true, "description": "Gets AcceleratorType.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}", "httpMethod": "GET", @@ -211,6 +213,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists accelerator types supported by this API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes", "httpMethod": "GET", @@ -259,8 +262,10 @@ } }, "nodes": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a node.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes", "httpMethod": "POST", @@ -294,6 +299,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a node.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "httpMethod": "DELETE", @@ -319,6 +325,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets the details of a node.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "httpMethod": "GET", @@ -344,6 +351,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists nodes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes", "httpMethod": "GET", @@ -380,6 +388,7 @@ ] }, "reimage": { + "deprecated": true, "description": "Reimages a node's OS.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage", "httpMethod": "POST", @@ -408,6 +417,7 @@ ] }, "start": { + "deprecated": true, "description": "Starts a node.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start", "httpMethod": "POST", @@ -436,6 +446,7 @@ ] }, "stop": { + "deprecated": true, "description": "Stops a node, this operation is only available with single TPU nodes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop", "httpMethod": "POST", @@ -575,7 +586,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -591,8 +602,10 @@ } }, "tensorflowVersions": { + "deprecated": true, "methods": { "get": { + "deprecated": true, "description": "Gets TensorFlow Version.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions/{tensorflowVersionsId}", "httpMethod": "GET", @@ -618,6 +631,7 @@ ] }, "list": { + "deprecated": true, "description": "List TensorFlow versions supported by this API.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions", "httpMethod": "GET", @@ -670,10 +684,11 @@ } } }, - "revision": "20251005", + "revision": "20251130", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { + "deprecated": true, "description": "A accelerator type that a Node can be configured with.", "id": "AcceleratorType", "properties": { @@ -695,6 +710,7 @@ "type": "object" }, "ListAcceleratorTypesResponse": { + "deprecated": true, "description": "Response for ListAcceleratorTypes.", "id": "ListAcceleratorTypesResponse", "properties": { @@ -738,6 +754,7 @@ "type": "object" }, "ListNodesResponse": { + "deprecated": true, "description": "Response for ListNodes.", "id": "ListNodesResponse", "properties": { @@ -778,7 +795,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -788,6 +805,7 @@ "type": "object" }, "ListTensorFlowVersionsResponse": { + "deprecated": true, "description": "Response for ListTensorFlowVersions.", "id": "ListTensorFlowVersionsResponse", "properties": { @@ -847,6 +865,7 @@ "type": "object" }, "NetworkEndpoint": { + "deprecated": true, "description": "A network endpoint over which a TPU worker can be reached.", "id": "NetworkEndpoint", "properties": { @@ -863,6 +882,7 @@ "type": "object" }, "Node": { + "deprecated": true, "description": "A TPU instance.", "id": "Node", "properties": { @@ -1065,6 +1085,7 @@ "type": "object" }, "OperationMetadata": { + "deprecated": true, "description": "Metadata describing an Operation", "id": "OperationMetadata", "properties": { @@ -1102,6 +1123,7 @@ "type": "object" }, "ReimageNodeRequest": { + "deprecated": true, "description": "Request for ReimageNode.", "id": "ReimageNodeRequest", "properties": { @@ -1113,6 +1135,7 @@ "type": "object" }, "SchedulingConfig": { + "deprecated": true, "description": "Sets the scheduling options for this node.", "id": "SchedulingConfig", "properties": { @@ -1128,6 +1151,7 @@ "type": "object" }, "StartNodeRequest": { + "deprecated": true, "description": "Request for StartNode.", "id": "StartNodeRequest", "properties": {}, @@ -1161,12 +1185,14 @@ "type": "object" }, "StopNodeRequest": { + "deprecated": true, "description": "Request for StopNode.", "id": "StopNodeRequest", "properties": {}, "type": "object" }, "Symptom": { + "deprecated": true, "description": "A Symptom instance.", "id": "Symptom", "properties": { @@ -1209,6 +1235,7 @@ "type": "object" }, "TensorFlowVersion": { + "deprecated": true, "description": "A tensorflow version that a Node can be configured with.", "id": "TensorFlowVersion", "properties": { diff --git a/discovery/tpu-v1alpha1.json b/discovery/tpu-v1alpha1.json index 5a227fdf19d..c7b45ca8eb4 100644 --- a/discovery/tpu-v1alpha1.json +++ b/discovery/tpu-v1alpha1.json @@ -144,7 +144,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -184,8 +184,10 @@ }, "resources": { "acceleratorTypes": { + "deprecated": true, "methods": { "get": { + "deprecated": true, "description": "Gets AcceleratorType.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes/{acceleratorTypesId}", "httpMethod": "GET", @@ -211,6 +213,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists accelerator types supported by this API.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/acceleratorTypes", "httpMethod": "GET", @@ -259,8 +262,10 @@ } }, "nodes": { + "deprecated": true, "methods": { "create": { + "deprecated": true, "description": "Creates a node.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes", "httpMethod": "POST", @@ -299,6 +304,7 @@ ] }, "delete": { + "deprecated": true, "description": "Deletes a node.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "httpMethod": "DELETE", @@ -329,6 +335,7 @@ ] }, "get": { + "deprecated": true, "description": "Gets the details of a node.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", "httpMethod": "GET", @@ -354,6 +361,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists nodes.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes", "httpMethod": "GET", @@ -390,6 +398,7 @@ ] }, "reimage": { + "deprecated": true, "description": "Reimages a node's OS.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage", "httpMethod": "POST", @@ -418,6 +427,7 @@ ] }, "start": { + "deprecated": true, "description": "Starts a node.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:start", "httpMethod": "POST", @@ -446,6 +456,7 @@ ] }, "stop": { + "deprecated": true, "description": "Stops a node. This operation is only available with single TPU nodes.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:stop", "httpMethod": "POST", @@ -585,7 +596,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -601,8 +612,10 @@ } }, "tensorflowVersions": { + "deprecated": true, "methods": { "get": { + "deprecated": true, "description": "Gets TensorFlow Version.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions/{tensorflowVersionsId}", "httpMethod": "GET", @@ -628,6 +641,7 @@ ] }, "list": { + "deprecated": true, "description": "Lists TensorFlow versions supported by this API.", "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/tensorflowVersions", "httpMethod": "GET", @@ -680,11 +694,12 @@ } } }, - "revision": "20251005", + "revision": "20251130", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorType": { - "description": "A accelerator type that a Node can be configured with.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. A accelerator type that a Node can be configured with.", "id": "AcceleratorType", "properties": { "name": { @@ -705,7 +720,8 @@ "type": "object" }, "ListAcceleratorTypesResponse": { - "description": "Response for ListAcceleratorTypes.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListAcceleratorTypes.", "id": "ListAcceleratorTypesResponse", "properties": { "acceleratorTypes": { @@ -748,7 +764,8 @@ "type": "object" }, "ListNodesResponse": { - "description": "Response for ListNodes.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListNodes.", "id": "ListNodesResponse", "properties": { "nextPageToken": { @@ -788,7 +805,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -798,7 +815,8 @@ "type": "object" }, "ListTensorFlowVersionsResponse": { - "description": "Response for ListTensorFlowVersions.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListTensorFlowVersions.", "id": "ListTensorFlowVersionsResponse", "properties": { "nextPageToken": { @@ -857,7 +875,8 @@ "type": "object" }, "NetworkEndpoint": { - "description": "A network endpoint over which a TPU worker can be reached.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. A network endpoint over which a TPU worker can be reached.", "id": "NetworkEndpoint", "properties": { "ipAddress": { @@ -873,7 +892,8 @@ "type": "object" }, "Node": { - "description": "A TPU instance.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. A TPU instance.", "id": "Node", "properties": { "acceleratorType": { @@ -1075,7 +1095,8 @@ "type": "object" }, "OperationMetadata": { - "description": "Metadata describing an Operation", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Metadata describing an Operation", "id": "OperationMetadata", "properties": { "apiVersion": { @@ -1112,7 +1133,8 @@ "type": "object" }, "ReimageNodeRequest": { - "description": "Request for ReimageNode.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Request for ReimageNode.", "id": "ReimageNodeRequest", "properties": { "tensorflowVersion": { @@ -1123,7 +1145,8 @@ "type": "object" }, "SchedulingConfig": { - "description": "Sets the scheduling options for this node.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Sets the scheduling options for this node.", "id": "SchedulingConfig", "properties": { "preemptible": { @@ -1138,7 +1161,8 @@ "type": "object" }, "StartNodeRequest": { - "description": "Request for StartNode.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Request for StartNode.", "id": "StartNodeRequest", "properties": {}, "type": "object" @@ -1171,13 +1195,15 @@ "type": "object" }, "StopNodeRequest": { - "description": "Request for StopNode.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. Request for StopNode.", "id": "StopNodeRequest", "properties": {}, "type": "object" }, "Symptom": { - "description": "A Symptom instance.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. A Symptom instance.", "id": "Symptom", "properties": { "createTime": { @@ -1219,7 +1245,8 @@ "type": "object" }, "TensorFlowVersion": { - "description": "A tensorflow version that a Node can be configured with.", + "deprecated": true, + "description": "DEPRECATED: Please use TPU API v2alpha1 instead. A tensorflow version that a Node can be configured with.", "id": "TensorFlowVersion", "properties": { "name": { diff --git a/discovery/tpu-v2.json b/discovery/tpu-v2.json index ac24aeda24c..5183ac828ad 100644 --- a/discovery/tpu-v2.json +++ b/discovery/tpu-v2.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -637,7 +637,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -898,7 +898,7 @@ } } }, - "revision": "20251005", + "revision": "20251130", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1267,7 +1267,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/tpu-v2alpha1.json b/discovery/tpu-v2alpha1.json index 83f0364b821..2991f827d4e 100644 --- a/discovery/tpu-v2alpha1.json +++ b/discovery/tpu-v2alpha1.json @@ -172,7 +172,7 @@ ], "parameters": { "extraLocationTypes": { - "description": "Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage.", + "description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.", "location": "query", "repeated": true, "type": "string" @@ -703,7 +703,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1057,7 +1057,7 @@ } } }, - "revision": "20251005", + "revision": "20251130", "rootUrl": "https://tpu.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -1483,7 +1483,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/discovery/workstations-v1.json b/discovery/workstations-v1.json index deeeb6f3082..6de1e2b3dc0 100644 --- a/discovery/workstations-v1.json +++ b/discovery/workstations-v1.json @@ -296,7 +296,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1221,7 +1221,7 @@ } } }, - "revision": "20251022", + "revision": "20251202", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1479,6 +1479,41 @@ }, "type": "object" }, + "GceHyperdiskBalancedHighAvailability": { + "description": "A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads.", + "id": "GceHyperdiskBalancedHighAvailability", + "properties": { + "archiveTimeout": { + "description": "Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `\"0s\"` indicates that the disk will never be archived.", + "format": "google-duration", + "type": "string" + }, + "reclaimPolicy": { + "description": "Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`.", + "enum": [ + "RECLAIM_POLICY_UNSPECIFIED", + "DELETE", + "RETAIN" + ], + "enumDescriptions": [ + "Do not use.", + "Delete the persistent disk when deleting the workstation.", + "Keep the persistent disk when deleting the workstation. An administrator must manually delete the disk." + ], + "type": "string" + }, + "sizeGb": { + "description": "Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`.", + "format": "int32", + "type": "integer" + }, + "sourceSnapshot": { + "description": "Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions.", + "type": "string" + } + }, + "type": "object" + }, "GceInstance": { "description": "A runtime using a Compute Engine instance.", "id": "GceInstance", @@ -1548,6 +1583,10 @@ "$ref": "GceShieldedInstanceConfig", "description": "Optional. A set of Compute Engine Shielded instance options." }, + "startupScriptUri": { + "description": "Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version.", + "type": "string" + }, "tags": { "description": "Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules).", "items": { @@ -1756,7 +1795,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, @@ -2007,6 +2046,10 @@ "description": "A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations.", "id": "PersistentDirectory", "properties": { + "gceHd": { + "$ref": "GceHyperdiskBalancedHighAvailability", + "description": "A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk." + }, "gcePd": { "$ref": "GceRegionalPersistentDisk", "description": "A PersistentDirectory backed by a Compute Engine persistent disk." diff --git a/discovery/workstations-v1beta.json b/discovery/workstations-v1beta.json index db936bc9447..5afb452a3f0 100644 --- a/discovery/workstations-v1beta.json +++ b/discovery/workstations-v1beta.json @@ -222,7 +222,7 @@ "type": "string" }, "returnPartialSuccess": { - "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `\"projects/example/locations/-\"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", + "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "location": "query", "type": "boolean" } @@ -1147,7 +1147,7 @@ } } }, - "revision": "20251022", + "revision": "20251202", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1410,7 +1410,7 @@ "type": "object" }, "GceHyperdiskBalancedHighAvailability": { - "description": "A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk. This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads.", + "description": "A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads.", "id": "GceHyperdiskBalancedHighAvailability", "properties": { "archiveTimeout": { @@ -1483,6 +1483,13 @@ "description": "Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series.", "type": "boolean" }, + "instanceMetadata": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Custom metadata to apply to Compute Engine instances.", + "type": "object" + }, "machineType": { "description": "Optional. The type of machine to use for VM instances—for example, `\"e2-standard-4\"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types).", "type": "string" @@ -1518,7 +1525,7 @@ "description": "Optional. A set of Compute Engine Shielded instance options." }, "startupScriptUri": { - "description": "Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The uri must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible.", + "description": "Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name}/{object-name}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version.", "type": "string" }, "tags": { @@ -1726,7 +1733,7 @@ "type": "array" }, "unreachable": { - "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations.", + "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.", "items": { "type": "string" }, diff --git a/src/apis/cloudshell/v1.ts b/src/apis/cloudshell/v1.ts index 4d9ef326c0b..dd0af88fd12 100644 --- a/src/apis/cloudshell/v1.ts +++ b/src/apis/cloudshell/v1.ts @@ -252,7 +252,7 @@ export namespace cloudshell_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -799,7 +799,7 @@ export namespace cloudshell_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -947,7 +947,7 @@ export namespace cloudshell_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/composer/v1beta1.ts b/src/apis/composer/v1beta1.ts index ca63934b1fa..21dbe4482f5 100644 --- a/src/apis/composer/v1beta1.ts +++ b/src/apis/composer/v1beta1.ts @@ -646,7 +646,7 @@ export namespace composer_v1beta1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -3441,8 +3441,7 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Environments$Checkupgrade - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Checkupgrade extends StandardParameters { /** * The resource name of the environment to check upgrade for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3453,8 +3452,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$CheckUpgradeRequest; } - export interface Params$Resource$Projects$Locations$Environments$Create - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Create extends StandardParameters { /** * The parent must be of the form "projects/{projectId\}/locations/{locationId\}". */ @@ -3465,8 +3463,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Projects$Locations$Environments$Databasefailover - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Databasefailover extends StandardParameters { /** * Target environment: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3477,15 +3474,13 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$DatabaseFailoverRequest; } - export interface Params$Resource$Projects$Locations$Environments$Delete - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Delete extends StandardParameters { /** * The environment to delete, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Executeairflowcommand - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Executeairflowcommand extends StandardParameters { /** * The resource name of the environment in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}". */ @@ -3496,22 +3491,19 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$ExecuteAirflowCommandRequest; } - export interface Params$Resource$Projects$Locations$Environments$Fetchdatabaseproperties - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Fetchdatabaseproperties extends StandardParameters { /** * Required. The resource name of the environment, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ environment?: string; } - export interface Params$Resource$Projects$Locations$Environments$Get - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Get extends StandardParameters { /** * The resource name of the environment to get, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$List - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$List extends StandardParameters { /** * The maximum number of environments to return. */ @@ -3525,8 +3517,7 @@ export namespace composer_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Environments$Loadsnapshot - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Loadsnapshot extends StandardParameters { /** * The resource name of the target environment in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3537,8 +3528,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$LoadSnapshotRequest; } - export interface Params$Resource$Projects$Locations$Environments$Patch - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Patch extends StandardParameters { /** * The relative resource name of the environment to update, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3553,8 +3543,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$Environment; } - export interface Params$Resource$Projects$Locations$Environments$Pollairflowcommand - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Pollairflowcommand extends StandardParameters { /** * The resource name of the environment in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3565,8 +3554,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$PollAirflowCommandRequest; } - export interface Params$Resource$Projects$Locations$Environments$Restartwebserver - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Restartwebserver extends StandardParameters { /** * Required. The resource name of the environment to restart the web server for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3577,8 +3565,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$RestartWebServerRequest; } - export interface Params$Resource$Projects$Locations$Environments$Savesnapshot - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Savesnapshot extends StandardParameters { /** * The resource name of the source environment in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -3589,8 +3576,7 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$SaveSnapshotRequest; } - export interface Params$Resource$Projects$Locations$Environments$Stopairflowcommand - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Stopairflowcommand extends StandardParameters { /** * The resource name of the environment in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}". */ @@ -4343,8 +4329,7 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Create - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Create extends StandardParameters { /** * Required. The environment name to create a ConfigMap for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -4355,22 +4340,19 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$UserWorkloadsConfigMap; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Delete - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Delete extends StandardParameters { /** * Required. The ConfigMap to delete, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Get - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Get extends StandardParameters { /** * Required. The resource name of the ConfigMap to get, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$List - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$List extends StandardParameters { /** * Optional. The maximum number of ConfigMaps to return. */ @@ -4384,8 +4366,7 @@ export namespace composer_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Update - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadsconfigmaps$Update extends StandardParameters { /** * Identifier. The resource name of the ConfigMap, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsConfigMaps/{userWorkloadsConfigMapId\}" */ @@ -5126,8 +5107,7 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Create - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Create extends StandardParameters { /** * Required. The environment name to create a Secret for, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}" */ @@ -5138,22 +5118,19 @@ export namespace composer_v1beta1 { */ requestBody?: Schema$UserWorkloadsSecret; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Delete - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Delete extends StandardParameters { /** * Required. The Secret to delete, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsSecrets/{userWorkloadsSecretId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Get - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Get extends StandardParameters { /** * Required. The resource name of the Secret to get, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsSecrets/{userWorkloadsSecretId\}" */ name?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$List - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$List extends StandardParameters { /** * Optional. The maximum number of Secrets to return. */ @@ -5167,8 +5144,7 @@ export namespace composer_v1beta1 { */ parent?: string; } - export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Update - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Userworkloadssecrets$Update extends StandardParameters { /** * Identifier. The resource name of the Secret, in the form: "projects/{projectId\}/locations/{locationId\}/environments/{environmentId\}/userWorkloadsSecrets/{userWorkloadsSecretId\}" */ @@ -5335,8 +5311,7 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Environments$Workloads$List - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Environments$Workloads$List extends StandardParameters { /** * Optional. The list filter. Currently only supports equality on the type field. The value of a field specified in the filter expression must be one ComposerWorkloadType enum option. It's possible to get multiple types using "OR" operator, e.g.: "type=SCHEDULER OR type=CELERY_WORKER". If not specified, all items are returned. */ @@ -5510,8 +5485,7 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Imageversions$List - extends StandardParameters { + export interface Params$Resource$Projects$Locations$Imageversions$List extends StandardParameters { /** * Whether or not image versions from old releases should be included. */ @@ -5845,7 +5819,7 @@ export namespace composer_v1beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -5956,22 +5930,19 @@ export namespace composer_v1beta1 { } } - export interface Params$Resource$Projects$Locations$Operations$Delete - extends StandardParameters { + 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 { + 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 { + export interface Params$Resource$Projects$Locations$Operations$List extends StandardParameters { /** * The standard list filter. */ @@ -5989,7 +5960,7 @@ export namespace composer_v1beta1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/contactcenteraiplatform/v1alpha1.ts b/src/apis/contactcenteraiplatform/v1alpha1.ts index 4db8c7757c9..f193c2dece6 100644 --- a/src/apis/contactcenteraiplatform/v1alpha1.ts +++ b/src/apis/contactcenteraiplatform/v1alpha1.ts @@ -273,20 +273,150 @@ export namespace contactcenteraiplatform_v1alpha1 { */ peakHours?: Schema$WeeklySchedule[]; } + /** + * 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; + } + /** + * List of dates. + */ + export interface Schema$DateList { + /** + * Optional. Values in the list. + */ + values?: Schema$Date[]; + } + /** + * Represents civil time (or occasionally physical time). This type can represent a civil time in one of a few possible ways: * When utc_offset is set and time_zone is unset: a civil time on a calendar day with a particular offset from UTC. * When time_zone is set and utc_offset is unset: a civil time on a calendar day in a particular time zone. * When neither time_zone nor utc_offset is set: a civil time on a calendar day in local time. The date is relative to the Proleptic Gregorian Calendar. If year, month, or day are 0, the DateTime is considered not to have a specific year, month, or day respectively. This type may also be used to represent a physical time if all the date and time fields are set and either case of the `time_offset` oneof is set. Consider using `Timestamp` message for physical time instead. If your use case also would like to store the user's timezone, that can be done in another field. This type is more flexible than some applications may want. Make sure to document and validate your application's limitations. + */ + export interface Schema$DateTime { + /** + * Optional. Day of month. Must be from 1 to 31 and valid for the year and month, or 0 if specifying a datetime without a day. + */ + day?: number | null; + /** + * Optional. Hours of day in 24 hour format. Should be from 0 to 23, defaults to 0 (midnight). An API may choose to allow the value "24:00:00" for scenarios like business closing time. + */ + hours?: number | null; + /** + * Optional. Minutes of hour of day. Must be from 0 to 59, defaults to 0. + */ + minutes?: number | null; + /** + * Optional. Month of year. Must be from 1 to 12, or 0 if specifying a datetime without a month. + */ + month?: number | null; + /** + * Optional. Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999, defaults to 0. + */ + nanos?: number | null; + /** + * Optional. Seconds of minutes of the time. Must normally be from 0 to 59, defaults to 0. An API may allow the value 60 if it allows leap-seconds. + */ + seconds?: number | null; + /** + * Time zone. + */ + timeZone?: Schema$TimeZone; + /** + * UTC offset. Must be whole seconds, between -18 hours and +18 hours. For example, a UTC offset of -4:00 would be represented as { seconds: -14400 \}. + */ + utcOffset?: string | null; + /** + * Optional. Year of date. Must be from 1 to 9999, or 0 if specifying a datetime without a year. + */ + year?: number | null; + } /** * LINT.IfChange First Channel to receive the updates. Meant to dev/test instances */ export interface Schema$Early {} + /** + * Information about a particular employee for planning purposes. + */ + export interface Schema$EmployeeInfo { + /** + * Required. Unique ID of this employee. + */ + id?: string | null; + /** + * Optional. A list of unwanted event intervals for this employee. The start time of the interval must be in the planning horizon. + */ + unwantedEventIntervals?: Schema$UnwantedEventInterval[]; + } /** * 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 {} + /** + * Template specifying rules for generating a single event that occurs during a shift. An event may represent a meeting, break, lunch, etc. + */ + export interface Schema$EventTemplate { + /** + * Required. Fixed duration in minutes of this event. + */ + durationMinutes?: number | null; + /** + * Required. Unique ID of this template. + */ + id?: string | null; + /** + * Optional. Maximum number of minutes after the beginning of a shift that this event can start. + */ + maximumMinutesAfterShiftStart?: number | null; + /** + * Optional. Minimum number of minutes after the beginning of a shift that this event can start. + */ + minimumMinutesAfterShiftStart?: number | null; + /** + * Required. The time increment (in minutes) used to generate the set of possible event start times between `minimum_minutes_after_shift_start` and `maximum_minutes_after_shift_start`. For example, if the minimum minutes after shift start are 30, maximum minutes after shift start are 45, and the start time increment is 5 minutes, the event can take place 30, 35, 40, or 45 minutes after the start of the shift. + */ + startTimeIncrementMinutes?: number | null; + } export interface Schema$FeatureConfig { /** * Optional. If true - enables the agent desktop feature. Default is false. */ agentDesktopEnabled?: boolean | null; } + /** + * Request with constraints for generating shifts. The shifts generated must adhere to these constraints. + */ + export interface Schema$GenerateShiftsRequest { + /** + * Optional. Employee information that should be considered when generating shifts. + */ + employeeInfo?: Schema$EmployeeInfo[]; + /** + * Required. The solver will generate the maximum number of shifts per shift template. + */ + planningHorizon?: Schema$PlanningHorizon; + /** + * Required. Set of shift templates specifying rules for generating shifts. A shift template can be used for generating multiple shifts. + */ + shiftTemplates?: Schema$ShiftTemplate[]; + /** + * Optional. Parameters for the solver. + */ + solverConfig?: Schema$SolverConfig; + /** + * Required. All the workforce demands that the generated shifts need to cover. The planning horizon is defined between the earliest start time and the latest end time across all the entries. This field cannot be empty. + */ + workforceDemands?: Schema$WorkforceDemandList; + } /** * Represents the metadata of the long-running operation. */ @@ -467,6 +597,19 @@ export namespace contactcenteraiplatform_v1alpha1 { */ verb?: string | null; } + /** + * Specifies the time interval during which the solver should generate shifts. The start time must be before the end time. + */ + export interface Schema$PlanningHorizon { + /** + * Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored. + */ + endTime?: Schema$DateTime; + /** + * Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored. + */ + startTime?: Schema$DateTime; + } /** * Defines ingress and egress private traffic settings for CCAIP instances. */ @@ -543,6 +686,72 @@ export namespace contactcenteraiplatform_v1alpha1 { */ userEmail?: string | null; } + /** + * Template specifying rules for generating shifts. A shift is a unit of work that specifies a start time, end time, and may contain events (e.g. lunch, breaks etc.). Shifts will be assigned to specific dates in the response. + */ + export interface Schema$ShiftTemplate { + /** + * Optional. A list of specific employee IDs that can be assigned to shifts generated by this template. If this field is present, there will be `EmployeeSchedule`s in the response for which the `EmployeeSchedule.employee_id` field is set to one of the IDs in this list. The number of employee schedules with an assigned employee ID will be between `minimum_employee_count` and `maximum_employee_count`. If this field is empty, between `minimum_employee_count` and `maximum_employee_count` employees can be assigned to shifts generated by this template and the employee schedules won't have an assigned employee ID. Currently, only one assignable employee ID is supported. + */ + assignableEmployeeIds?: string[] | null; + /** + * Fixed number of days off per week. An employee has a given day off if they are not assigned to a shift that starts on that day. A week is 7 days and begins on Sunday. + */ + daysOffCountPerWeek?: number | null; + /** + * Fixed dates when shifts from this template should not be generated. + */ + daysOffDates?: Schema$DateList; + /** + * Required. Fixed duration of a shift generated by this template. + */ + durationMinutes?: number | null; + /** + * Required. Earliest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. + */ + earliestStartTime?: Schema$TimeOfDay; + /** + * Optional. Rules for generating events for each shift. Exactly one event will be included in each shift for each `EventTemplate` specified. + */ + eventTemplates?: Schema$EventTemplate[]; + /** + * Required. Unique ID of this template. + */ + id?: string | null; + /** + * Required. Latest time in the day that a shift can start. This value is specified with hours and minutes; seconds and nanos are ignored. If this value is less than the `earliest_start_time`, it may imply an overnight shift. + */ + latestStartTime?: Schema$TimeOfDay; + /** + * Required. Maximum number of employees that can be assigned to all shifts generated by this template on working days. + */ + maximumEmployeeCount?: number | null; + /** + * Optional. Minimum number of employees that can be assigned to all shifts generated by this template on working days. + */ + minimumEmployeeCount?: number | null; + /** + * Optional. Minimum minutes between the end of one event and the start of the next. + */ + minimumIntereventGapMinutes?: number | null; + /** + * Optional. The time increment (in minutes) used to generate the set of possible start times between `earliest_start_time` and `latest_start_time`. For example, if the earliest start time is 8:00, the latest start time is 8:30, and the start time increment is 10 minutes, then all possible start times for this shift template are: 8:00, 8:10, 8:20, and 8:30. + */ + startTimeIncrementMinutes?: number | null; + } + /** + * Specifies additional parameters for the solver generating shifts. + */ + export interface Schema$SolverConfig { + /** + * Optional. Maximum time the solver should spend on the problem. If not set, defaults to 1 minute. The choice of a time limit should depend on the size of the problem. To give an example, when solving a 7-day instance with 2 `ShiftTemplates`, each with ~20 possible start times and holding 2 events with ~30 possible start times, and two days off per week, recommended values are: <10s for fast solutions (and likely suboptimal), (10s, 300s) for good quality solutions, and \>300s for an exhaustive search. Larger instances may require longer time limits. This value is not a hard limit and it does not account for the communication overhead. The expected latency to solve the problem may slightly exceed this value. + */ + maximumProcessingDuration?: string | null; + /** + * Required. Specifies the type of schedule to generate. + */ + scheduleType?: 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). */ @@ -581,6 +790,32 @@ export namespace contactcenteraiplatform_v1alpha1 { */ seconds?: number | null; } + /** + * Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). + */ + export interface Schema$TimeZone { + /** + * IANA Time Zone Database time zone. For example "America/New_York". + */ + id?: string | null; + /** + * Optional. IANA Time Zone Database version number. For example "2019a". + */ + version?: string | null; + } + /** + * Specifies a time interval during which the overlap with events (generated from event templates) should be minimal. + */ + export interface Schema$UnwantedEventInterval { + /** + * Required. Duration of the event. + */ + durationMinutes?: number | null; + /** + * Required. Start time of the event. + */ + startTime?: Schema$DateTime; + } /** * Message storing the URIs of the ContactCenter. */ @@ -623,6 +858,32 @@ export namespace contactcenteraiplatform_v1alpha1 { */ startTime?: Schema$TimeOfDay; } + /** + * Specifies the number of employees required to cover the demand in the given time interval. The length of the interval must be strictly positive. + */ + export interface Schema$WorkforceDemand { + /** + * Optional. Number of employees needed to cover the demand for this interval. + */ + employeeCount?: number | null; + /** + * Required. End of the time interval for the given demand (exclusive). These values are read down to the minute; seconds and all smaller units are ignored. + */ + endTime?: Schema$DateTime; + /** + * Required. Start of the time interval for the given demand (inclusive). These values are read down to the minute; seconds and all smaller units are ignored. + */ + startTime?: Schema$DateTime; + } + /** + * List of workforce demands. + */ + export interface Schema$WorkforceDemandList { + /** + * Optional. Values in the list. + */ + values?: Schema$WorkforceDemand[]; + } export class Resource$Projects { context: APIRequestContext; @@ -647,6 +908,160 @@ export namespace contactcenteraiplatform_v1alpha1 { ); } + /** + * Generates shifts constrained by various parameters. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/contactcenteraiplatform.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const contactcenteraiplatform = google.contactcenteraiplatform('v1alpha1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/cloud-platform'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await contactcenteraiplatform.projects.locations.generateShifts({ + * // Required. Name of the parent resource associated with the request. Format: projects/{project\}/locations/{location\} + * parent: 'projects/my-project/locations/my-location', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "employeeInfo": [], + * // "planningHorizon": {}, + * // "shiftTemplates": [], + * // "solverConfig": {}, + * // "workforceDemands": {} + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "done": false, + * // "error": {}, + * // "metadata": {}, + * // "name": "my_name", + * // "response": {} + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + generateShifts( + params: Params$Resource$Projects$Locations$Generateshifts, + options: StreamMethodOptions + ): Promise>; + generateShifts( + params?: Params$Resource$Projects$Locations$Generateshifts, + options?: MethodOptions + ): Promise>; + generateShifts( + params: Params$Resource$Projects$Locations$Generateshifts, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateShifts( + params: Params$Resource$Projects$Locations$Generateshifts, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + generateShifts( + params: Params$Resource$Projects$Locations$Generateshifts, + callback: BodyResponseCallback + ): void; + generateShifts(callback: BodyResponseCallback): void; + generateShifts( + paramsOrCallback?: + | Params$Resource$Projects$Locations$Generateshifts + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Projects$Locations$Generateshifts; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Projects$Locations$Generateshifts; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = + options.rootUrl || 'https://contactcenteraiplatform.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/v1alpha1/{+parent}:generateShifts').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['parent'], + pathParams: ['parent'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Gets information about a location. * @example @@ -1079,6 +1494,17 @@ export namespace contactcenteraiplatform_v1alpha1 { } } + export interface Params$Resource$Projects$Locations$Generateshifts extends StandardParameters { + /** + * Required. Name of the parent resource associated with the request. Format: projects/{project\}/locations/{location\} + */ + parent?: string; + + /** + * Request body metadata + */ + requestBody?: Schema$GenerateShiftsRequest; + } export interface Params$Resource$Projects$Locations$Get extends StandardParameters { /** * Resource name for the location. diff --git a/src/apis/container/v1beta1.ts b/src/apis/container/v1beta1.ts index 17c9e024ca0..446cec98950 100644 --- a/src/apis/container/v1beta1.ts +++ b/src/apis/container/v1beta1.ts @@ -1822,6 +1822,27 @@ export namespace container_v1beta1 { */ desiredTier?: string | null; } + /** + * DisruptionEvent is a notification sent to customers about the disruption event of a resource. + */ + export interface Schema$DisruptionEvent { + /** + * The type of the disruption event. + */ + disruptionType?: string | null; + /** + * The node whose drain is blocked by PDB. This field is set for both POD_PDB_VIOLATION and POD_NOT_ENOUGH_PDB event. + */ + pdbBlockedNode?: string | null; + /** + * The pods whose evictions are blocked by PDB. This field is set for both POD_PDB_VIOLATION and POD_NOT_ENOUGH_PDB event. + */ + pdbBlockedPod?: Schema$PdbBlockedPod[]; + /** + * The timeout in seconds for which the node drain is blocked by PDB. After this timeout, pods are forcefully evicted. This field is only populated when event_type is POD_PDB_VIOLATION. + */ + pdbViolationTimeout?: string | null; + } /** * Configuration for NodeLocal DNSCache */ @@ -3268,6 +3289,15 @@ export namespace container_v1beta1 { */ nodeKubeletConfig?: Schema$NodeKubeletConfig; } + /** + * NodeDrainConfig contains the node drain related configurations for this nodepool. + */ + export interface Schema$NodeDrainConfig { + /** + * Whether to respect PDB during node pool deletion. + */ + respectPdbDuringNodePoolDeletion?: boolean | null; + } /** * Configuration for kernel module loading on nodes. */ @@ -3437,7 +3467,7 @@ export namespace container_v1beta1 { */ podRange?: string | null; /** - * Output only. The subnetwork path for the node pool. Format: projects/{project\}/regions/{region\}/subnetworks/{subnetwork\} If the cluster is associated with multiple subnetworks, the subnetwork for the node pool is picked based on the IP utilization during node pool creation and is immutable. + * The subnetwork path for the node pool. Format: projects/{project\}/regions/{region\}/subnetworks/{subnetwork\} If the cluster is associated with multiple subnetworks, the subnetwork for the node pool is picked based on the IP utilization during node pool creation and is immutable. */ subnetwork?: string | null; } @@ -3497,6 +3527,10 @@ export namespace container_v1beta1 { * Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults. */ networkConfig?: Schema$NodeNetworkConfig; + /** + * Specifies the node drain configuration for this node pool. + */ + nodeDrainConfig?: Schema$NodeDrainConfig; /** * Specifies the node placement policy. */ @@ -3816,6 +3850,19 @@ export namespace container_v1beta1 { */ productName?: string | null; } + /** + * The namespace/name of the pod whose eviction is blocked by PDB. + */ + export interface Schema$PdbBlockedPod { + /** + * The name of the pod. + */ + name?: string | null; + /** + * The namespace of the pod. + */ + namespace?: string | null; + } /** * PlacementPolicy defines the placement policy used by the node pool. */ @@ -5088,6 +5135,10 @@ export namespace container_v1beta1 { * The name (project, location, cluster, node pool) of the node pool to update. Specified in the format `projects/x/locations/x/clusters/x/nodePools/x`. */ name?: string | null; + /** + * The desired node drain configuration for nodes in the node pool. + */ + nodeDrainConfig?: Schema$NodeDrainConfig; /** * Node network config. */ @@ -5260,6 +5311,10 @@ export namespace container_v1beta1 { * A brief description of the event. */ description?: string | null; + /** + * The information about the disruption event. This field is only populated when event_type is DISRUPTION_EVENT. + */ + disruptionEvent?: Schema$DisruptionEvent; /** * The time when the operation ended. */ @@ -10414,6 +10469,7 @@ export namespace container_v1beta1 { * // "maxPodsConstraint": {}, * // "name": "my_name", * // "networkConfig": {}, + * // "nodeDrainConfig": {}, * // "placementPolicy": {}, * // "podIpv4CidrSize": 0, * // "queuedProvisioning": {}, @@ -11386,6 +11442,7 @@ export namespace container_v1beta1 { * // "machineType": "my_machineType", * // "maxRunDuration": "my_maxRunDuration", * // "name": "my_name", + * // "nodeDrainConfig": {}, * // "nodeNetworkConfig": {}, * // "nodePoolId": "my_nodePoolId", * // "nodeVersion": "my_nodeVersion", @@ -16740,6 +16797,7 @@ export namespace container_v1beta1 { * // "maxPodsConstraint": {}, * // "name": "my_name", * // "networkConfig": {}, + * // "nodeDrainConfig": {}, * // "placementPolicy": {}, * // "podIpv4CidrSize": 0, * // "queuedProvisioning": {}, @@ -17570,6 +17628,7 @@ export namespace container_v1beta1 { * // "machineType": "my_machineType", * // "maxRunDuration": "my_maxRunDuration", * // "name": "my_name", + * // "nodeDrainConfig": {}, * // "nodeNetworkConfig": {}, * // "nodePoolId": "my_nodePoolId", * // "nodeVersion": "my_nodeVersion", diff --git a/src/apis/dataform/v1.ts b/src/apis/dataform/v1.ts index 25dce768bd9..3867481ba9f 100644 --- a/src/apis/dataform/v1.ts +++ b/src/apis/dataform/v1.ts @@ -472,6 +472,10 @@ export namespace dataform_v1 { * Output only. The compilation result's name. */ name?: string | null; + /** + * Output only. Metadata indicating whether this resource is user-scoped. `CompilationResult` resource is `user_scoped` only if it is sourced from a workspace. + */ + privateResourceMetadata?: Schema$PrivateResourceMetadata; /** * Immutable. The name of the release config to compile. Must be in the format `projects/x/locations/x/repositories/x/releaseConfigs/x`. */ @@ -932,7 +936,7 @@ export namespace dataform_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -1282,6 +1286,15 @@ export namespace dataform_v1 { */ type?: string | null; } + /** + * Metadata used to identify if a resource is user scoped. + */ + export interface Schema$PrivateResourceMetadata { + /** + * Output only. If true, this resource is user-scoped, meaning it is either a workspace or sourced from a workspace. + */ + userScoped?: boolean | null; + } /** * `PullGitCommits` request message. */ @@ -1854,6 +1867,10 @@ export namespace dataform_v1 { * Output only. The workflow invocation's name. */ name?: string | null; + /** + * Output only. Metadata indicating whether this resource is user-scoped. `WorkflowInvocation` resource is `user_scoped` only if it is sourced from a compilation result and the compilation result is user-scoped. + */ + privateResourceMetadata?: Schema$PrivateResourceMetadata; /** * Output only. The resolved compilation result that was used to create this invocation. Will be in the format `projects/x/locations/x/repositories/x/compilationResults/x`. */ @@ -1928,6 +1945,10 @@ export namespace dataform_v1 { * Identifier. The workspace's name. */ name?: string | null; + /** + * Output only. Metadata indicating whether this resource is user-scoped. For `Workspace` resources, the `user_scoped` field is always `true`. + */ + privateResourceMetadata?: Schema$PrivateResourceMetadata; } /** * Configures workspace compilation overrides for a repository. @@ -3587,7 +3608,7 @@ export namespace dataform_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -3739,7 +3760,7 @@ export namespace dataform_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -6150,6 +6171,7 @@ export namespace dataform_v1 { * // "gitCommitish": "my_gitCommitish", * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "releaseConfig": "my_releaseConfig", * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", * // "workspace": "my_workspace" @@ -6168,6 +6190,7 @@ export namespace dataform_v1 { * // "gitCommitish": "my_gitCommitish", * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "releaseConfig": "my_releaseConfig", * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", * // "workspace": "my_workspace" @@ -6320,6 +6343,7 @@ export namespace dataform_v1 { * // "gitCommitish": "my_gitCommitish", * // "internalMetadata": "my_internalMetadata", * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "releaseConfig": "my_releaseConfig", * // "resolvedGitCommitSha": "my_resolvedGitCommitSha", * // "workspace": "my_workspace" @@ -8677,6 +8701,7 @@ export namespace dataform_v1 { * // "invocationConfig": {}, * // "invocationTiming": {}, * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "resolvedCompilationResult": "my_resolvedCompilationResult", * // "state": "my_state", * // "workflowConfig": "my_workflowConfig" @@ -8693,6 +8718,7 @@ export namespace dataform_v1 { * // "invocationConfig": {}, * // "invocationTiming": {}, * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "resolvedCompilationResult": "my_resolvedCompilationResult", * // "state": "my_state", * // "workflowConfig": "my_workflowConfig" @@ -8980,6 +9006,7 @@ export namespace dataform_v1 { * // "invocationConfig": {}, * // "invocationTiming": {}, * // "name": "my_name", + * // "privateResourceMetadata": {}, * // "resolvedCompilationResult": "my_resolvedCompilationResult", * // "state": "my_state", * // "workflowConfig": "my_workflowConfig" @@ -9669,7 +9696,8 @@ export namespace dataform_v1 { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" + * // "name": "my_name", + * // "privateResourceMetadata": {} * // } * }, * }); @@ -9680,7 +9708,8 @@ export namespace dataform_v1 { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" + * // "name": "my_name", + * // "privateResourceMetadata": {} * // } * } * @@ -10410,7 +10439,8 @@ export namespace dataform_v1 { * // "createTime": "my_createTime", * // "dataEncryptionState": {}, * // "internalMetadata": "my_internalMetadata", - * // "name": "my_name" + * // "name": "my_name", + * // "privateResourceMetadata": {} * // } * } * diff --git a/src/apis/datafusion/v1.ts b/src/apis/datafusion/v1.ts index 8dc321be068..cf096885a2b 100644 --- a/src/apis/datafusion/v1.ts +++ b/src/apis/datafusion/v1.ts @@ -340,6 +340,10 @@ export namespace datafusion_v1 { * Optional. Configure the maintenance policy for this instance. */ maintenancePolicy?: Schema$MaintenancePolicy; + /** + * Optional. The monitoring configuration for this instance. + */ + monitoringConfig?: Schema$MonitoringConfig; /** * Output only. The name of this instance is in the form of projects/{project\}/locations/{location\}/instances/{instance\}. */ @@ -567,6 +571,15 @@ export namespace datafusion_v1 { */ recurringTimeWindow?: Schema$RecurringTimeWindow; } + /** + * Monitoring configuration for a Data Fusion instance. + */ + export interface Schema$MonitoringConfig { + /** + * Optional. Option to enable the instance v2 metrics for this instance. This field is supported only in CDF versions 6.11.1.1 and above. + */ + enableInstanceV2Metrics?: boolean | null; + } /** * Network configuration for a Data Fusion instance. These configurations are used for peering with the customer network. Configurations are optional when a public Data Fusion instance is to be created. However, providing these configurations allows several benefits, such as reduced network latency while accessing the customer resources from managed Data Fusion instance nodes, as well as access to the customer on-prem resources. */ @@ -1197,6 +1210,7 @@ export namespace datafusion_v1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, @@ -1524,6 +1538,7 @@ export namespace datafusion_v1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, @@ -1990,6 +2005,7 @@ export namespace datafusion_v1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, diff --git a/src/apis/datafusion/v1beta1.ts b/src/apis/datafusion/v1beta1.ts index 98ed1d8b777..30d398cf3e3 100644 --- a/src/apis/datafusion/v1beta1.ts +++ b/src/apis/datafusion/v1beta1.ts @@ -353,6 +353,10 @@ export namespace datafusion_v1beta1 { * Optional. Configure the maintenance policy for this instance. */ maintenancePolicy?: Schema$MaintenancePolicy; + /** + * Optional. The monitoring configuration for this instance. + */ + monitoringConfig?: Schema$MonitoringConfig; /** * Output only. The name of this instance is in the form of projects/{project\}/locations/{location\}/instances/{instance\}. */ @@ -593,6 +597,15 @@ export namespace datafusion_v1beta1 { */ recurringTimeWindow?: Schema$RecurringTimeWindow; } + /** + * Monitoring configuration for a Data Fusion instance. + */ + export interface Schema$MonitoringConfig { + /** + * Optional. Option to enable the instance v2 metrics for this instance. This field is supported only in CDF versions 6.11.1.1 and above. + */ + enableInstanceV2Metrics?: boolean | null; + } /** * Represents the information of a namespace */ @@ -1408,6 +1421,7 @@ export namespace datafusion_v1beta1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, @@ -1735,6 +1749,7 @@ export namespace datafusion_v1beta1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, @@ -2201,6 +2216,7 @@ export namespace datafusion_v1beta1 { * // "loggingConfig": {}, * // "maintenanceEvents": [], * // "maintenancePolicy": {}, + * // "monitoringConfig": {}, * // "name": "my_name", * // "networkConfig": {}, * // "options": {}, diff --git a/src/apis/dataplex/v1.ts b/src/apis/dataplex/v1.ts index f9c24c491e0..c8b65a0c4ac 100644 --- a/src/apis/dataplex/v1.ts +++ b/src/apis/dataplex/v1.ts @@ -1173,7 +1173,12 @@ export namespace dataplex_v1 { /** * DataDocumentation scan related spec. */ - export interface Schema$GoogleCloudDataplexV1DataDocumentationSpec {} + export interface Schema$GoogleCloudDataplexV1DataDocumentationSpec { + /** + * Optional. Whether to publish result to Dataplex Catalog. + */ + catalogPublishingEnabled?: boolean | null; + } /** * DataProfileResult defines the output of DataProfileScan. Each field of the table will have field type specific profile result. */ @@ -4921,7 +4926,7 @@ export namespace dataplex_v1 { */ operations?: Schema$GoogleLongrunningOperation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -6818,7 +6823,7 @@ export namespace dataplex_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -6978,7 +6983,7 @@ export namespace dataplex_v1 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -39113,7 +39118,7 @@ export namespace dataplex_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -39273,7 +39278,7 @@ export namespace dataplex_v1 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/developerconnect/v1.ts b/src/apis/developerconnect/v1.ts index e53fbe350c2..e335e4e445e 100644 --- a/src/apis/developerconnect/v1.ts +++ b/src/apis/developerconnect/v1.ts @@ -225,7 +225,7 @@ export namespace developerconnect_v1 { */ readAuthorizerCredential?: Schema$UserCredential; /** - * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x`. This is used to validate and create webhooks. + * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). This is used to validate and create webhooks. */ webhookSecretSecretVersion?: string | null; /** @@ -262,7 +262,7 @@ export namespace developerconnect_v1 { */ sslCaCertificate?: string | null; /** - * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + * Required. Immutable. SecretManager resource containing the webhook secret used to verify webhook events, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). This is used to validate webhooks. */ webhookSecretSecretVersion?: string | null; } @@ -525,7 +525,7 @@ export namespace developerconnect_v1 { */ installationUri?: string | null; /** - * Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/x/secrets/x/versions/x`. + * Optional. SecretManager resource containing the private key of the GitHub App, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). */ privateKeySecretVersion?: string | null; /** @@ -541,7 +541,7 @@ export namespace developerconnect_v1 { */ sslCaCertificate?: string | null; /** - * Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/x/secrets/x/versions/x`. + * Optional. SecretManager resource containing the webhook secret of the GitHub App, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). */ webhookSecretSecretVersion?: string | null; } @@ -558,7 +558,7 @@ export namespace developerconnect_v1 { */ readAuthorizerCredential?: Schema$UserCredential; /** - * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). This is used to validate webhooks. */ webhookSecretSecretVersion?: string | null; } @@ -591,7 +591,7 @@ export namespace developerconnect_v1 { */ sslCaCertificate?: string | null; /** - * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x`. This is used to validate webhooks. + * Required. Immutable. SecretManager resource containing the webhook secret of a GitLab project, formatted as `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). This is used to validate webhooks. */ webhookSecretSecretVersion?: string | null; } @@ -955,7 +955,7 @@ export namespace developerconnect_v1 { */ export interface Schema$OAuthCredential { /** - * Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/x/secrets/x/versions/x`. + * Required. A SecretManager resource containing the OAuth token that authorizes the connection. Format: `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). */ oauthTokenSecretVersion?: string | null; /** @@ -1164,7 +1164,7 @@ export namespace developerconnect_v1 { */ username?: string | null; /** - * Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/x/secrets/x/versions/x`. + * Required. A SecretManager resource containing the user token that authorizes the Developer Connect connection. Format: `projects/x/secrets/x/versions/x` or `projects/x/locations/x/secrets/x/versions/x` (if regional secrets are supported in that location). */ userTokenSecretVersion?: string | null; } diff --git a/src/apis/dialogflow/v3beta1.ts b/src/apis/dialogflow/v3beta1.ts index 708e03482fa..3e5f76b09d0 100644 --- a/src/apis/dialogflow/v3beta1.ts +++ b/src/apis/dialogflow/v3beta1.ts @@ -4703,10 +4703,18 @@ export namespace dialogflow_v3beta1 { * Optional. Default phrase match strategy for banned phrases. */ defaultBannedPhraseMatchStrategy?: string | null; + /** + * Optional. Immutable. Default RAI settings to be annotated on the agent, so that users will be able to restore their RAI configurations to the default settings. Read-only field for the API proto only. + */ + defaultRaiSettings?: Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings; /** * Optional. Settings for prompt security checks. */ promptSecuritySettings?: Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsPromptSecuritySettings; + /** + * Optional. Settings for Responsible AI checks. + */ + raiSettings?: Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings; } /** * Text input which can be used for prompt or banned phrases. @@ -4730,6 +4738,28 @@ export namespace dialogflow_v3beta1 { */ enablePromptSecurity?: boolean | null; } + /** + * Settings for Responsible AI. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettings { + /** + * Optional. RAI blocking configurations. + */ + categoryFilters?: Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettingsCategoryFilter[]; + } + /** + * Configuration of the sensitivity level for blocking an RAI category. + */ + export interface Schema$GoogleCloudDialogflowCxV3beta1SafetySettingsRaiSettingsCategoryFilter { + /** + * RAI category to configure. + */ + category?: string | null; + /** + * Blocking sensitivity level to configure for the RAI category. + */ + filterLevel?: string | null; + } /** * Search configuration for UCS search queries. */ @@ -12282,7 +12312,7 @@ export namespace dialogflow_v3beta1 { */ operations?: Schema$GoogleLongrunningOperation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -38943,7 +38973,7 @@ export namespace dialogflow_v3beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -39092,7 +39122,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -40293,7 +40323,7 @@ export namespace dialogflow_v3beta1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -40442,7 +40472,7 @@ export namespace dialogflow_v3beta1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/displayvideo/v3.ts b/src/apis/displayvideo/v3.ts index ffc3e4b83ba..2ddad9cf5a4 100644 --- a/src/apis/displayvideo/v3.ts +++ b/src/apis/displayvideo/v3.ts @@ -1879,26 +1879,6 @@ export namespace displayvideo_v3 { */ 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. */ @@ -3741,31 +3721,6 @@ export namespace displayvideo_v3 { */ gender?: string | null; } - /** - * Request message for LineItemService.GenerateDefaultLineItem. - */ - export interface Schema$GenerateDefaultLineItemRequest { - /** - * Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**. - */ - containsEuPoliticalAds?: 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. 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`. */ @@ -4791,19 +4746,6 @@ export namespace displayvideo_v3 { */ 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. @@ -4924,16 +4866,6 @@ export namespace displayvideo_v3 { */ 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. @@ -9723,12 +9655,8 @@ export namespace displayvideo_v3 { 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 - ); } /** @@ -10337,166 +10265,6 @@ export namespace displayvideo_v3 { } } - /** - * Lists assigned targeting options of a campaign across targeting types. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = - * await displayvideo.advertisers.campaigns.listAssignedTargetingOptions({ - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the campaign to list assigned targeting options for. - * campaignId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - listAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Campaigns$Listassignedtargetingoptions, - options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - 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 - | Promise< - GaxiosResponseWithHTTP2 - > - | Promise> { - 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', - apiVersion: '', - }, - 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. * @example @@ -10721,32 +10489,6 @@ export namespace displayvideo_v3 { */ 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. @@ -10767,26 +10509,16 @@ export namespace displayvideo_v3 { 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 { + 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); } /** - * Gets a single targeting option assigned to a campaign. + * Creates a new channel. Returns the newly created channel if successful. * @example * ```js * // Before running the sample: @@ -10815,77 +10547,37 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this campaign that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the campaign the assigned targeting option belongs to. - * campaignId: '[^/]+', - * // 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: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.channels.create({ + * // The ID of the advertiser that owns the created channel. + * advertiserId: '[^/]+', + * // The ID of the partner that owns the created channel. + * partnerId: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" * // } * } * @@ -10901,56 +10593,53 @@ export namespace displayvideo_v3 { * @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, + create( + params: Params$Resource$Advertisers$Channels$Create, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + create( + params?: Params$Resource$Advertisers$Channels$Create, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, + ): Promise>; + create( + params: Params$Resource$Advertisers$Channels$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Create, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Channels$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Advertisers$Channels$Create; options = {}; } @@ -10963,42 +10652,32 @@ export namespace displayvideo_v3 { const parameters = { options: Object.assign( { - url: ( - rootUrl + - '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' - ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + url: (rootUrl + '/v3/advertisers/{+advertiserId}/channels').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'campaignId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'campaignId', - 'targetingType', - ], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the targeting options assigned to a campaign for a specified targeting type. + * Gets a channel for a partner or advertiser. * @example * ```js * // Before running the sample: @@ -11027,31 +10706,25 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.campaigns.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser the campaign belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the campaign to list assigned targeting options for. - * campaignId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.channels.get({ + * // The ID of the advertiser that owns the fetched channel. + * advertiserId: '[^/]+', + * // Required. The ID of the channel to fetch. + * channelId: '[^/]+', + * // The ID of the partner that owns the fetched channel. + * partnerId: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" * // } * } * @@ -11067,62 +10740,53 @@ export namespace displayvideo_v3 { * @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, + get( + params: Params$Resource$Advertisers$Channels$Get, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + get( + params?: Params$Resource$Advertisers$Channels$Get, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List, + ): Promise>; + get( + params: Params$Resource$Advertisers$Channels$Get, 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 + get( + params: Params$Resource$Advertisers$Channels$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Channels$Get, + callback: BodyResponseCallback ): void; - list( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Channels$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Campaigns$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Advertisers$Channels$Get; options = {}; } @@ -11136,8 +10800,7 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + - '/v3/advertisers/{+advertiserId}/campaigns/{+campaignId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + rootUrl + '/v3/advertisers/{+advertiserId}/channels/{+channelId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -11145,82 +10808,22 @@ export namespace displayvideo_v3 { options ), params, - requiredParams: ['advertiserId', 'campaignId', 'targetingType'], - pathParams: ['advertiserId', 'campaignId', 'targetingType'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + 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. + * Lists channels for a partner or advertiser. * @example * ```js * // Before running the sample: @@ -11249,37 +10852,26 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.create({ - * // The ID of the advertiser that owns the created channel. + * const res = await displayvideo.advertisers.channels.list({ + * // The ID of the advertiser that owns the channels. * advertiserId: '[^/]+', - * // The ID of the partner that owns the created channel. - * partnerId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" - * // } - * }, + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // The ID of the partner that owns the channels. + * partnerId: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", - * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // "channels": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -11295,53 +10887,55 @@ export namespace displayvideo_v3 { * @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, + list( + params: Params$Resource$Advertisers$Channels$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Channels$Create, + list( + params?: Params$Resource$Advertisers$Channels$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Channels$Create, + ): Promise>; + list( + params: Params$Resource$Advertisers$Channels$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$List, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Create; + {}) as Params$Resource$Advertisers$Channels$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Create; + params = {} as Params$Resource$Advertisers$Channels$List; options = {}; } @@ -11358,7 +10952,7 @@ export namespace displayvideo_v3 { /([^:]\/)\/+/g, '$1' ), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -11369,17 +10963,17 @@ export namespace displayvideo_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a channel for a partner or advertiser. + * Updates a channel. Returns the updated channel if successful. * @example * ```js * // Before running the sample: @@ -11408,13 +11002,29 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.get({ - * // The ID of the advertiser that owns the fetched channel. + * const res = await displayvideo.advertisers.channels.patch({ + * // The ID of the advertiser that owns the created channel. * advertiserId: '[^/]+', - * // Required. The ID of the channel to fetch. - * channelId: '[^/]+', - * // The ID of the partner that owns the fetched channel. + * // Output only. The unique ID of the channel. Assigned by the system. + * channelId: 'placeholder-value', + * // The ID of the partner that owns the created channel. * partnerId: 'placeholder-value', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "channelId": "my_channelId", + * // "displayName": "my_displayName", + * // "name": "my_name", + * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", + * // "partnerId": "my_partnerId", + * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // } + * }, * }); * console.log(res.data); * @@ -11442,32 +11052,32 @@ export namespace displayvideo_v3 { * @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, + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Channels$Get, + patch( + params?: Params$Resource$Advertisers$Channels$Patch, options?: MethodOptions ): Promise>; - get( - params: Params$Resource$Advertisers$Channels$Get, + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Channels$Get, + patch( + params: Params$Resource$Advertisers$Channels$Patch, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Channels$Get, + patch( + params: Params$Resource$Advertisers$Channels$Patch, callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Get + | Params$Resource$Advertisers$Channels$Patch | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -11483,12 +11093,12 @@ export namespace displayvideo_v3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Get; + {}) as Params$Resource$Advertisers$Channels$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Get; + params = {} as Params$Resource$Advertisers$Channels$Patch; options = {}; } @@ -11502,9 +11112,9 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + '/v3/advertisers/{+advertiserId}/channels/{+channelId}' + rootUrl + '/v3/advertisers/{+advertiserId}/channels/{channelId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options @@ -11523,9 +11133,95 @@ export namespace displayvideo_v3 { return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Create extends StandardParameters { /** - * Lists channels for a partner or advertiser. + * 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. * @example * ```js * // Before running the sample: @@ -11554,27 +11250,29 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.list({ - * // The ID of the advertiser that owns the channels. - * advertiserId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // The ID of the partner that owns the channels. - * partnerId: 'placeholder-value', - * }); - * console.log(res.data); + * const res = await displayvideo.advertisers.channels.sites.bulkEdit({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel to which the sites belong. + * channelId: '[^/]+', * - * // Example response - * // { - * // "channels": [], - * // "nextPageToken": "my_nextPageToken" - * // } + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "createdSites": [], + * // "deletedSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "sites": [] + * // } * } * * main().catch(e => { @@ -11589,55 +11287,57 @@ export namespace displayvideo_v3 { * @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, + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Channels$List, + bulkEdit( + params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options?: MethodOptions - ): Promise>; - list( - params: Params$Resource$Advertisers$Channels$List, + ): Promise>; + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Channels$List, + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Channels$List, - callback: BodyResponseCallback + bulkEdit( + params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + callback: BodyResponseCallback ): void; - list(callback: BodyResponseCallback): void; - list( + bulkEdit( + callback: BodyResponseCallback + ): void; + bulkEdit( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$List - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Bulkedit + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$List; + {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$List; + params = {} as Params$Resource$Advertisers$Channels$Sites$Bulkedit; options = {}; } @@ -11650,32 +11350,32 @@ export namespace displayvideo_v3 { const parameters = { options: Object.assign( { - url: (rootUrl + '/v3/advertisers/{+advertiserId}/channels').replace( - /([^:]\/)\/+/g, - '$1' - ), - method: 'GET', + url: ( + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Updates a channel. Returns the updated channel if successful. + * Creates a site in a channel. * @example * ```js * // Before running the sample: @@ -11704,27 +11404,20 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.patch({ - * // The ID of the advertiser that owns the created channel. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the channel. Assigned by the system. - * channelId: 'placeholder-value', - * // The ID of the partner that owns the created channel. + * const res = await displayvideo.advertisers.channels.sites.create({ + * // The ID of the advertiser that owns the parent channel. + * advertiserId: 'placeholder-value', + * // Required. The ID of the parent channel in which the site will be created. + * channelId: '[^/]+', + * // The ID of the partner that owns the parent channel. * partnerId: 'placeholder-value', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { * // request body parameters * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // "urlOrAppId": "my_urlOrAppId" * // } * }, * }); @@ -11732,13 +11425,8 @@ export namespace displayvideo_v3 { * * // Example response * // { - * // "advertiserId": "my_advertiserId", - * // "channelId": "my_channelId", - * // "displayName": "my_displayName", * // "name": "my_name", - * // "negativelyTargetedLineItemCount": "my_negativelyTargetedLineItemCount", - * // "partnerId": "my_partnerId", - * // "positivelyTargetedLineItemCount": "my_positivelyTargetedLineItemCount" + * // "urlOrAppId": "my_urlOrAppId" * // } * } * @@ -11754,53 +11442,53 @@ export namespace displayvideo_v3 { * @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, + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Channels$Patch, + create( + params?: Params$Resource$Advertisers$Channels$Sites$Create, options?: MethodOptions - ): Promise>; - patch( - params: Params$Resource$Advertisers$Channels$Patch, + ): Promise>; + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Channels$Patch, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Channels$Patch, - callback: BodyResponseCallback + create( + params: Params$Resource$Advertisers$Channels$Sites$Create, + callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Patch - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Patch; + {}) as Params$Resource$Advertisers$Channels$Sites$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Channels$Patch; + params = {} as Params$Resource$Advertisers$Channels$Sites$Create; options = {}; } @@ -11814,9 +11502,10 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + '/v3/advertisers/{+advertiserId}/channels/{channelId}' + rootUrl + + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, options @@ -11827,103 +11516,17 @@ export namespace displayvideo_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. + * Deletes a site from a channel. * @example * ```js * // Before running the sample: @@ -11952,29 +11555,20 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.bulkEdit({ + * const res = await displayvideo.advertisers.channels.sites.delete({ * // The ID of the advertiser that owns the parent channel. * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel to which the sites belong. + * // Required. The ID of the parent channel to which the site belongs. * channelId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "createdSites": [], - * // "deletedSites": [], - * // "partnerId": "my_partnerId" - * // } - * }, + * // The ID of the partner that owns the parent channel. + * partnerId: 'placeholder-value', + * // Required. The URL or app ID of the site to delete. + * urlOrAppId: '[^/]+', * }); * console.log(res.data); * * // Example response - * // { - * // "sites": [] - * // } + * // {} * } * * main().catch(e => { @@ -11989,57 +11583,53 @@ export namespace displayvideo_v3 { * @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, + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, options: StreamMethodOptions ): Promise>; - bulkEdit( - params?: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + delete( + params?: Params$Resource$Advertisers$Channels$Sites$Delete, options?: MethodOptions - ): Promise>; - bulkEdit( - params: Params$Resource$Advertisers$Channels$Sites$Bulkedit, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, 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 + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - bulkEdit( - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Channels$Sites$Delete, + callback: BodyResponseCallback ): void; - bulkEdit( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Bulkedit - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Bulkedit; + {}) 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$Bulkedit; + params = {} as Params$Resource$Advertisers$Channels$Sites$Delete; options = {}; } @@ -12054,30 +11644,30 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites:bulkEdit' + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId'], - pathParams: ['advertiserId', 'channelId'], + requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], + pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Creates a site in a channel. + * Lists sites in a channel. * @example * ```js * // Before running the sample: @@ -12106,29 +11696,28 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.create({ + * const res = await displayvideo.advertisers.channels.sites.list({ * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel in which the site will be created. + * advertiserId: '[^/]+', + * // Required. The ID of the parent channel to which the requested sites belong. * channelId: '[^/]+', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', * // The ID of the partner that owns the parent channel. * partnerId: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "name": "my_name", - * // "urlOrAppId": "my_urlOrAppId" - * // } - * }, * }); * console.log(res.data); * * // Example response * // { - * // "name": "my_name", - * // "urlOrAppId": "my_urlOrAppId" + * // "nextPageToken": "my_nextPageToken", + * // "sites": [] * // } * } * @@ -12144,53 +11733,53 @@ export namespace displayvideo_v3 { * @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, + list( + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Channels$Sites$Create, + list( + params?: Params$Resource$Advertisers$Channels$Sites$List, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, + ): Promise>; + list( + params: Params$Resource$Advertisers$Channels$Sites$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - params: Params$Resource$Advertisers$Channels$Sites$Create, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Channels$Sites$List, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; - create( + list(callback: BodyResponseCallback): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Create; + {}) 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$Create; + params = {} as Params$Resource$Advertisers$Channels$Sites$List; options = {}; } @@ -12205,9 +11794,9 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites' + '/v3/advertisers/{+advertiserId}/channels/{+channelId}/sites' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'GET', apiVersion: '', }, options @@ -12218,17 +11807,17 @@ export namespace displayvideo_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Deletes a site from a channel. + * Replaces all of the sites under a single channel. The operation will replace the sites under a channel with the sites provided in ReplaceSitesRequest.new_sites. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. * @example * ```js * // Before running the sample: @@ -12257,20 +11846,28 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.delete({ + * const res = await displayvideo.advertisers.channels.sites.replace({ * // The ID of the advertiser that owns the parent channel. * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel to which the site belongs. + * // Required. The ID of the parent channel whose sites will be replaced. * channelId: '[^/]+', - * // The ID of the partner that owns the parent channel. - * partnerId: 'placeholder-value', - * // Required. The URL or app ID of the site to delete. - * urlOrAppId: '[^/]+', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "newSites": [], + * // "partnerId": "my_partnerId" + * // } + * }, * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "sites": [] + * // } * } * * main().catch(e => { @@ -12285,53 +11882,55 @@ export namespace displayvideo_v3 { * @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, + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Channels$Sites$Delete, + replace( + params?: Params$Resource$Advertisers$Channels$Sites$Replace, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, + ): Promise>; + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + options: + | MethodOptions + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Channels$Sites$Delete, - callback: BodyResponseCallback + replace( + params: Params$Resource$Advertisers$Channels$Sites$Replace, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + replace(callback: BodyResponseCallback): void; + replace( paramsOrCallback?: - | Params$Resource$Advertisers$Channels$Sites$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Channels$Sites$Replace + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Channels$Sites$Delete; + {}) 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$Delete; + params = {} as Params$Resource$Advertisers$Channels$Sites$Replace; options = {}; } @@ -12346,1465 +11945,135 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites/{+urlOrAppId}' + '/v3/advertisers/{advertiserId}/channels/{+channelId}/sites:replace' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'POST', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'channelId', 'urlOrAppId'], - pathParams: ['advertiserId', 'channelId', 'urlOrAppId'], + requiredParams: ['advertiserId', 'channelId'], + pathParams: ['advertiserId', 'channelId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Channels$Sites$Bulkedit extends StandardParameters { /** - * Lists sites in a channel. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.list({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: '[^/]+', - * // Required. The ID of the parent channel to which the requested sites belong. - * channelId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // The ID of the partner that owns the parent channel. - * partnerId: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "nextPageToken": "my_nextPageToken", - * // "sites": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - list( - params?: Params$Resource$Advertisers$Channels$Sites$List, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.channels.sites.replace({ - * // The ID of the advertiser that owns the parent channel. - * advertiserId: 'placeholder-value', - * // Required. The ID of the parent channel whose sites will be replaced. - * channelId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "advertiserId": "my_advertiserId", - * // "newSites": [], - * // "partnerId": "my_partnerId" - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "sites": [] - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - replace( - params?: Params$Resource$Advertisers$Channels$Sites$Replace, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.creatives.create({ - * // Output only. The unique ID of the advertiser the creative belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - create( - params?: Params$Resource$Advertisers$Creatives$Create, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.creatives.delete({ - * // The ID of the advertiser this creative belongs to. - * advertiserId: '[^/]+', - * // The ID of the creative to be deleted. - * creativeId: '[^/]+', - * }); - * console.log(res.data); - * - * // Example response - * // {} - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - delete( - params?: Params$Resource$Advertisers$Creatives$Delete, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.creatives.get({ - * // Required. The ID of the advertiser this creative belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the creative to fetch. - * creativeId: '[^/]+', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - get( - params?: Params$Resource$Advertisers$Creatives$Get, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.creatives.list({ - * // Required. The ID of the advertiser to list creatives for. - * advertiserId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "creatives": [], - * // "nextPageToken": "my_nextPageToken" - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - list( - params?: Params$Resource$Advertisers$Creatives$List, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - 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. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.creatives.patch({ - * // Output only. The unique ID of the advertiser the creative belongs to. - * advertiserId: '[^/]+', - * // Output only. The unique ID of the creative. Assigned by the system. - * creativeId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "additionalDimensions": [], - * // "advertiserId": "my_advertiserId", - * // "appendedTag": "my_appendedTag", - * // "assets": [], - * // "cmPlacementId": "my_cmPlacementId", - * // "cmTrackingAd": {}, - * // "companionCreativeIds": [], - * // "counterEvents": [], - * // "createTime": "my_createTime", - * // "creativeAttributes": [], - * // "creativeId": "my_creativeId", - * // "creativeType": "my_creativeType", - * // "dimensions": {}, - * // "displayName": "my_displayName", - * // "dynamic": false, - * // "entityStatus": "my_entityStatus", - * // "exitEvents": [], - * // "expandOnHover": false, - * // "expandingDirection": "my_expandingDirection", - * // "hostingSource": "my_hostingSource", - * // "html5Video": false, - * // "iasCampaignMonitoring": false, - * // "integrationCode": "my_integrationCode", - * // "jsTrackerUrl": "my_jsTrackerUrl", - * // "lineItemIds": [], - * // "mediaDuration": "my_mediaDuration", - * // "mp3Audio": false, - * // "name": "my_name", - * // "notes": "my_notes", - * // "obaIcon": {}, - * // "oggAudio": false, - * // "progressOffset": {}, - * // "requireHtml5": false, - * // "requireMraid": false, - * // "requirePingForAttribution": false, - * // "reviewStatus": {}, - * // "skipOffset": {}, - * // "skippable": false, - * // "thirdPartyTag": "my_thirdPartyTag", - * // "thirdPartyUrls": [], - * // "timerEvents": [], - * // "trackerUrls": [], - * // "transcodes": [], - * // "universalAdId": {}, - * // "updateTime": "my_updateTime", - * // "vastTagUrl": "my_vastTagUrl", - * // "vpaid": false - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 ID of the advertiser that owns the parent channel. */ - patch( - params: Params$Resource$Advertisers$Creatives$Patch, - options: StreamMethodOptions - ): Promise>; - patch( - params?: Params$Resource$Advertisers$Creatives$Patch, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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 = {}; - } + advertiserId?: string; + /** + * Required. The ID of the parent channel to which the sites belong. + */ + channelId?: string; - 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', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['advertiserId', 'creativeId'], - pathParams: ['advertiserId', 'creativeId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } + /** + * Request body metadata + */ + requestBody?: Schema$BulkEditSitesRequest; } - - export interface Params$Resource$Advertisers$Creatives$Create extends StandardParameters { + export interface Params$Resource$Advertisers$Channels$Sites$Create extends StandardParameters { /** - * Output only. The unique ID of the advertiser the creative belongs to. + * 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$Creative; + requestBody?: Schema$Site; } - export interface Params$Resource$Advertisers$Creatives$Delete extends StandardParameters { + export interface Params$Resource$Advertisers$Channels$Sites$Delete extends StandardParameters { /** - * The ID of the advertiser this creative belongs to. + * The ID of the advertiser that owns the parent channel. */ advertiserId?: string; /** - * The ID of the creative to be deleted. + * Required. The ID of the parent channel to which the site belongs. */ - creativeId?: string; - } - export interface Params$Resource$Advertisers$Creatives$Get extends StandardParameters { + channelId?: string; /** - * Required. The ID of the advertiser this creative belongs to. + * The ID of the partner that owns the parent channel. */ - advertiserId?: string; + partnerId?: string; /** - * Required. The ID of the creative to fetch. + * Required. The URL or app ID of the site to delete. */ - creativeId?: string; + urlOrAppId?: string; } - export interface Params$Resource$Advertisers$Creatives$List extends StandardParameters { + export interface Params$Resource$Advertisers$Channels$Sites$List extends StandardParameters { /** - * Required. The ID of the advertiser to list creatives for. + * The ID of the advertiser that owns the parent channel. */ 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. + * 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: * `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`. + * 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 `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * 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 `ListCreatives` method. If not specified, the first page of results will be returned. + * 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; - } - export interface Params$Resource$Advertisers$Creatives$Patch extends StandardParameters { /** - * Output only. The unique ID of the advertiser the creative belongs to. + * The ID of the partner that owns the parent channel. */ - advertiserId?: string; + partnerId?: string; + } + export interface Params$Resource$Advertisers$Channels$Sites$Replace extends StandardParameters { /** - * Output only. The unique ID of the creative. Assigned by the system. + * The ID of the advertiser that owns the parent channel. */ - creativeId?: string; + advertiserId?: string; /** - * Required. The mask to control which fields to update. + * Required. The ID of the parent channel whose sites will be replaced. */ - updateMask?: string; + channelId?: string; /** * Request body metadata */ - requestBody?: Schema$Creative; + requestBody?: Schema$ReplaceSitesRequest; } - export class Resource$Advertisers$Insertionorders { + export class Resource$Advertisers$Creatives { 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. + * Creates a new creative. Returns the newly created creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -13833,31 +12102,61 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.create({ - * // Output only. The unique ID of the advertiser the insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.create({ + * // Output only. The unique ID of the advertiser the creative belongs to. * advertiserId: '[^/]+', * * // Request body metadata * requestBody: { * // request body parameters * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, * // "displayName": "my_displayName", + * // "dynamic": false, * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * }, * }); @@ -13865,23 +12164,53 @@ export namespace displayvideo_v3 { * * // Example response * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, * // "displayName": "my_displayName", + * // "dynamic": false, * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * } * @@ -13898,52 +12227,52 @@ export namespace displayvideo_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ create( - params: Params$Resource$Advertisers$Insertionorders$Create, + params: Params$Resource$Advertisers$Creatives$Create, options: StreamMethodOptions ): Promise>; create( - params?: Params$Resource$Advertisers$Insertionorders$Create, + params?: Params$Resource$Advertisers$Creatives$Create, options?: MethodOptions - ): Promise>; + ): Promise>; create( - params: Params$Resource$Advertisers$Insertionorders$Create, + params: Params$Resource$Advertisers$Creatives$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; create( - params: Params$Resource$Advertisers$Insertionorders$Create, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Create, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; create( - params: Params$Resource$Advertisers$Insertionorders$Create, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Create, + callback: BodyResponseCallback ): void; - create(callback: BodyResponseCallback): void; + create(callback: BodyResponseCallback): void; create( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Create + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Create; + {}) as Params$Resource$Advertisers$Creatives$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Create; + params = {} as Params$Resource$Advertisers$Creatives$Create; options = {}; } @@ -13957,7 +12286,7 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' + rootUrl + '/v3/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), method: 'POST', apiVersion: '', @@ -13970,17 +12299,17 @@ export namespace displayvideo_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. + * Deletes a creative. Returns error code `NOT_FOUND` if the creative does not exist. The creative should be archived first, i.e. set entity_status to `ENTITY_STATUS_ARCHIVED`, before it can be deleted. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -14009,11 +12338,11 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.delete({ - * // The ID of the advertiser this insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.delete({ + * // The ID of the advertiser this creative belongs to. * advertiserId: '[^/]+', - * // The ID of the insertion order to delete. - * insertionOrderId: '[^/]+', + * // The ID of the creative to be deleted. + * creativeId: '[^/]+', * }); * console.log(res.data); * @@ -14034,31 +12363,31 @@ export namespace displayvideo_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions ): Promise>; delete( - params?: Params$Resource$Advertisers$Insertionorders$Delete, + params?: Params$Resource$Advertisers$Creatives$Delete, options?: MethodOptions ): Promise>; delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + params: Params$Resource$Advertisers$Creatives$Delete, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + params: Params$Resource$Advertisers$Creatives$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; delete( - params: Params$Resource$Advertisers$Insertionorders$Delete, + params: Params$Resource$Advertisers$Creatives$Delete, callback: BodyResponseCallback ): void; delete(callback: BodyResponseCallback): void; delete( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Delete + | Params$Resource$Advertisers$Creatives$Delete | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14074,12 +12403,12 @@ export namespace displayvideo_v3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Delete; + {}) as Params$Resource$Advertisers$Creatives$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Delete; + params = {} as Params$Resource$Advertisers$Creatives$Delete; options = {}; } @@ -14094,7 +12423,7 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'DELETE', apiVersion: '', @@ -14102,8 +12431,8 @@ export namespace displayvideo_v3 { options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { @@ -14117,7 +12446,7 @@ export namespace displayvideo_v3 { } /** - * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. + * Gets a creative. * @example * ```js * // Before running the sample: @@ -14146,33 +12475,63 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.get({ - * // Required. The ID of the advertiser this insertion order belongs to. + * const res = await displayvideo.advertisers.creatives.get({ + * // Required. The ID of the advertiser this creative belongs to. * advertiserId: '[^/]+', - * // Required. The ID of the insertion order to fetch. - * insertionOrderId: '[^/]+', + * // Required. The ID of the creative to fetch. + * creativeId: '[^/]+', * }); * console.log(res.data); * * // Example response * // { + * // "additionalDimensions": [], * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, * // "displayName": "my_displayName", + * // "dynamic": false, * // "entityStatus": "my_entityStatus", - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "insertionOrderType": "my_insertionOrderType", - * // "integrationDetails": {}, - * // "kpi": {}, + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, * // "name": "my_name", - * // "optimizationObjective": "my_optimizationObjective", - * // "pacing": {}, - * // "partnerCosts": [], - * // "reservationType": "my_reservationType", - * // "updateTime": "my_updateTime" + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * } * @@ -14189,52 +12548,52 @@ export namespace displayvideo_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ get( - params: Params$Resource$Advertisers$Insertionorders$Get, + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions ): Promise>; get( - params?: Params$Resource$Advertisers$Insertionorders$Get, + params?: Params$Resource$Advertisers$Creatives$Get, options?: MethodOptions - ): Promise>; + ): Promise>; get( - params: Params$Resource$Advertisers$Insertionorders$Get, + params: Params$Resource$Advertisers$Creatives$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Insertionorders$Get, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; get( - params: Params$Resource$Advertisers$Insertionorders$Get, - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$Get, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; + get(callback: BodyResponseCallback): void; get( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Get; + {}) as Params$Resource$Advertisers$Creatives$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Get; + params = {} as Params$Resource$Advertisers$Creatives$Get; options = {}; } @@ -14249,7 +12608,7 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -14257,22 +12616,22 @@ export namespace displayvideo_v3 { options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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. + * 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. * @example * ```js * // Before running the sample: @@ -14301,23 +12660,23 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.list({ - * // Required. The ID of the advertiser to list insertion orders for. + * const res = await displayvideo.advertisers.creatives.list({ + * // Required. The ID of the advertiser to list creatives for. * advertiserId: '[^/]+', - * // 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. + * // 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: 'placeholder-value', - * // 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`. + * // 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: 'placeholder-value', - * // 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. + * // 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: 'placeholder-value', - * // 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. + * // 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: 'placeholder-value', * }); * console.log(res.data); * * // Example response * // { - * // "insertionOrders": [], + * // "creatives": [], * // "nextPageToken": "my_nextPageToken" * // } * } @@ -14335,56 +12694,54 @@ export namespace displayvideo_v3 { * @returns A promise if used with async/await, or void if used with a callback. */ list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions ): Promise>; list( - params?: Params$Resource$Advertisers$Insertionorders$List, + params?: Params$Resource$Advertisers$Creatives$List, options?: MethodOptions - ): Promise>; + ): Promise>; list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; list( - params: Params$Resource$Advertisers$Insertionorders$List, + params: Params$Resource$Advertisers$Creatives$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$List, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; list( - callback: BodyResponseCallback + params: Params$Resource$Advertisers$Creatives$List, + callback: BodyResponseCallback ): void; + list(callback: BodyResponseCallback): void; list( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$List - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$List; + {}) as Params$Resource$Advertisers$Creatives$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$List; + params = {} as Params$Resource$Advertisers$Creatives$List; options = {}; } @@ -14398,7 +12755,7 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' + rootUrl + '/v3/advertisers/{+advertiserId}/creatives' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -14411,17 +12768,17 @@ export namespace displayvideo_v3 { context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists assigned targeting options of an insertion order across targeting types. + * Updates an existing creative. Returns the updated creative if successful. A ["Standard" user role](//support.google.com/displayvideo/answer/2723011) or greater for the parent advertiser or partner is required to make this request. * @example * ```js * // Before running the sample: @@ -14450,29 +12807,119 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.listAssignedTargetingOptions( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // 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: 'placeholder-value', - * // Required. The ID of the insertion order to list assigned targeting options for. - * insertionOrderId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * }, - * ); + * const res = await displayvideo.advertisers.creatives.patch({ + * // Output only. The unique ID of the advertiser the creative belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the creative. Assigned by the system. + * creativeId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "additionalDimensions": [], + * // "advertiserId": "my_advertiserId", + * // "appendedTag": "my_appendedTag", + * // "assets": [], + * // "cmPlacementId": "my_cmPlacementId", + * // "cmTrackingAd": {}, + * // "companionCreativeIds": [], + * // "counterEvents": [], + * // "createTime": "my_createTime", + * // "creativeAttributes": [], + * // "creativeId": "my_creativeId", + * // "creativeType": "my_creativeType", + * // "dimensions": {}, + * // "displayName": "my_displayName", + * // "dynamic": false, + * // "entityStatus": "my_entityStatus", + * // "exitEvents": [], + * // "expandOnHover": false, + * // "expandingDirection": "my_expandingDirection", + * // "hostingSource": "my_hostingSource", + * // "html5Video": false, + * // "iasCampaignMonitoring": false, + * // "integrationCode": "my_integrationCode", + * // "jsTrackerUrl": "my_jsTrackerUrl", + * // "lineItemIds": [], + * // "mediaDuration": "my_mediaDuration", + * // "mp3Audio": false, + * // "name": "my_name", + * // "notes": "my_notes", + * // "obaIcon": {}, + * // "oggAudio": false, + * // "progressOffset": {}, + * // "requireHtml5": false, + * // "requireMraid": false, + * // "requirePingForAttribution": false, + * // "reviewStatus": {}, + * // "skipOffset": {}, + * // "skippable": false, + * // "thirdPartyTag": "my_thirdPartyTag", + * // "thirdPartyUrls": [], + * // "timerEvents": [], + * // "trackerUrls": [], + * // "transcodes": [], + * // "universalAdId": {}, + * // "updateTime": "my_updateTime", + * // "vastTagUrl": "my_vastTagUrl", + * // "vpaid": false * // } * } * @@ -14488,62 +12935,53 @@ export namespace displayvideo_v3 { * @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, + patch( + params: Params$Resource$Advertisers$Creatives$Patch, options: StreamMethodOptions ): Promise>; - listAssignedTargetingOptions( - params?: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + patch( + params?: Params$Resource$Advertisers$Creatives$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - listAssignedTargetingOptions( - params: Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions, + ): Promise>; + patch( + params: Params$Resource$Advertisers$Creatives$Patch, 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 + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Creatives$Patch, + callback: BodyResponseCallback ): void; - listAssignedTargetingOptions( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions - | BodyResponseCallback + | Params$Resource$Advertisers$Creatives$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + {}) as Params$Resource$Advertisers$Creatives$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Listassignedtargetingoptions; + params = {} as Params$Resource$Advertisers$Creatives$Patch; options = {}; } @@ -14558,32 +12996,110 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}:listAssignedTargetingOptions' + '/v3/advertisers/{+advertiserId}/creatives/{+creativeId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId'], - pathParams: ['advertiserId', 'insertionOrderId'], + requiredParams: ['advertiserId', 'creativeId'], + pathParams: ['advertiserId', 'creativeId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } + } + export interface Params$Resource$Advertisers$Creatives$Create extends StandardParameters { /** - * Updates an existing insertion order. Returns the updated insertion order if successful. + * 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; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Creates a new insertion order. Returns the newly created insertion order if successful. * @example * ```js * // Before running the sample: @@ -14612,13 +13128,9 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = await displayvideo.advertisers.insertionOrders.patch({ + * const res = await displayvideo.advertisers.insertionOrders.create({ * // Output only. The unique ID of the advertiser the insertion order belongs to. * advertiserId: '[^/]+', - * // Output only. The unique ID of the insertion order. Assigned by the system. - * insertionOrderId: '[^/]+', - * // Required. The mask to control which fields to update. - * updateMask: 'placeholder-value', * * // Request body metadata * requestBody: { @@ -14680,32 +13192,32 @@ export namespace displayvideo_v3 { * @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, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions ): Promise>; - patch( - params?: Params$Resource$Advertisers$Insertionorders$Patch, + create( + params?: Params$Resource$Advertisers$Insertionorders$Create, options?: MethodOptions ): Promise>; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - patch( - params: Params$Resource$Advertisers$Insertionorders$Patch, + create( + params: Params$Resource$Advertisers$Insertionorders$Create, callback: BodyResponseCallback ): void; - patch(callback: BodyResponseCallback): void; - patch( + create(callback: BodyResponseCallback): void; + create( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Patch + | Params$Resource$Advertisers$Insertionorders$Create | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: @@ -14721,12 +13233,12 @@ export namespace displayvideo_v3 { | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Patch; + {}) as Params$Resource$Advertisers$Insertionorders$Create; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = {} as Params$Resource$Advertisers$Insertionorders$Patch; + params = {} as Params$Resource$Advertisers$Insertionorders$Create; options = {}; } @@ -14740,149 +13252,30 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' + rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'PATCH', + method: 'POST', apiVersion: '', }, 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 + params, + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback ); - } - } - - export class Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions { - context: APIRequestContext; - constructor(context: APIRequestContext) { - this.context = context; + } else { + return createAPIRequest(parameters); + } } /** - * 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` + * 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. * @example * ```js * // Before running the sample: @@ -14911,137 +13304,16 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.create( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option will belong to. - * insertionOrderId: '[^/]+', - * // 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: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} - * // } - * }, - * }, - * ); + * const res = await displayvideo.advertisers.insertionOrders.delete({ + * // The ID of the advertiser this insertion order belongs to. + * advertiserId: '[^/]+', + * // The ID of the insertion order to delete. + * insertionOrderId: '[^/]+', + * }); * console.log(res.data); * * // Example response - * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} - * // } + * // {} * } * * main().catch(e => { @@ -15056,58 +13328,53 @@ export namespace displayvideo_v3 { * @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, + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, options: StreamMethodOptions ): Promise>; - create( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + delete( + params?: Params$Resource$Advertisers$Insertionorders$Delete, options?: MethodOptions - ): Promise>; - create( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create, + ): Promise>; + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, 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 + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - create( - callback: BodyResponseCallback + delete( + params: Params$Resource$Advertisers$Insertionorders$Delete, + callback: BodyResponseCallback ): void; - create( + delete(callback: BodyResponseCallback): void; + delete( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Delete + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + {}) as Params$Resource$Advertisers$Insertionorders$Delete; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create; + params = {} as Params$Resource$Advertisers$Insertionorders$Delete; options = {}; } @@ -15122,30 +13389,30 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'POST', + method: 'DELETE', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], - pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + 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` + * Gets an insertion order. Returns error code `NOT_FOUND` if the insertion order does not exist. * @example * ```js * // Before running the sample: @@ -15174,23 +13441,34 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.delete( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. The ID of the assigned targeting option to delete. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option belongs to. - * insertionOrderId: '[^/]+', - * // 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: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.insertionOrders.get({ + * // Required. The ID of the advertiser this insertion order belongs to. + * advertiserId: '[^/]+', + * // Required. The ID of the insertion order to fetch. + * insertionOrderId: '[^/]+', + * }); * console.log(res.data); * * // Example response - * // {} + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" + * // } * } * * main().catch(e => { @@ -15205,54 +13483,53 @@ export namespace displayvideo_v3 { * @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, + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions ): Promise>; - delete( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + get( + params?: Params$Resource$Advertisers$Insertionorders$Get, options?: MethodOptions - ): Promise>; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, + ): Promise>; + get( + params: Params$Resource$Advertisers$Insertionorders$Get, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - options: MethodOptions | BodyResponseCallback, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - delete( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete, - callback: BodyResponseCallback + get( + params: Params$Resource$Advertisers$Insertionorders$Get, + callback: BodyResponseCallback ): void; - delete(callback: BodyResponseCallback): void; - delete( + get(callback: BodyResponseCallback): void; + get( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Get + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + {}) as Params$Resource$Advertisers$Insertionorders$Get; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete; + params = {} as Params$Resource$Advertisers$Insertionorders$Get; options = {}; } @@ -15267,40 +13544,30 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'DELETE', + method: 'GET', apiVersion: '', }, options ), params, - requiredParams: [ - 'advertiserId', - 'insertionOrderId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'insertionOrderId', - 'targetingType', - ], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Gets a single targeting option assigned to an insertion order. + * 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. * @example * ```js * // Before running the sample: @@ -15329,77 +13596,24 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.get( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // Required. An identifier unique to the targeting type in this insertion order that identifies the assigned targeting option being requested. - * assignedTargetingOptionId: '[^/]+', - * // Required. The ID of the insertion order the assigned targeting option belongs to. - * insertionOrderId: '[^/]+', - * // 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: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.insertionOrders.list({ + * // Required. The ID of the advertiser to list insertion orders for. + * advertiserId: '[^/]+', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * // 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: 'placeholder-value', + * }); * console.log(res.data); * * // Example response * // { - * // "ageRangeDetails": {}, - * // "appCategoryDetails": {}, - * // "appDetails": {}, - * // "assignedTargetingOptionId": "my_assignedTargetingOptionId", - * // "assignedTargetingOptionIdAlias": "my_assignedTargetingOptionIdAlias", - * // "audienceGroupDetails": {}, - * // "audioContentTypeDetails": {}, - * // "authorizedSellerStatusDetails": {}, - * // "browserDetails": {}, - * // "businessChainDetails": {}, - * // "carrierAndIspDetails": {}, - * // "categoryDetails": {}, - * // "channelDetails": {}, - * // "contentDurationDetails": {}, - * // "contentGenreDetails": {}, - * // "contentInstreamPositionDetails": {}, - * // "contentOutstreamPositionDetails": {}, - * // "contentStreamTypeDetails": {}, - * // "contentThemeExclusionDetails": {}, - * // "dayAndTimeDetails": {}, - * // "deviceMakeModelDetails": {}, - * // "deviceTypeDetails": {}, - * // "digitalContentLabelExclusionDetails": {}, - * // "environmentDetails": {}, - * // "exchangeDetails": {}, - * // "genderDetails": {}, - * // "geoRegionDetails": {}, - * // "householdIncomeDetails": {}, - * // "inheritance": "my_inheritance", - * // "inventorySourceDetails": {}, - * // "inventorySourceGroupDetails": {}, - * // "keywordDetails": {}, - * // "languageDetails": {}, - * // "name": "my_name", - * // "nativeContentPositionDetails": {}, - * // "negativeKeywordListDetails": {}, - * // "omidDetails": {}, - * // "onScreenPositionDetails": {}, - * // "operatingSystemDetails": {}, - * // "parentalStatusDetails": {}, - * // "poiDetails": {}, - * // "proximityLocationListDetails": {}, - * // "regionalLocationListDetails": {}, - * // "sensitiveCategoryExclusionDetails": {}, - * // "sessionPositionDetails": {}, - * // "subExchangeDetails": {}, - * // "targetingType": "my_targetingType", - * // "thirdPartyVerifierDetails": {}, - * // "urlDetails": {}, - * // "userRewardedContentDetails": {}, - * // "videoPlayerSizeDetails": {}, - * // "viewabilityDetails": {}, - * // "youtubeChannelDetails": {}, - * // "youtubeVideoDetails": {} + * // "insertionOrders": [], + * // "nextPageToken": "my_nextPageToken" * // } * } * @@ -15415,56 +13629,57 @@ export namespace displayvideo_v3 { * @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, + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions ): Promise>; - get( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + list( + params?: Params$Resource$Advertisers$Insertionorders$List, options?: MethodOptions - ): Promise>; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + ): Promise>; + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: StreamMethodOptions | BodyResponseCallback, callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, + list( + params: Params$Resource$Advertisers$Insertionorders$List, options: | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + | BodyResponseCallback, + callback: BodyResponseCallback ): void; - get( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get, - callback: BodyResponseCallback + list( + params: Params$Resource$Advertisers$Insertionorders$List, + callback: BodyResponseCallback ): void; - get(callback: BodyResponseCallback): void; - get( + list( + callback: BodyResponseCallback + ): void; + list( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$List + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise> + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + {}) as Params$Resource$Advertisers$Insertionorders$List; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Get; + params = {} as Params$Resource$Advertisers$Insertionorders$List; options = {}; } @@ -15478,8 +13693,7 @@ export namespace displayvideo_v3 { options: Object.assign( { url: ( - rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions/{+assignedTargetingOptionId}' + rootUrl + '/v3/advertisers/{+advertiserId}/insertionOrders' ).replace(/([^:]\/)\/+/g, '$1'), method: 'GET', apiVersion: '', @@ -15487,32 +13701,22 @@ export namespace displayvideo_v3 { options ), params, - requiredParams: [ - 'advertiserId', - 'insertionOrderId', - 'targetingType', - 'assignedTargetingOptionId', - ], - pathParams: [ - 'advertiserId', - 'assignedTargetingOptionId', - 'insertionOrderId', - 'targetingType', - ], + requiredParams: ['advertiserId'], + pathParams: ['advertiserId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest(parameters); + return createAPIRequest(parameters); } } /** - * Lists the targeting options assigned to an insertion order. + * Updates an existing insertion order. Returns the updated insertion order if successful. * @example * ```js * // Before running the sample: @@ -15541,31 +13745,59 @@ export namespace displayvideo_v3 { * google.options({auth: authClient}); * * // Do the magic - * const res = - * await displayvideo.advertisers.insertionOrders.targetingTypes.assignedTargetingOptions.list( - * { - * // Required. The ID of the advertiser the insertion order belongs to. - * advertiserId: '[^/]+', - * // 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: 'placeholder-value', - * // Required. The ID of the insertion order to list assigned targeting options for. - * insertionOrderId: '[^/]+', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: 'placeholder-value', - * // 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: '[^/]+', - * }, - * ); + * const res = await displayvideo.advertisers.insertionOrders.patch({ + * // Output only. The unique ID of the advertiser the insertion order belongs to. + * advertiserId: '[^/]+', + * // Output only. The unique ID of the insertion order. Assigned by the system. + * insertionOrderId: '[^/]+', + * // Required. The mask to control which fields to update. + * updateMask: 'placeholder-value', + * + * // Request body metadata + * requestBody: { + * // request body parameters + * // { + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" + * // } + * }, + * }); * console.log(res.data); * * // Example response * // { - * // "assignedTargetingOptions": [], - * // "nextPageToken": "my_nextPageToken" + * // "advertiserId": "my_advertiserId", + * // "bidStrategy": {}, + * // "budget": {}, + * // "campaignId": "my_campaignId", + * // "displayName": "my_displayName", + * // "entityStatus": "my_entityStatus", + * // "frequencyCap": {}, + * // "insertionOrderId": "my_insertionOrderId", + * // "insertionOrderType": "my_insertionOrderType", + * // "integrationDetails": {}, + * // "kpi": {}, + * // "name": "my_name", + * // "optimizationObjective": "my_optimizationObjective", + * // "pacing": {}, + * // "partnerCosts": [], + * // "reservationType": "my_reservationType", + * // "updateTime": "my_updateTime" * // } * } * @@ -15581,62 +13813,53 @@ export namespace displayvideo_v3 { * @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, + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions ): Promise>; - list( - params?: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + patch( + params?: Params$Resource$Advertisers$Insertionorders$Patch, options?: MethodOptions - ): Promise< - GaxiosResponseWithHTTP2 - >; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, + ): Promise>; + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, options: StreamMethodOptions | BodyResponseCallback, - callback: BodyResponseCallback - ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, - options: - | MethodOptions - | BodyResponseCallback, - callback: BodyResponseCallback + callback: BodyResponseCallback ): void; - list( - params: Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List, - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback ): void; - list( - callback: BodyResponseCallback + patch( + params: Params$Resource$Advertisers$Insertionorders$Patch, + callback: BodyResponseCallback ): void; - list( + patch(callback: BodyResponseCallback): void; + patch( paramsOrCallback?: - | Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List - | BodyResponseCallback + | Params$Resource$Advertisers$Insertionorders$Patch + | BodyResponseCallback | BodyResponseCallback, optionsOrCallback?: | MethodOptions | StreamMethodOptions - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback, callback?: - | BodyResponseCallback + | BodyResponseCallback | BodyResponseCallback ): | void - | Promise< - GaxiosResponseWithHTTP2 - > + | Promise> | Promise> { let params = (paramsOrCallback || - {}) as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + {}) as Params$Resource$Advertisers$Insertionorders$Patch; let options = (optionsOrCallback || {}) as MethodOptions; if (typeof paramsOrCallback === 'function') { callback = paramsOrCallback; - params = - {} as Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$List; + params = {} as Params$Resource$Advertisers$Insertionorders$Patch; options = {}; } @@ -15651,115 +13874,100 @@ export namespace displayvideo_v3 { { url: ( rootUrl + - '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}/targetingTypes/{+targetingType}/assignedTargetingOptions' + '/v3/advertisers/{+advertiserId}/insertionOrders/{+insertionOrderId}' ).replace(/([^:]\/)\/+/g, '$1'), - method: 'GET', + method: 'PATCH', apiVersion: '', }, options ), params, - requiredParams: ['advertiserId', 'insertionOrderId', 'targetingType'], - pathParams: ['advertiserId', 'insertionOrderId', 'targetingType'], + requiredParams: ['advertiserId', 'insertionOrderId'], + pathParams: ['advertiserId', 'insertionOrderId'], context: this.context, }; if (callback) { - createAPIRequest( + createAPIRequest( parameters, callback as BodyResponseCallback ); } else { - return createAPIRequest( - parameters - ); + return createAPIRequest(parameters); } } } - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Create extends StandardParameters { + export interface Params$Resource$Advertisers$Insertionorders$Create extends StandardParameters { /** - * Required. The ID of the advertiser the insertion order belongs to. + * Output only. The unique 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; + requestBody?: Schema$InsertionOrder; } - export interface Params$Resource$Advertisers$Insertionorders$Targetingtypes$Assignedtargetingoptions$Delete extends StandardParameters { + export interface Params$Resource$Advertisers$Insertionorders$Delete extends StandardParameters { /** - * Required. The ID of the advertiser the insertion order belongs to. + * The ID of the advertiser this 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. + * The ID of the insertion order to delete. */ 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 { + export interface Params$Resource$Advertisers$Insertionorders$Get extends StandardParameters { /** - * Required. The ID of the advertiser the insertion order belongs to. + * Required. The ID of the advertiser this 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. + * Required. The ID of the insertion order to fetch. */ 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 { + export interface Params$Resource$Advertisers$Insertionorders$List extends StandardParameters { /** - * Required. The ID of the advertiser the insertion order belongs to. + * Required. The ID of the advertiser to list insertion orders for. */ 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. + * 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; /** - * 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`. + * 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 `5000`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. + * 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 `ListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned. + * 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$Patch extends StandardParameters { /** - * 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` + * Output only. The unique ID of the advertiser the insertion order belongs to. */ - targetingType?: string; + 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$Invoices { @@ -17069,180 +15277,6 @@ export namespace displayvideo_v3 { } } - /** - * Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API. - * @example - * ```js - * // Before running the sample: - * // - Enable the API at: - * // https://console.developers.google.com/apis/api/displayvideo.googleapis.com - * // - Login into gcloud by running: - * // ```sh - * // $ gcloud auth application-default login - * // ``` - * // - Install the npm module by running: - * // ```sh - * // $ npm install googleapis - * // ``` - * - * const {google} = require('googleapis'); - * const displayvideo = google.displayvideo('v3'); - * - * async function main() { - * const auth = new google.auth.GoogleAuth({ - * // Scopes can be specified either as an array or as a single, space-delimited string. - * scopes: ['https://www.googleapis.com/auth/display-video'], - * }); - * - * // Acquire an auth client, and bind it to all future calls - * const authClient = await auth.getClient(); - * google.options({auth: authClient}); - * - * // Do the magic - * const res = await displayvideo.advertisers.lineItems.generateDefault({ - * // Required. The ID of the advertiser this line item belongs to. - * advertiserId: '[^/]+', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // { - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "displayName": "my_displayName", - * // "insertionOrderId": "my_insertionOrderId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {} - * // } - * }, - * }); - * console.log(res.data); - * - * // Example response - * // { - * // "advertiserId": "my_advertiserId", - * // "bidStrategy": {}, - * // "budget": {}, - * // "campaignId": "my_campaignId", - * // "containsEuPoliticalAds": "my_containsEuPoliticalAds", - * // "conversionCounting": {}, - * // "creativeIds": [], - * // "displayName": "my_displayName", - * // "entityStatus": "my_entityStatus", - * // "excludeNewExchanges": false, - * // "flight": {}, - * // "frequencyCap": {}, - * // "insertionOrderId": "my_insertionOrderId", - * // "integrationDetails": {}, - * // "lineItemId": "my_lineItemId", - * // "lineItemType": "my_lineItemType", - * // "mobileApp": {}, - * // "name": "my_name", - * // "pacing": {}, - * // "partnerCosts": [], - * // "partnerRevenueModel": {}, - * // "reservationType": "my_reservationType", - * // "targetingExpansion": {}, - * // "updateTime": "my_updateTime", - * // "warningMessages": [], - * // "youtubeAndPartnersSettings": {} - * // } - * } - * - * main().catch(e => { - * console.error(e); - * throw e; - * }); - * - * ``` - * - * @param params - Parameters for request - * @param options - Optionally override request options, such as `url`, `method`, and `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 - ): Promise>; - generateDefault( - params?: Params$Resource$Advertisers$Lineitems$Generatedefault, - options?: MethodOptions - ): Promise>; - 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 - | Promise> - | Promise> { - 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', - apiVersion: '', - }, - options - ), - params, - requiredParams: ['advertiserId'], - pathParams: ['advertiserId'], - context: this.context, - }; - if (callback) { - createAPIRequest( - parameters, - callback as BodyResponseCallback - ); - } else { - return createAPIRequest(parameters); - } - } - /** * Gets a line item. * @example @@ -17838,17 +15872,6 @@ export namespace displayvideo_v3 { */ 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. diff --git a/src/apis/drive/v3.ts b/src/apis/drive/v3.ts index e2bc41b32d8..754a6234f47 100644 --- a/src/apis/drive/v3.ts +++ b/src/apis/drive/v3.ts @@ -114,6 +114,7 @@ export namespace drive_v3 { context: APIRequestContext; about: Resource$About; accessproposals: Resource$Accessproposals; + approvals: Resource$Approvals; apps: Resource$Apps; changes: Resource$Changes; channels: Resource$Channels; @@ -134,6 +135,7 @@ export namespace drive_v3 { this.about = new Resource$About(this.context); this.accessproposals = new Resource$Accessproposals(this.context); + this.approvals = new Resource$Approvals(this.context); this.apps = new Resource$Apps(this.context); this.changes = new Resource$Changes(this.context); this.channels = new Resource$Channels(this.context); @@ -400,6 +402,68 @@ export namespace drive_v3 { */ selfLink?: string | null; } + /** + * Metadata for an approval. An approval is a review/approve process for a Drive item. + */ + export interface Schema$Approval { + /** + * The Approval ID. + */ + approvalId?: string | null; + /** + * Output only. The time time the approval was completed. + */ + completeTime?: string | null; + /** + * Output only. The time the approval was created. + */ + createTime?: string | null; + /** + * The time that the approval is due. + */ + dueTime?: string | null; + /** + * The user that requested the Approval. + */ + initiator?: Schema$User; + /** + * This is always drive#approval. + */ + kind?: string | null; + /** + * Output only. The most recent time the approval was modified. + */ + modifyTime?: string | null; + /** + * The responses made on the Approval by reviewers. + */ + reviewerResponses?: Schema$ReviewerResponse[]; + /** + * Output only. The status of the approval at the time this resource was requested. + */ + status?: string | null; + /** + * Target file id of the approval. + */ + targetFileId?: string | null; + } + /** + * The response of an Approvals list request. + */ + export interface Schema$ApprovalList { + /** + * The list of Approvals. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. + */ + items?: Schema$Approval[]; + /** + * This is always drive#approvalList + */ + kind?: string | null; + /** + * The page token for the next page of Approvals. This will be absent if the end of the Approvals list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results. + */ + nextPageToken?: string | null; + } /** * A change to a file or shared drive. */ @@ -1518,6 +1582,23 @@ export namespace drive_v3 { */ view?: string | null; } + /** + * A response on an Approval made by a specific Reviewer. + */ + export interface Schema$ReviewerResponse { + /** + * This is always drive#reviewerResponse. + */ + kind?: string | null; + /** + * A Reviewer’s Response for the Approval. + */ + response?: string | null; + /** + * The user that is responsible for this response. + */ + reviewer?: Schema$User; + } /** * The metadata for a revision to a file. Some resource methods (such as `revisions.update`) require a `revisionId`. Use the `revisions.list` method to retrieve the ID for a revision. */ @@ -2408,6 +2489,326 @@ export namespace drive_v3 { requestBody?: Schema$ResolveAccessProposalRequest; } + export class Resource$Approvals { + context: APIRequestContext; + constructor(context: APIRequestContext) { + this.context = context; + } + + /** + * Gets an Approval by ID. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/drive.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const drive = google.drive('v3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/drive'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await drive.approvals.get({ + * // Required. The ID of the Approval. + * approvalId: 'placeholder-value', + * // Required. The ID of the file the Approval is on. + * fileId: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "approvalId": "my_approvalId", + * // "completeTime": "my_completeTime", + * // "createTime": "my_createTime", + * // "dueTime": "my_dueTime", + * // "initiator": {}, + * // "kind": "my_kind", + * // "modifyTime": "my_modifyTime", + * // "reviewerResponses": [], + * // "status": "my_status", + * // "targetFileId": "my_targetFileId" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Approvals$Get, + options: StreamMethodOptions + ): Promise>; + get( + params?: Params$Resource$Approvals$Get, + options?: MethodOptions + ): Promise>; + get( + params: Params$Resource$Approvals$Get, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Approvals$Get, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + get( + params: Params$Resource$Approvals$Get, + callback: BodyResponseCallback + ): void; + get(callback: BodyResponseCallback): void; + get( + paramsOrCallback?: + | Params$Resource$Approvals$Get + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Approvals$Get; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Approvals$Get; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + '/drive/v3/files/{fileId}/approvals/{approvalId}' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['fileId', 'approvalId'], + pathParams: ['approvalId', 'fileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + + /** + * Lists the Approvals on a file. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/drive.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const drive = google.drive('v3'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: ['https://www.googleapis.com/auth/drive'], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await drive.approvals.list({ + * // Required. The ID of the file the Approval is on. + * fileId: 'placeholder-value', + * // The maximum number of Approvals to return. When not set, at most 100 Approvals will be returned. + * pageSize: 'placeholder-value', + * // The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response. + * pageToken: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "items": [], + * // "kind": "my_kind", + * // "nextPageToken": "my_nextPageToken" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `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$Approvals$List, + options: StreamMethodOptions + ): Promise>; + list( + params?: Params$Resource$Approvals$List, + options?: MethodOptions + ): Promise>; + list( + params: Params$Resource$Approvals$List, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Approvals$List, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + list( + params: Params$Resource$Approvals$List, + callback: BodyResponseCallback + ): void; + list(callback: BodyResponseCallback): void; + list( + paramsOrCallback?: + | Params$Resource$Approvals$List + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || {}) as Params$Resource$Approvals$List; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Approvals$List; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://www.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: (rootUrl + '/drive/v3/files/{fileId}/approvals').replace( + /([^:]\/)\/+/g, + '$1' + ), + method: 'GET', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['fileId'], + pathParams: ['fileId'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + } + + export interface Params$Resource$Approvals$Get extends StandardParameters { + /** + * Required. The ID of the Approval. + */ + approvalId?: string; + /** + * Required. The ID of the file the Approval is on. + */ + fileId?: string; + } + export interface Params$Resource$Approvals$List extends StandardParameters { + /** + * Required. The ID of the file the Approval is on. + */ + fileId?: string; + /** + * The maximum number of Approvals to return. When not set, at most 100 Approvals will be returned. + */ + pageSize?: number; + /** + * The token for continuing a previous list request on the next page. This should be set to the value of nextPageToken from a previous response. + */ + pageToken?: string; + } + export class Resource$Apps { context: APIRequestContext; constructor(context: APIRequestContext) { diff --git a/src/apis/ids/v1.ts b/src/apis/ids/v1.ts index d2b57d9af0e..3568ad74674 100644 --- a/src/apis/ids/v1.ts +++ b/src/apis/ids/v1.ts @@ -233,7 +233,7 @@ export namespace ids_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -1977,7 +1977,7 @@ export namespace ids_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -2129,7 +2129,7 @@ export namespace ids_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/logging/v2.ts b/src/apis/logging/v2.ts index 138de1efdb8..072a994bec1 100644 --- a/src/apis/logging/v2.ts +++ b/src/apis/logging/v2.ts @@ -844,7 +844,7 @@ export namespace logging_v2 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets ListOperationsRequest.return_partial_success and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -6770,7 +6770,7 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -6917,7 +6917,7 @@ export namespace logging_v2 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -16991,7 +16991,7 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -17137,7 +17137,7 @@ export namespace logging_v2 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -23483,7 +23483,7 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -23629,7 +23629,7 @@ export namespace logging_v2 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -30564,7 +30564,7 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -30710,7 +30710,7 @@ export namespace logging_v2 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -39187,7 +39187,7 @@ export namespace logging_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -39333,7 +39333,7 @@ export namespace logging_v2 { */ pageToken?: string; /** - * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections e.g. when parent is set to "projects/example/locations/-".This field is not by default supported and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to true, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field.This can only be true when reading across collections. For example, when parent is set to "projects/example/locations/-".This field is not supported by default and will result in an UNIMPLEMENTED error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/notebooks/v2.ts b/src/apis/notebooks/v2.ts index ec0de4f9dc7..ecc3e5ec303 100644 --- a/src/apis/notebooks/v2.ts +++ b/src/apis/notebooks/v2.ts @@ -653,7 +653,7 @@ export namespace notebooks_v2 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -5380,7 +5380,7 @@ export namespace notebooks_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -5532,7 +5532,7 @@ export namespace notebooks_v2 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/run/v2.ts b/src/apis/run/v2.ts index f8ed530a35b..14fef8bec5b 100644 --- a/src/apis/run/v2.ts +++ b/src/apis/run/v2.ts @@ -923,6 +923,10 @@ export namespace run_v2 { * The resulting list of Services. */ services?: Schema$GoogleCloudRunV2Service[]; + /** + * Output only. For global requests, returns the list of regions that could not be reached within the deadline. + */ + unreachable?: string[] | null; } /** * Response message containing a list of Tasks. @@ -2015,7 +2019,7 @@ export namespace run_v2 { */ creator?: string | null; /** - * One or more custom audiences that you want this worker pool to support. Specify each custom audience as the full URL in a string. The custom audiences are encoded in the token and used to authenticate requests. For more information, see https://cloud.google.com/run/docs/configuring/custom-audiences. + * Not supported, and ignored by Cloud Run. */ customAudiences?: string[] | null; /** @@ -2094,6 +2098,10 @@ export namespace run_v2 { * Output only. The Condition of this WorkerPool, containing its readiness status, and detailed error information in case it did not reach a serving state. See comments in `reconciling` for additional information on reconciliation process in Cloud Run. */ terminalCondition?: Schema$GoogleCloudRunV2Condition; + /** + * Output only. Indicates whether Cloud Run Threat Detection monitoring is enabled for the parent project of this worker pool. + */ + threatDetectionEnabled?: boolean | 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. */ @@ -2780,6 +2788,10 @@ export namespace run_v2 { * Maven `artifactId` value used when uploading the artifact to Artifact Registry. */ artifactId?: string | null; + /** + * Optional. Path to a folder containing the files to upload to Artifact Registry. This can be either an absolute path, e.g. `/workspace/my-app/target/`, or a relative path from /workspace, e.g. `my-app/target/`. This field is mutually exclusive with the `path` field. + */ + deployFolder?: string | null; /** * Maven `groupId` value used when uploading the artifact to Artifact Registry. */ @@ -3282,7 +3294,7 @@ export namespace run_v2 { */ operations?: Schema$GoogleLongrunningOperation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -7278,7 +7290,7 @@ export namespace run_v2 { * pageSize: 'placeholder-value', * // Token identifying which result to start with, which is returned by a previous list call. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -7577,7 +7589,7 @@ export namespace run_v2 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } @@ -8305,7 +8317,8 @@ export namespace run_v2 { * // Example response * // { * // "nextPageToken": "my_nextPageToken", - * // "services": [] + * // "services": [], + * // "unreachable": [] * // } * } * @@ -9787,6 +9800,7 @@ export namespace run_v2 { * // "scaling": {}, * // "template": {}, * // "terminalCondition": {}, + * // "threatDetectionEnabled": false, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -10114,6 +10128,7 @@ export namespace run_v2 { * // "scaling": {}, * // "template": {}, * // "terminalCondition": {}, + * // "threatDetectionEnabled": false, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } @@ -10588,6 +10603,7 @@ export namespace run_v2 { * // "scaling": {}, * // "template": {}, * // "terminalCondition": {}, + * // "threatDetectionEnabled": false, * // "uid": "my_uid", * // "updateTime": "my_updateTime" * // } diff --git a/src/apis/searchads360/v0.ts b/src/apis/searchads360/v0.ts index 0715c4925d0..1051af95644 100644 --- a/src/apis/searchads360/v0.ts +++ b/src/apis/searchads360/v0.ts @@ -1045,6 +1045,10 @@ export namespace searchads360_v0 { * Resource name of the geo target constant that represents a metro. */ geoTargetMetro?: string | null; + /** + * Resource name of the geo target constant that represents a postal code. + */ + geoTargetPostalCode?: string | null; /** * Resource name of the geo target constant that represents a region. */ @@ -2412,7 +2416,7 @@ export namespace searchads360_v0 { */ export interface Schema$GoogleAdsSearchads360V0Resources__AdGroupBidModifier { /** - * The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. The range is 1.0 - 6.0 for PreferredContent. Use 0 to opt out of a Device type. + * The modifier for the bid when the criterion matches. The modifier must be in the range: 0.1 - 10.0. Use 0 to opt out of a Device type. */ bidModifier?: number | null; /** diff --git a/src/apis/sqladmin/v1.ts b/src/apis/sqladmin/v1.ts index 4ae2df489d2..d73167eed6e 100644 --- a/src/apis/sqladmin/v1.ts +++ b/src/apis/sqladmin/v1.ts @@ -2160,7 +2160,7 @@ export namespace sqladmin_v1 { passwordExpirationTime?: string | null; } /** - * Database instance local user password validation policy + * Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. */ export interface Schema$PasswordValidationPolicy { /** @@ -2176,7 +2176,7 @@ export namespace sqladmin_v1 { */ disallowUsernameSubstring?: boolean | null; /** - * Whether the password policy is enabled or not. + * Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords. */ enablePasswordPolicy?: boolean | null; /** @@ -2192,6 +2192,35 @@ export namespace sqladmin_v1 { */ reuseInterval?: number | null; } + /** + * Performance Capture configuration. + */ + export interface Schema$PerformanceCaptureConfig { + /** + * Optional. Enable or disable the Performance Capture feature. + */ + enabled?: boolean | null; + /** + * Optional. The minimum number of consecutive readings above threshold that triggers instance state capture. + */ + probeThreshold?: number | null; + /** + * Optional. The time interval in seconds between any two probes. + */ + probingIntervalSeconds?: number | null; + /** + * Optional. The minimum number of server threads running to trigger the capture on primary. + */ + runningThreadsThreshold?: number | null; + /** + * Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica. + */ + secondsBehindSourceThreshold?: number | null; + /** + * Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + */ + transactionDurationThreshold?: number | null; + } /** * Perform disk shrink context. */ @@ -2258,6 +2287,14 @@ export namespace sqladmin_v1 { * Output only. The name of the read pool node, to be used for retrieving metrics and logs. */ name?: string | null; + /** + * Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node. + */ + pscAutoConnections?: Schema$PscAutoConnectionConfig[]; + /** + * Output only. The Private Service Connect (PSC) service attachment of the read pool node. + */ + pscServiceAttachmentLink?: string | null; /** * Output only. The current state of the read pool node. */ @@ -2659,6 +2696,10 @@ export namespace sqladmin_v1 { * The local user password validation policy of the instance. */ passwordValidationPolicy?: Schema$PasswordValidationPolicy; + /** + * Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + */ + performanceCaptureConfig?: Schema$PerformanceCaptureConfig; /** * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */ @@ -6735,6 +6776,169 @@ export namespace sqladmin_v1 { } } + /** + * Adds a new Entra ID certificate for the specified instance. If an Entra ID certificate was previously added but never used in a certificate rotation, this operation replaces that version. + * @example + * ```js + * // Before running the sample: + * // - Enable the API at: + * // https://console.developers.google.com/apis/api/sqladmin.googleapis.com + * // - Login into gcloud by running: + * // ```sh + * // $ gcloud auth application-default login + * // ``` + * // - Install the npm module by running: + * // ```sh + * // $ npm install googleapis + * // ``` + * + * const {google} = require('googleapis'); + * const sqladmin = google.sqladmin('v1'); + * + * async function main() { + * const auth = new google.auth.GoogleAuth({ + * // Scopes can be specified either as an array or as a single, space-delimited string. + * scopes: [ + * 'https://www.googleapis.com/auth/cloud-platform', + * 'https://www.googleapis.com/auth/sqlservice.admin', + * ], + * }); + * + * // Acquire an auth client, and bind it to all future calls + * const authClient = await auth.getClient(); + * google.options({auth: authClient}); + * + * // Do the magic + * const res = await sql.instances.addEntraIdCertificate({ + * // Required. Cloud SQL instance ID. This does not include the project ID. + * instance: 'placeholder-value', + * // Required. Project ID of the project that contains the instance. + * project: 'placeholder-value', + * }); + * console.log(res.data); + * + * // Example response + * // { + * // "acquireSsrsLeaseContext": {}, + * // "apiWarning": {}, + * // "backupContext": {}, + * // "endTime": "my_endTime", + * // "error": {}, + * // "exportContext": {}, + * // "importContext": {}, + * // "insertTime": "my_insertTime", + * // "kind": "my_kind", + * // "name": "my_name", + * // "operationType": "my_operationType", + * // "preCheckMajorVersionUpgradeContext": {}, + * // "selfLink": "my_selfLink", + * // "startTime": "my_startTime", + * // "status": "my_status", + * // "subOperationType": {}, + * // "targetId": "my_targetId", + * // "targetLink": "my_targetLink", + * // "targetProject": "my_targetProject", + * // "user": "my_user" + * // } + * } + * + * main().catch(e => { + * console.error(e); + * throw e; + * }); + * + * ``` + * + * @param params - Parameters for request + * @param options - Optionally override request options, such as `url`, `method`, and `encoding`. + * @param callback - Optional callback that handles the response. + * @returns A promise if used with async/await, or void if used with a callback. + */ + addEntraIdCertificate( + params: Params$Resource$Instances$Addentraidcertificate, + options: StreamMethodOptions + ): Promise>; + addEntraIdCertificate( + params?: Params$Resource$Instances$Addentraidcertificate, + options?: MethodOptions + ): Promise>; + addEntraIdCertificate( + params: Params$Resource$Instances$Addentraidcertificate, + options: StreamMethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addEntraIdCertificate( + params: Params$Resource$Instances$Addentraidcertificate, + options: MethodOptions | BodyResponseCallback, + callback: BodyResponseCallback + ): void; + addEntraIdCertificate( + params: Params$Resource$Instances$Addentraidcertificate, + callback: BodyResponseCallback + ): void; + addEntraIdCertificate( + callback: BodyResponseCallback + ): void; + addEntraIdCertificate( + paramsOrCallback?: + | Params$Resource$Instances$Addentraidcertificate + | BodyResponseCallback + | BodyResponseCallback, + optionsOrCallback?: + | MethodOptions + | StreamMethodOptions + | BodyResponseCallback + | BodyResponseCallback, + callback?: + | BodyResponseCallback + | BodyResponseCallback + ): + | void + | Promise> + | Promise> { + let params = (paramsOrCallback || + {}) as Params$Resource$Instances$Addentraidcertificate; + let options = (optionsOrCallback || {}) as MethodOptions; + + if (typeof paramsOrCallback === 'function') { + callback = paramsOrCallback; + params = {} as Params$Resource$Instances$Addentraidcertificate; + options = {}; + } + + if (typeof optionsOrCallback === 'function') { + callback = optionsOrCallback; + options = {}; + } + + const rootUrl = options.rootUrl || 'https://sqladmin.googleapis.com/'; + const parameters = { + options: Object.assign( + { + url: ( + rootUrl + + '/v1/projects/{project}/instances/{instance}/addEntraIdCertificate' + ).replace(/([^:]\/)\/+/g, '$1'), + method: 'POST', + apiVersion: '', + }, + options + ), + params, + requiredParams: ['project', 'instance'], + pathParams: ['instance', 'project'], + context: this.context, + }; + if (callback) { + createAPIRequest( + parameters, + callback as BodyResponseCallback + ); + } else { + return createAPIRequest(parameters); + } + } + /** * Adds a new trusted Certificate Authority (CA) version for the specified instance. Required to prepare for a certificate rotation. If a CA version was previously added but never used in a certificate rotation, this operation replaces that version. There cannot be more than one CA version waiting to be rotated in. For instances that have enabled Certificate Authority Service (CAS) based server CA, use AddServerCertificate to add a new server certificate. * @example @@ -12340,6 +12544,16 @@ export namespace sqladmin_v1 { */ requestBody?: Schema$InstancesAcquireSsrsLeaseRequest; } + export interface Params$Resource$Instances$Addentraidcertificate extends StandardParameters { + /** + * Required. Cloud SQL instance ID. This does not include the project ID. + */ + instance?: string; + /** + * Required. Project ID of the project that contains the instance. + */ + project?: string; + } export interface Params$Resource$Instances$Addserverca extends StandardParameters { /** * Cloud SQL instance ID. This does not include the project ID. diff --git a/src/apis/sqladmin/v1beta4.ts b/src/apis/sqladmin/v1beta4.ts index 0768be8aed3..6f12f0b20d9 100644 --- a/src/apis/sqladmin/v1beta4.ts +++ b/src/apis/sqladmin/v1beta4.ts @@ -2163,7 +2163,7 @@ export namespace sqladmin_v1beta4 { passwordExpirationTime?: string | null; } /** - * Database instance local user password validation policy + * Database instance local user password validation policy. This message defines the password policy for local database users. When enabled, it enforces constraints on password complexity, length, and reuse. Keep this policy enabled to help prevent unauthorized access. */ export interface Schema$PasswordValidationPolicy { /** @@ -2179,7 +2179,7 @@ export namespace sqladmin_v1beta4 { */ disallowUsernameSubstring?: boolean | null; /** - * Whether the password policy is enabled or not. + * Whether to enable the password policy or not. When enabled, passwords must meet complexity requirements. Keep this policy enabled to help prevent unauthorized access. Disabling this policy allows weak passwords. */ enablePasswordPolicy?: boolean | null; /** @@ -2195,6 +2195,35 @@ export namespace sqladmin_v1beta4 { */ reuseInterval?: number | null; } + /** + * Performance Capture configuration. + */ + export interface Schema$PerformanceCaptureConfig { + /** + * Optional. Enable or disable the Performance Capture. + */ + enabled?: boolean | null; + /** + * Optional. The minimum number of consecutive readings above threshold that triggers instance state capture. + */ + probeThreshold?: number | null; + /** + * Optional. The time interval in seconds between any two probes. + */ + probingIntervalSeconds?: number | null; + /** + * Optional. The minimum number of server threads running to trigger the capture on primary. + */ + runningThreadsThreshold?: number | null; + /** + * Optional. The minimum number of seconds replica must be lagging behind primary to trigger capture on replica. + */ + secondsBehindSourceThreshold?: number | null; + /** + * Optional. The amount of time in seconds that a transaction needs to have been open before the watcher starts recording it. + */ + transactionDurationThreshold?: number | null; + } /** * Perform disk shrink context. */ @@ -2261,6 +2290,14 @@ export namespace sqladmin_v1beta4 { * Output only. The name of the read pool node, to be used for retrieving metrics and logs. */ name?: string | null; + /** + * Output only. The list of settings for requested automatically-setup Private Service Connect (PSC) consumer endpoints that can be used to connect to this read pool node. + */ + pscAutoConnections?: Schema$PscAutoConnectionConfig[]; + /** + * Output only. The Private Service Connect (PSC) service attachment of the read pool node. + */ + pscServiceAttachmentLink?: string | null; /** * Output only. The current state of the read pool node. */ @@ -2662,6 +2699,10 @@ export namespace sqladmin_v1beta4 { * The local user password validation policy of the instance. */ passwordValidationPolicy?: Schema$PasswordValidationPolicy; + /** + * Optional. Configuration for Performance Capture, provides diagnostic metrics during high load situations. + */ + performanceCaptureConfig?: Schema$PerformanceCaptureConfig; /** * The pricing plan for this instance. This can be either `PER_USE` or `PACKAGE`. Only `PER_USE` is supported for Second Generation instances. */ @@ -2766,10 +2807,6 @@ export namespace sqladmin_v1beta4 { */ operationId?: string | null; } - /** - * Request for AddEntraIdCertificate RPC. - */ - export interface Schema$SqlInstancesAddEntraIdCertificateRequest {} /** * Execute SQL statements response. */ @@ -6787,12 +6824,6 @@ export namespace sqladmin_v1beta4 { * instance: 'placeholder-value', * // Required. Project ID of the project that contains the instance. * project: 'placeholder-value', - * - * // Request body metadata - * requestBody: { - * // request body parameters - * // {} - * }, * }); * console.log(res.data); * @@ -12538,11 +12569,6 @@ export namespace sqladmin_v1beta4 { * Required. Project ID of the project that contains the instance. */ project?: string; - - /** - * Request body metadata - */ - requestBody?: Schema$SqlInstancesAddEntraIdCertificateRequest; } export interface Params$Resource$Instances$Addserverca extends StandardParameters { /** diff --git a/src/apis/storage/v1.ts b/src/apis/storage/v1.ts index f7b3c567c09..83e63f4d169 100644 --- a/src/apis/storage/v1.ts +++ b/src/apis/storage/v1.ts @@ -646,6 +646,10 @@ export namespace storage_v1 { * A Compose request. */ export interface Schema$ComposeRequest { + /** + * If true, the source objects will be deleted. + */ + deleteSourceObjects?: boolean | null; /** * Properties of the resulting object. */ @@ -11596,6 +11600,7 @@ export namespace storage_v1 { * requestBody: { * // request body parameters * // { + * // "deleteSourceObjects": false, * // "destination": {}, * // "kind": "my_kind", * // "sourceObjects": [] diff --git a/src/apis/tpu/v1.ts b/src/apis/tpu/v1.ts index 7f036747cf2..e11e4532d3d 100644 --- a/src/apis/tpu/v1.ts +++ b/src/apis/tpu/v1.ts @@ -201,7 +201,7 @@ export namespace tpu_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -678,7 +678,7 @@ export namespace tpu_v1 { * * // Do the magic * const res = await tpu.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // 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: 'placeholder-value', @@ -804,7 +804,7 @@ export namespace tpu_v1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -2717,7 +2717,7 @@ export namespace tpu_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -2864,7 +2864,7 @@ export namespace tpu_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/tpu/v1alpha1.ts b/src/apis/tpu/v1alpha1.ts index 5d3b6d707ca..a756ffe8bec 100644 --- a/src/apis/tpu/v1alpha1.ts +++ b/src/apis/tpu/v1alpha1.ts @@ -125,7 +125,7 @@ export namespace tpu_v1alpha1 { } /** - * A accelerator type that a Node can be configured with. + * DEPRECATED: Please use TPU API v2alpha1 instead. A accelerator type that a Node can be configured with. */ export interface Schema$AcceleratorType { /** @@ -142,7 +142,7 @@ export namespace tpu_v1alpha1 { */ export interface Schema$Empty {} /** - * Response for ListAcceleratorTypes. + * DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListAcceleratorTypes. */ export interface Schema$ListAcceleratorTypesResponse { /** @@ -172,7 +172,7 @@ export namespace tpu_v1alpha1 { nextPageToken?: string | null; } /** - * Response for ListNodes. + * DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListNodes. */ export interface Schema$ListNodesResponse { /** @@ -201,12 +201,12 @@ export namespace tpu_v1alpha1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } /** - * Response for ListTensorFlowVersions. + * DEPRECATED: Please use TPU API v2alpha1 instead. Response for ListTensorFlowVersions. */ export interface Schema$ListTensorFlowVersionsResponse { /** @@ -248,7 +248,7 @@ export namespace tpu_v1alpha1 { name?: string | null; } /** - * A network endpoint over which a TPU worker can be reached. + * DEPRECATED: Please use TPU API v2alpha1 instead. A network endpoint over which a TPU worker can be reached. */ export interface Schema$NetworkEndpoint { /** @@ -261,7 +261,7 @@ export namespace tpu_v1alpha1 { port?: number | null; } /** - * A TPU instance. + * DEPRECATED: Please use TPU API v2alpha1 instead. A TPU instance. */ export interface Schema$Node { /** @@ -367,7 +367,7 @@ export namespace tpu_v1alpha1 { response?: {[key: string]: any} | null; } /** - * Metadata describing an Operation + * DEPRECATED: Please use TPU API v2alpha1 instead. Metadata describing an Operation */ export interface Schema$OperationMetadata { /** @@ -400,7 +400,7 @@ export namespace tpu_v1alpha1 { verb?: string | null; } /** - * Request for ReimageNode. + * DEPRECATED: Please use TPU API v2alpha1 instead. Request for ReimageNode. */ export interface Schema$ReimageNodeRequest { /** @@ -409,7 +409,7 @@ export namespace tpu_v1alpha1 { tensorflowVersion?: string | null; } /** - * Sets the scheduling options for this node. + * DEPRECATED: Please use TPU API v2alpha1 instead. Sets the scheduling options for this node. */ export interface Schema$SchedulingConfig { /** @@ -422,7 +422,7 @@ export namespace tpu_v1alpha1 { reserved?: boolean | null; } /** - * Request for StartNode. + * DEPRECATED: Please use TPU API v2alpha1 instead. Request for StartNode. */ export interface Schema$StartNodeRequest {} /** @@ -443,11 +443,11 @@ export namespace tpu_v1alpha1 { message?: string | null; } /** - * Request for StopNode. + * DEPRECATED: Please use TPU API v2alpha1 instead. Request for StopNode. */ export interface Schema$StopNodeRequest {} /** - * A Symptom instance. + * DEPRECATED: Please use TPU API v2alpha1 instead. A Symptom instance. */ export interface Schema$Symptom { /** @@ -468,7 +468,7 @@ export namespace tpu_v1alpha1 { workerId?: string | null; } /** - * A tensorflow version that a Node can be configured with. + * DEPRECATED: Please use TPU API v2alpha1 instead. A tensorflow version that a Node can be configured with. */ export interface Schema$TensorFlowVersion { /** @@ -678,7 +678,7 @@ export namespace tpu_v1alpha1 { * * // Do the magic * const res = await tpu.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // 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: 'placeholder-value', @@ -804,7 +804,7 @@ export namespace tpu_v1alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -2738,7 +2738,7 @@ export namespace tpu_v1alpha1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -2885,7 +2885,7 @@ export namespace tpu_v1alpha1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/tpu/v2.ts b/src/apis/tpu/v2.ts index 17e68eada41..de746e12d29 100644 --- a/src/apis/tpu/v2.ts +++ b/src/apis/tpu/v2.ts @@ -379,7 +379,7 @@ export namespace tpu_v2 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -1314,7 +1314,7 @@ export namespace tpu_v2 { * * // Do the magic * const res = await tpu.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // 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: 'placeholder-value', @@ -1451,7 +1451,7 @@ export namespace tpu_v2 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -3572,7 +3572,7 @@ export namespace tpu_v2 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -3719,7 +3719,7 @@ export namespace tpu_v2 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/tpu/v2alpha1.ts b/src/apis/tpu/v2alpha1.ts index 9903cc807a4..55f2e6cf368 100644 --- a/src/apis/tpu/v2alpha1.ts +++ b/src/apis/tpu/v2alpha1.ts @@ -424,7 +424,7 @@ export namespace tpu_v2alpha1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -1510,7 +1510,7 @@ export namespace tpu_v2alpha1 { * * // Do the magic * const res = await tpu.projects.locations.list({ - * // Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * // Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. * extraLocationTypes: 'placeholder-value', * // 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: 'placeholder-value', @@ -1647,7 +1647,7 @@ export namespace tpu_v2alpha1 { } export interface Params$Resource$Projects$Locations$List extends StandardParameters { /** - * Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. + * Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */ extraLocationTypes?: string[]; /** @@ -4113,7 +4113,7 @@ export namespace tpu_v2alpha1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -4260,7 +4260,7 @@ export namespace tpu_v2alpha1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/workstations/v1.ts b/src/apis/workstations/v1.ts index 8c0a180e26a..26abe99e410 100644 --- a/src/apis/workstations/v1.ts +++ b/src/apis/workstations/v1.ts @@ -316,6 +316,27 @@ export namespace workstations_v1 { */ enableConfidentialCompute?: boolean | null; } + /** + * A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. + */ + export interface Schema$GceHyperdiskBalancedHighAvailability { + /** + * Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. + */ + archiveTimeout?: string | null; + /** + * Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. + */ + reclaimPolicy?: string | null; + /** + * Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. + */ + sizeGb?: number | null; + /** + * Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. + */ + sourceSnapshot?: string | null; + } /** * A runtime using a Compute Engine instance. */ @@ -372,6 +393,10 @@ export namespace workstations_v1 { * Optional. A set of Compute Engine Shielded instance options. */ shieldedInstanceConfig?: Schema$GceShieldedInstanceConfig; + /** + * Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name\}/{object-name\}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. + */ + startupScriptUri?: string | null; /** * Optional. Network tags to add to the Compute Engine VMs backing the workstations. This option applies [network tags](https://cloud.google.com/vpc/docs/add-remove-network-tags) to VMs created with this configuration. These network tags enable the creation of [firewall rules](https://cloud.google.com/workstations/docs/configure-firewall-rules). */ @@ -530,7 +555,7 @@ export namespace workstations_v1 { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -706,6 +731,10 @@ export namespace workstations_v1 { * A directory to persist across workstation sessions. Updates to this field will not update existing workstations and will only take effect on new workstations. */ export interface Schema$PersistentDirectory { + /** + * A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. + */ + gceHd?: Schema$GceHyperdiskBalancedHighAvailability; /** * A PersistentDirectory backed by a Compute Engine persistent disk. */ @@ -1925,7 +1954,7 @@ export namespace workstations_v1 { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -2077,7 +2106,7 @@ export namespace workstations_v1 { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; } diff --git a/src/apis/workstations/v1beta.ts b/src/apis/workstations/v1beta.ts index fe2a7650565..8e8a9a79155 100644 --- a/src/apis/workstations/v1beta.ts +++ b/src/apis/workstations/v1beta.ts @@ -321,7 +321,7 @@ export namespace workstations_v1beta { enableConfidentialCompute?: boolean | null; } /** - * A Persistent Directory backed by a Compute Engine Hyperdisk Balanced High Availability Disk. This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. + * A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. */ export interface Schema$GceHyperdiskBalancedHighAvailability { /** @@ -373,6 +373,10 @@ export namespace workstations_v1beta { * Optional. Whether to enable nested virtualization on Cloud Workstations VMs created using this workstation configuration. Defaults to false. Nested virtualization lets you run virtual machine (VM) instances inside your workstation. Before enabling nested virtualization, consider the following important considerations. Cloud Workstations instances are subject to the [same restrictions as Compute Engine instances](https://cloud.google.com/compute/docs/instances/nested-virtualization/overview#restrictions): * **Organization policy**: projects, folders, or organizations may be restricted from creating nested VMs if the **Disable VM nested virtualization** constraint is enforced in the organization policy. For more information, see the Compute Engine section, [Checking whether nested virtualization is allowed](https://cloud.google.com/compute/docs/instances/nested-virtualization/managing-constraint#checking_whether_nested_virtualization_is_allowed). * **Performance**: nested VMs might experience a 10% or greater decrease in performance for workloads that are CPU-bound and possibly greater than a 10% decrease for workloads that are input/output bound. * **Machine Type**: nested virtualization can only be enabled on workstation configurations that specify a machine_type in the N1 or N2 machine series. */ enableNestedVirtualization?: boolean | null; + /** + * Optional. Custom metadata to apply to Compute Engine instances. + */ + instanceMetadata?: {[key: string]: string} | null; /** * Optional. The type of machine to use for VM instances—for example, `"e2-standard-4"`. For more information about machine types that Cloud Workstations supports, see the list of [available machine types](https://cloud.google.com/workstations/docs/available-machine-types). */ @@ -402,7 +406,7 @@ export namespace workstations_v1beta { */ shieldedInstanceConfig?: Schema$GceShieldedInstanceConfig; /** - * Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The uri must be of the form gs://{bucket-name\}/{object-name\}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. + * Optional. Link to the startup script stored in Cloud Storage. This script will be run on the host workstation VM when the VM is created. The URI must be of the form gs://{bucket-name\}/{object-name\}. If specifying a startup script, the service account must have [Permission to access the bucket and script file in Cloud Storage](https://cloud.google.com/storage/docs/access-control/iam-permissions). Otherwise, the script must be publicly accessible. Note that the service regularly updates the OS version used, and it is the responsibility of the user to ensure the script stays compatible with the OS version. */ startupScriptUri?: string | null; /** @@ -563,7 +567,7 @@ export namespace workstations_v1beta { */ operations?: Schema$Operation[]; /** - * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections e.g. when attempting to list all resources across all supported locations. + * Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations. */ unreachable?: string[] | null; } @@ -1695,7 +1699,7 @@ export namespace workstations_v1beta { * pageSize: 'placeholder-value', * // The standard list page token. * pageToken: 'placeholder-value', - * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * // When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. * returnPartialSuccess: 'placeholder-value', * }); * console.log(res.data); @@ -1847,7 +1851,7 @@ export namespace workstations_v1beta { */ pageToken?: string; /** - * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the [ListOperationsResponse.unreachable] field. This can only be `true` when reading across collections e.g. when `parent` is set to `"projects/example/locations/-"`. This field is not by default supported and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. + * When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation. */ returnPartialSuccess?: boolean; }