From 8bfbeaca4cb80ffe972d56762c832ed31785e8ca Mon Sep 17 00:00:00 2001 From: Yoshi Automation Bot Date: Fri, 3 Nov 2023 00:22:14 -0700 Subject: [PATCH] feat(all): auto-regenerate discovery clients (#2246) --- appengine/v1/appengine-api.json | 151 +- appengine/v1/appengine-gen.go | 320 +++ contentwarehouse/v1/contentwarehouse-api.json | 149 +- contentwarehouse/v1/contentwarehouse-gen.go | 153 +- dataproc/v1/dataproc-api.json | 14 +- dataproc/v1/dataproc-gen.go | 10 + .../v1alpha/discoveryengine-api.json | 4 +- .../v1alpha/discoveryengine-gen.go | 9 +- .../v1beta/discoveryengine-api.json | 4 +- discoveryengine/v1beta/discoveryengine-gen.go | 9 +- dlp/v2/dlp-api.json | 18 +- dlp/v2/dlp-gen.go | 31 +- healthcare/v1/healthcare-api.json | 44 +- healthcare/v1/healthcare-gen.go | 132 +- healthcare/v1beta1/healthcare-api.json | 252 +- healthcare/v1beta1/healthcare-gen.go | 854 ++++++- .../v1alpha1/migrationcenter-api.json | 25 +- .../v1alpha1/migrationcenter-gen.go | 28 + .../v1/networkconnectivity-api.json | 84 +- .../v1/networkconnectivity-gen.go | 370 --- searchads360/v0/searchads360-api.json | 1911 +++++++++++++- searchads360/v0/searchads360-gen.go | 2250 ++++++++++++++++- securitycenter/v1/securitycenter-api.json | 51 +- securitycenter/v1/securitycenter-gen.go | 85 +- .../v1beta1/securitycenter-api.json | 51 +- securitycenter/v1beta1/securitycenter-gen.go | 85 +- .../v1beta2/securitycenter-api.json | 51 +- securitycenter/v1beta2/securitycenter-gen.go | 85 +- 28 files changed, 6179 insertions(+), 1051 deletions(-) diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json index 5eda718c29c..d475760900b 100644 --- a/appengine/v1/appengine-api.json +++ b/appengine/v1/appengine-api.json @@ -171,6 +171,47 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, + "listRuntimes": { + "description": "Lists all the available runtimes for the application.", + "flatPath": "v1/apps/{appsId}:listRuntimes", + "httpMethod": "GET", + "id": "appengine.apps.listRuntimes", + "parameterOrder": [ + "appsId" + ], + "parameters": { + "appsId": { + "description": "Part of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.", + "location": "path", + "required": true, + "type": "string" + }, + "environment": { + "description": "Optional. The environment of the Application.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "STANDARD", + "FLEXIBLE" + ], + "enumDescriptions": [ + "Default value.", + "App Engine Standard.", + "App Engine Flexible" + ], + "location": "query", + "type": "string" + } + }, + "path": "v1/apps/{appsId}:listRuntimes", + "response": { + "$ref": "ListRuntimesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, "patch": { "description": "Updates the specified Application resource. You can update the following fields: auth_domain - Google authentication domain for controlling user access to the application. default_cookie_expiration - Cookie expiration policy for the application. iap - Identity-Aware Proxy properties for the application.", "flatPath": "v1/apps/{appsId}", @@ -1610,7 +1651,7 @@ } } }, - "revision": "20231024", + "revision": "20231030", "rootUrl": "https://appengine.googleapis.com/", "schemas": { "ApiConfigHandler": { @@ -2096,6 +2137,28 @@ }, "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" + }, "DebugInstanceRequest": { "description": "Request message for Instances.DebugInstance.", "id": "DebugInstanceRequest", @@ -2701,6 +2764,24 @@ }, "type": "object" }, + "ListRuntimesResponse": { + "description": "Response message for Applications.ListRuntimes.", + "id": "ListRuntimesResponse", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "runtimes": { + "description": "The runtimes available to the requested application.", + "items": { + "$ref": "Runtime" + }, + "type": "array" + } + }, + "type": "object" + }, "ListServicesResponse": { "description": "Response message for Services.ListServices.", "id": "ListServicesResponse", @@ -3431,6 +3512,74 @@ }, "type": "object" }, + "Runtime": { + "description": "Runtime versions for App Engine.", + "id": "Runtime", + "properties": { + "decommissionedDate": { + "$ref": "Date", + "description": "Date when Runtime is decommissioned." + }, + "deprecationDate": { + "$ref": "Date", + "description": "Date when Runtime is deprecated." + }, + "endOfSupportDate": { + "$ref": "Date", + "description": "Date when Runtime is end of support." + }, + "environment": { + "description": "The environment of the runtime.", + "enum": [ + "ENVIRONMENT_UNSPECIFIED", + "STANDARD", + "FLEXIBLE" + ], + "enumDescriptions": [ + "Default value.", + "App Engine Standard.", + "App Engine Flexible" + ], + "type": "string" + }, + "name": { + "description": "The name of the runtime, e.g., 'go113', 'nodejs12', etc.", + "type": "string" + }, + "stage": { + "description": "The stage of life this runtime is in, e.g., BETA, GA, etc.", + "enum": [ + "RUNTIME_STAGE_UNSPECIFIED", + "DEVELOPMENT", + "ALPHA", + "BETA", + "GA", + "DEPRECATED", + "DECOMMISSIONED", + "END_OF_SUPPORT" + ], + "enumDescriptions": [ + "Not specified.", + "The runtime is in development.", + "The runtime is in the Alpha stage.", + "The runtime is in the Beta stage.", + "The runtime is generally available.", + "The runtime is deprecated.", + "The runtime is no longer supported.", + "The runtime is end of support." + ], + "type": "string" + }, + "warnings": { + "description": "Warning messages, e.g., a deprecation warning.", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, "ScriptHandler": { "description": "Executes a script to handle the request that matches the URL pattern.", "id": "ScriptHandler", diff --git a/appengine/v1/appengine-gen.go b/appengine/v1/appengine-gen.go index 542047cd1e0..ac15e380e7f 100644 --- a/appengine/v1/appengine-gen.go +++ b/appengine/v1/appengine-gen.go @@ -1144,6 +1144,52 @@ func (s *CreateVersionMetadataV1Beta) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// Date: Represents a whole or partial calendar date, such as a +// birthday. The time of day and time zone are either specified +// elsewhere or are insignificant. The date is relative to the Gregorian +// Calendar. This can represent one of the following: A full date, with +// non-zero year, month, and day values. A month and day, with a zero +// year (for example, an anniversary). A year on its own, with a zero +// month and a zero day. A year and month, with a zero day (for example, +// a credit card expiration date).Related types: google.type.TimeOfDay +// google.type.DateTime google.protobuf.Timestamp +type Date struct { + // Day: 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 int64 `json:"day,omitempty"` + + // Month: Month of a year. Must be from 1 to 12, or 0 to specify a year + // without a month and day. + Month int64 `json:"month,omitempty"` + + // Year: Year of the date. Must be from 1 to 9999, or 0 to specify a + // date without a year. + Year int64 `json:"year,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Day") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Day") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *Date) MarshalJSON() ([]byte, error) { + type NoMethod Date + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // DebugInstanceRequest: Request message for Instances.DebugInstance. type DebugInstanceRequest struct { // SshKey: Public SSH key to add to the instance. Examples: @@ -2198,6 +2244,42 @@ func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// ListRuntimesResponse: Response message for Applications.ListRuntimes. +type ListRuntimesResponse struct { + // NextPageToken: Continuation token for fetching the next page of + // results. + NextPageToken string `json:"nextPageToken,omitempty"` + + // Runtimes: The runtimes available to the requested application. + Runtimes []*Runtime `json:"runtimes,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "NextPageToken") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "NextPageToken") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *ListRuntimesResponse) MarshalJSON() ([]byte, error) { + type NoMethod ListRuntimesResponse + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ListServicesResponse: Response message for Services.ListServices. type ListServicesResponse struct { // NextPageToken: Continuation token for fetching the next page of @@ -3311,6 +3393,68 @@ func (s *Resources) UnmarshalJSON(data []byte) error { return nil } +// Runtime: Runtime versions for App Engine. +type Runtime struct { + // DecommissionedDate: Date when Runtime is decommissioned. + DecommissionedDate *Date `json:"decommissionedDate,omitempty"` + + // DeprecationDate: Date when Runtime is deprecated. + DeprecationDate *Date `json:"deprecationDate,omitempty"` + + // EndOfSupportDate: Date when Runtime is end of support. + EndOfSupportDate *Date `json:"endOfSupportDate,omitempty"` + + // Environment: The environment of the runtime. + // + // Possible values: + // "ENVIRONMENT_UNSPECIFIED" - Default value. + // "STANDARD" - App Engine Standard. + // "FLEXIBLE" - App Engine Flexible + Environment string `json:"environment,omitempty"` + + // Name: The name of the runtime, e.g., 'go113', 'nodejs12', etc. + Name string `json:"name,omitempty"` + + // Stage: The stage of life this runtime is in, e.g., BETA, GA, etc. + // + // Possible values: + // "RUNTIME_STAGE_UNSPECIFIED" - Not specified. + // "DEVELOPMENT" - The runtime is in development. + // "ALPHA" - The runtime is in the Alpha stage. + // "BETA" - The runtime is in the Beta stage. + // "GA" - The runtime is generally available. + // "DEPRECATED" - The runtime is deprecated. + // "DECOMMISSIONED" - The runtime is no longer supported. + // "END_OF_SUPPORT" - The runtime is end of support. + Stage string `json:"stage,omitempty"` + + // Warnings: Warning messages, e.g., a deprecation warning. + Warnings []string `json:"warnings,omitempty"` + + // ForceSendFields is a list of field names (e.g. "DecommissionedDate") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "DecommissionedDate") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *Runtime) MarshalJSON() ([]byte, error) { + type NoMethod Runtime + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // ScriptHandler: Executes a script to handle the request that matches // the URL pattern. type ScriptHandler struct { @@ -4520,6 +4664,182 @@ func (c *AppsGetCall) Do(opts ...googleapi.CallOption) (*Application, error) { } +// method id "appengine.apps.listRuntimes": + +type AppsListRuntimesCall struct { + s *APIService + appsId string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// ListRuntimes: Lists all the available runtimes for the application. +// +// - appsId: Part of `parent`. Name of the parent Application resource. +// Example: apps/myapp. +func (r *AppsService) ListRuntimes(appsId string) *AppsListRuntimesCall { + c := &AppsListRuntimesCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.appsId = appsId + return c +} + +// Environment sets the optional parameter "environment": The +// environment of the Application. +// +// Possible values: +// +// "ENVIRONMENT_UNSPECIFIED" - Default value. +// "STANDARD" - App Engine Standard. +// "FLEXIBLE" - App Engine Flexible +func (c *AppsListRuntimesCall) Environment(environment string) *AppsListRuntimesCall { + c.urlParams_.Set("environment", environment) + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *AppsListRuntimesCall) Fields(s ...googleapi.Field) *AppsListRuntimesCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *AppsListRuntimesCall) IfNoneMatch(entityTag string) *AppsListRuntimesCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *AppsListRuntimesCall) Context(ctx context.Context) *AppsListRuntimesCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *AppsListRuntimesCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *AppsListRuntimesCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1/apps/{appsId}:listRuntimes") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "appsId": c.appsId, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "appengine.apps.listRuntimes" call. +// Exactly one of *ListRuntimesResponse or error will be non-nil. Any +// non-2xx status code is an error. Response headers are in either +// *ListRuntimesResponse.ServerResponse.Header or (if a response was +// returned at all) in error.(*googleapi.Error).Header. Use +// googleapi.IsNotModified to check whether the returned error was +// because http.StatusNotModified was returned. +func (c *AppsListRuntimesCall) Do(opts ...googleapi.CallOption) (*ListRuntimesResponse, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &ListRuntimesResponse{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "Lists all the available runtimes for the application.", + // "flatPath": "v1/apps/{appsId}:listRuntimes", + // "httpMethod": "GET", + // "id": "appengine.apps.listRuntimes", + // "parameterOrder": [ + // "appsId" + // ], + // "parameters": { + // "appsId": { + // "description": "Part of `parent`. Required. Name of the parent Application resource. Example: apps/myapp.", + // "location": "path", + // "required": true, + // "type": "string" + // }, + // "environment": { + // "description": "Optional. The environment of the Application.", + // "enum": [ + // "ENVIRONMENT_UNSPECIFIED", + // "STANDARD", + // "FLEXIBLE" + // ], + // "enumDescriptions": [ + // "Default value.", + // "App Engine Standard.", + // "App Engine Flexible" + // ], + // "location": "query", + // "type": "string" + // } + // }, + // "path": "v1/apps/{appsId}:listRuntimes", + // "response": { + // "$ref": "ListRuntimesResponse" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/appengine.admin", + // "https://www.googleapis.com/auth/cloud-platform", + // "https://www.googleapis.com/auth/cloud-platform.read-only" + // ] + // } + +} + // method id "appengine.apps.patch": type AppsPatchCall struct { diff --git a/contentwarehouse/v1/contentwarehouse-api.json b/contentwarehouse/v1/contentwarehouse-api.json index 5807915fd4a..6022792b26b 100644 --- a/contentwarehouse/v1/contentwarehouse-api.json +++ b/contentwarehouse/v1/contentwarehouse-api.json @@ -1156,7 +1156,7 @@ } } }, - "revision": "20231020", + "revision": "20231026", "rootUrl": "https://contentwarehouse.googleapis.com/", "schemas": { "AbuseiamAbuseType": { @@ -9734,6 +9734,10 @@ "description": "This provider has integrated its content with Google, and Google has enabled to serve its content as a server-side solution.", "type": "boolean" }, + "supports3pPodcastPlayback": { + "description": "Indicates whether the provider supports playback of 3P(externally hosted) podcasts.", + "type": "boolean" + }, "supportsScreenlessInitiation": { "description": "This provider has an app that supports starting new media playback when there is no screen (e.g. by integrating with the Bisto SDK).", "type": "boolean" @@ -33937,7 +33941,8 @@ "PROVIDER_EZVOLT", "PROVIDER_JOLT", "PROVIDER_CHARGESMITH", - "PROVIDER_PLUGO" + "PROVIDER_PLUGO", + "PROVIDER_ELECTRIC_ERA" ], "enumDeprecated": [ false, @@ -34659,6 +34664,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -35381,7 +35387,8 @@ "", "", "", - "Note: Next available value is 0x1271." + "", + "Note: Next available value is 0x1272." ], "type": "string" }, @@ -36506,7 +36513,7 @@ }, "endAsOfDate": { "$ref": "GeostoreDateTimeProto", - "description": "RESERVED" + "description": "The earliest known date of this feature's \"end\" (e.g. an establishment's permanent closure), if the actual date is unknown; i.e. the best known upper bound of the day end_date would represent. end_as_of_date must be in local (civil) time and of PRECISION_DAY. For example, given an establishment: * Without any end_as_of_date, the permanent closure definitely isn't now and isn't known to start at any point in the future. * With an end_as_of_date of 2023-04-05 but without any end_date, the permanent closure definitely starts at latest 2023-04-05 but may start before 2023-04-05. * With an end_as_of_date of 2023-04-05 and an end_date of 2023 (at just PRECISION_YEAR), the permanent closure definitely starts at earliest 2023-01-01 (i.e. the first day of 2023) and at latest 2023-04-05, but may start at any day between 2023-01-01 and 2023-04-05. IMPORTANT: Generally for Geo Schema-internal use only. If you believe you need to use this field directly, please go/contact-geo-schema." }, "endDate": { "$ref": "GeostoreDateTimeProto" @@ -36739,6 +36746,7 @@ "ACCESS_POINT", "ADDRESS", "ANCHORED_GEOMETRY_GEOMETRY_ID", + "ASSOCIATED_EV_CHARGING_STATION", "ATTACHMENT", "BIZBUILDER_REFERENCE", "BORDER_FEATURE_ID_LEFT", @@ -37124,6 +37132,7 @@ false, false, false, + false, true, true, true, @@ -37386,6 +37395,7 @@ "", "", "", + "", "" ], "type": "string" @@ -37423,6 +37433,13 @@ "$ref": "GeostoreAnchoredGeometryProto", "description": "Represents information about the feature’s anchored geometry." }, + "associatedEvChargingStation": { + "description": "RESERVED", + "items": { + "$ref": "GeostoreFeatureIdProto" + }, + "type": "array" + }, "attachment": { "description": "The collection of attachments for this feature. Documentation: http://go/geo-attachments", "items": { @@ -40249,7 +40266,8 @@ "PROVIDER_EZVOLT", "PROVIDER_JOLT", "PROVIDER_CHARGESMITH", - "PROVIDER_PLUGO" + "PROVIDER_PLUGO", + "PROVIDER_ELECTRIC_ERA" ], "enumDeprecated": [ false, @@ -40971,6 +40989,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -41693,7 +41712,8 @@ "", "", "", - "Note: Next available value is 0x1271." + "", + "Note: Next available value is 0x1272." ], "type": "string" } @@ -43188,7 +43208,8 @@ "PROVIDER_EZVOLT", "PROVIDER_JOLT", "PROVIDER_CHARGESMITH", - "PROVIDER_PLUGO" + "PROVIDER_PLUGO", + "PROVIDER_ELECTRIC_ERA" ], "enumDeprecated": [ false, @@ -43910,6 +43931,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -44632,7 +44654,8 @@ "", "", "", - "Note: Next available value is 0x1271." + "", + "Note: Next available value is 0x1272." ], "type": "string" }, @@ -46430,7 +46453,8 @@ "PROVIDER_EZVOLT", "PROVIDER_JOLT", "PROVIDER_CHARGESMITH", - "PROVIDER_PLUGO" + "PROVIDER_PLUGO", + "PROVIDER_ELECTRIC_ERA" ], "enumDeprecated": [ false, @@ -47152,6 +47176,7 @@ false, false, false, + false, false ], "enumDescriptions": [ @@ -47874,7 +47899,8 @@ "", "", "", - "Note: Next available value is 0x1271." + "", + "Note: Next available value is 0x1272." ], "type": "string" } @@ -75574,6 +75600,7 @@ "RETURN_CALL", "RETURN_MISSED_CALL", "ROUTINE", + "ROUTINE_INVOCATION", "DIAL_INTO_MEETING", "SHARE_DIGITAL_OBJECT", "COMPOSE_EMAIL", @@ -75663,6 +75690,7 @@ "", "", "", + "", "" ], "type": "string" @@ -97954,14 +97982,14 @@ false, false, false, - false, - false, - false, - false, - false, - false, - false, - false, + true, + true, + true, + true, + true, + true, + true, + true, false, false, false, @@ -98377,7 +98405,7 @@ "Notification to ask users to complete the Morris OOBE and use Morris in their next drive.", "", "", - "", + "Driving Screen and Micro were both turned down.", "", "", "", @@ -110424,11 +110452,6 @@ "$ref": "RepositoryWebrefConceptNameMetadata", "description": "Metadata attached to the name." }, - "nonLocationalScore": { - "description": "Whether the mention is a non-locational reference to a geographical entity. Ranges from 0 (locational) to 1 (non-locational).", - "format": "float", - "type": "number" - }, "perMentionLightweightToken": { "$ref": "RepositoryWebrefLightweightTokensPerMentionLightweightToken", "description": "Provides concised access to all matched MatchedLightweightToken." @@ -111449,54 +111472,25 @@ "description": "Information about where the url comes from.", "id": "RepositoryWebrefPreprocessingUrlSourceInfo", "properties": { - "deprecatedOldSchema": { - "$ref": "RepositoryWebrefPreprocessingUrlSourceInfoOldSchema", - "deprecated": true - }, - "newSchema": { - "$ref": "RepositoryWebrefPreprocessingUrlSourceInfoNewSchema" - }, "originalUrl": { "type": "string" }, "source": { "enum": [ - "DEPRECATED_OLD_SCHEMA", + "SOURCE_UNKNOWN", "KG", "KG_TRUSTED", "WIKIJOIN", "PRODUCT_OFFER", "OYSTER_FEATURE", - "EXTRACTED_REFPAGE", - "EXPERIMENT", - "SOURCE_PROTO", "MINED_REFERENCE_PAGE", "WEBREF_YEAR", - "BOOK_REF_PAGES_MINING_PIPELINE", "LYRICS_REFERENCE_PAGE", "KG_WEAK_DATA", "RELATED_PAGE", "MINED_RELATED_PAGE", - "KG_SOCIAL_PROFILE" - ], - "enumDeprecated": [ - true, - false, - false, - false, - true, - false, - true, - false, - false, - false, - false, - true, - false, - false, - false, - false, - false + "KG_SOCIAL_PROFILE", + "DEEP_LINK" ], "enumDescriptions": [ "", @@ -111505,43 +111499,20 @@ "", "", "", - "", - "", - "A fake reference page based on a text extracted from the source proto. For example, product clusters get such refpages based on the descriptions pulled from their source protos (catalog offers).", "Since cl/142284568 this field represents also book reference pages.", "Wikipedia URLs for webref year topic.", - "Pages mined by book reference pages mining pipeline.", "Reference pages for songs mined by matching content of lyrics pages to the known lyrics of a song. NOTE: The pipeline that produces these is maintained by the kg-music@.", "From kg topic and all provenances were marked as go/weak-data.", "The URL of a webpage related to this entity. The page should contain information about this entity, but this entity does not need to be central to it. Examples would be news stories in which this entity figures. RELATED_PAGE are provided by clients and MINED_RELATED_PAGE are mined programmatically (go/related-pages).", "", - "Url to a social profile belonging to the entity as read from KG." + "Url to a social profile belonging to the entity as read from KG.", + "Extracted from deep link triples (media entities)." ], "type": "string" } }, "type": "object" }, - "RepositoryWebrefPreprocessingUrlSourceInfoNewSchema": { - "description": "Source information for the new reference url Freebase schema.", - "id": "RepositoryWebrefPreprocessingUrlSourceInfoNewSchema", - "properties": { - "sourceProperty": { - "type": "string" - } - }, - "type": "object" - }, - "RepositoryWebrefPreprocessingUrlSourceInfoOldSchema": { - "description": "Source information for the old reference url Freebase schema.", - "id": "RepositoryWebrefPreprocessingUrlSourceInfoOldSchema", - "properties": { - "isOfficial": { - "type": "boolean" - } - }, - "type": "object" - }, "RepositoryWebrefProcessorCounter": { "description": "A single processor counter stored as a pair of the counter name and the value.", "id": "RepositoryWebrefProcessorCounter", @@ -122515,7 +122486,7 @@ false, false, false, - false, + true, false, false, false, @@ -122706,7 +122677,7 @@ "WARNING! Sensitive data under strict contractual usage agreements. DO NOT use without permission and understanding of usage constraints. YOU MUST CONTACT travel-ttd-ecosystem-team@ before reading or writing this data.", "WARNING! Sensitive data under strict contractual usage agreements. DO NOT use without permission and understanding of usage constraints. YOU MUST CONTACT fo-partner-eng@ before reading or writing this data.", "WARNING! Sensitive data under strict contractual usage agreements. DO NOT use without permission and understanding of usage constraints. This is an access restriction for accessing Yeti publisher image data in KG. For now it should be used ONLY for Yeti. YOU MUST CONTACT stadia-knowledge-eng@ before reading or writing this data.", - "In order to test BBC metadata before serving code populates them to the public", + "This ACL was used to evaluating UMP GetMedia API changes for the BBC exclusive provider metadata launch. The evaluation was done and we don't cover BBC provider metadata with this ACL anymore in production.", "WARNING! User generated data. DO NOT use without permission and understanding of usage constraints. This data is from the Janata feature and contains information that a user chose to disclose as pubilc about themselves. YOU MUST CONTACT npp-lr@ before reading or writing data with this acl.", "WARNING! DO NOT use without permission and understanding of usage constraints. This is data that needed to be triangulated but lacked support from three different data sources. The purpose of this ACL is to allow RefX to access even the data that lacks triangulation. More background on this can be found at go/baike-triangulation. YOU MUST CONTACT lg-composition@ before reading or writing data with this acl.", "WARNING! Sensitive data under strict contractual usage agreements. DO NOT use without permission and understanding of usage constraints. YouTube Red Original prerealeased shows, seasons and episodes. YOU MUST CONTACT ajithm@ before reading or writing data with this acl.", @@ -127196,6 +127167,7 @@ "MULTILINE_SUBSCRIPTION_BASIC_RESTORE_ENABLED_SESSION_LEVEL", "DECLINE_MESSAGE_IN_SUBSCENTER_FIX_FLOW_SESSION_LEVEL_V1", "SAVE_FOR_LATER_CART_ABANDONMENT_SCREEN_SESSION_LEVEL", + "CROSS_FORM_FACTOR_DETAILS_PAGEN_SESSION_LEVEL", "SESSION_LEVEL_TEST_CODE_LIMIT", "CART_ABANDONMENT_USER_LEVEL", "IN_APP_PRODUCTS_IN_DETAILS_PAGE_USER_LEVEL", @@ -128767,6 +128739,7 @@ false, false, false, + false, true, false, false, @@ -129956,6 +129929,7 @@ "Session_level test code for multiline basic restore enabled.", "Session-level test code thst indicates decline message is popluated in subscenter.", "Session level test code for Save For Later cart abandonment screen.", + "Test codes for form factor details page. See go/play-xff-dp-serving.", "", "Cart abandonment flow for purchase flow.", "User saw/would have seen the in app products section in App", @@ -130626,6 +130600,7 @@ "OBJECTIVE_INGREDIENT_GO_LIVE", "OBJECTIVE_INGREDIENT_VALIDATED", "OBJECTIVE_PRIMARY_ASSETS_DONE", + "OBJECTIVE_PRIMARY_TRANSCODES_DONE", "OBJECTIVE_PREVIEW_DONE", "OBJECTIVE_TRANSMUXED_DONE", "OBJECTIVE_MEDIA_INFO_DONE", @@ -130660,6 +130635,7 @@ false, false, false, + false, true, false, false, @@ -130680,6 +130656,7 @@ "Enough was done on the ingredient for the video to be playable.", "The validation asset is ready.", "The most important transcodes and other assets have been completed. Drives \"is_fully_processed\" in VAPI. Limited to UGC and Reels. Also used to atomically publish all latency-sensitive transcodes after an edit.", + "Subset of OBJECTIVE_PRIMARY_ASSETS_DONE including transcode assets only.", "A representation for the video in advance of all completed assets is ready.", "The transmuxed transcode for the video, used for faster playback in certain early GO_LIVE scenarios, is playable. This is currently limited to Photos.", "Basic media information is available -- a rare single-asset objective, to advertise a video's general information as quickly as possible.", @@ -147362,6 +147339,7 @@ "LOW_QUALITY", "LOW_QUALITY_HIGH_RECALL", "MALWARE", + "MISLEADING", "PEDOPHILIA", "PHISHING", "PORNOGRAPHY", @@ -147404,6 +147382,7 @@ "Reasons applies to AutoMod and TnS. go/ytc-adjustable-automod-backend-design Low quality/Annoying content. Used by TnS and AutoMod. Maps to AUTOMOD_SYSTEM_HOLD", "AutoMod specific reasons. Maps to AUTOMOD_SYSTEM_HOLD_MORE", "MALWARE includes viruses, worms, trojans, adware and even potentially unwanted software which may not necessarily be harmful.", + "Policy to cover specific types of misinformation that actuates real world harm in ways that are not purely digital. 1) Misleading content related to civic and democratic processes, 2) Misleading health or medical content, 3) Deceptively manipulated media.", "Not illegal, but image or text content promoting or related to young pornography.", "", "", @@ -147564,6 +147543,7 @@ "WEB_INTERNAL_ANALYTICS", "WEB_PARENT_TOOLS", "WEB_PHONE_VERIFICATION", + "WEB_SHOPPING_EXTENSION", "WEB_EMBEDDED_PLAYER", "WEB_EFFECT_MAKER", "WEB_UNPLUGGED", @@ -147665,7 +147645,8 @@ "YouTube Internal Analytics", "YT Parent Tools web app (go/parent-zone-prd).", "YouTube Phone Verification web app", - "(go/wexit-phone-verify).", + "(go/wexit-phone-verify). YouTube Shopping Extension Client", + "go/yt-shopping-chrome-extension", "YouTube Effect Maker web app.", "Unplugged web clients. Sign-in, member experience (Polymer app).", "Onboarding web app.", diff --git a/contentwarehouse/v1/contentwarehouse-gen.go b/contentwarehouse/v1/contentwarehouse-gen.go index 706afbabbd3..023e0596347 100644 --- a/contentwarehouse/v1/contentwarehouse-gen.go +++ b/contentwarehouse/v1/contentwarehouse-gen.go @@ -10769,6 +10769,10 @@ type AssistantApiAppCapabilities struct { // solution. SearchableOnServer bool `json:"searchableOnServer,omitempty"` + // Supports3pPodcastPlayback: Indicates whether the provider supports + // playback of 3P(externally hosted) podcasts. + Supports3pPodcastPlayback bool `json:"supports3pPodcastPlayback,omitempty"` + // SupportsScreenlessInitiation: This provider has an app that supports // starting new media playback when there is no screen (e.g. by // integrating with the Bisto SDK). @@ -41384,7 +41388,8 @@ type GeostoreDataSourceProto struct { // "PROVIDER_EZVOLT" // "PROVIDER_JOLT" // "PROVIDER_CHARGESMITH" - // "PROVIDER_PLUGO" - Note: Next available value is 0x1271. + // "PROVIDER_PLUGO" + // "PROVIDER_ELECTRIC_ERA" - Note: Next available value is 0x1272. Provider string `json:"provider,omitempty"` // RawMetadata: For every key that is used in raw_data from this source, @@ -42519,7 +42524,21 @@ type GeostoreExistenceProto struct { // te) Closed bool `json:"closed,omitempty"` - // EndAsOfDate: RESERVED + // EndAsOfDate: The earliest known date of this feature's "end" (e.g. an + // establishment's permanent closure), if the actual date is unknown; + // i.e. the best known upper bound of the day end_date would represent. + // end_as_of_date must be in local (civil) time and of PRECISION_DAY. + // For example, given an establishment: * Without any end_as_of_date, + // the permanent closure definitely isn't now and isn't known to start + // at any point in the future. * With an end_as_of_date of 2023-04-05 + // but without any end_date, the permanent closure definitely starts at + // latest 2023-04-05 but may start before 2023-04-05. * With an + // end_as_of_date of 2023-04-05 and an end_date of 2023 (at just + // PRECISION_YEAR), the permanent closure definitely starts at earliest + // 2023-01-01 (i.e. the first day of 2023) and at latest 2023-04-05, but + // may start at any day between 2023-01-01 and 2023-04-05. IMPORTANT: + // Generally for Geo Schema-internal use only. If you believe you need + // to use this field directly, please go/contact-geo-schema. EndAsOfDate *GeostoreDateTimeProto `json:"endAsOfDate,omitempty"` EndDate *GeostoreDateTimeProto `json:"endDate,omitempty"` @@ -42975,6 +42994,7 @@ type GeostoreFeaturePropertyIdProto struct { // "ACCESS_POINT" // "ADDRESS" // "ANCHORED_GEOMETRY_GEOMETRY_ID" + // "ASSOCIATED_EV_CHARGING_STATION" // "ATTACHMENT" // "BIZBUILDER_REFERENCE" // "BORDER_FEATURE_ID_LEFT" @@ -43268,6 +43288,9 @@ type GeostoreFeatureProto struct { // anchored geometry. AnchoredGeometry *GeostoreAnchoredGeometryProto `json:"anchoredGeometry,omitempty"` + // AssociatedEvChargingStation: RESERVED + AssociatedEvChargingStation []*GeostoreFeatureIdProto `json:"associatedEvChargingStation,omitempty"` + // Attachment: The collection of attachments for this feature. // Documentation: http://go/geo-attachments Attachment []*GeostoreAttachmentsAttachmentProto `json:"attachment,omitempty"` @@ -46056,7 +46079,8 @@ type GeostoreInternalSourceSummaryProto struct { // "PROVIDER_EZVOLT" // "PROVIDER_JOLT" // "PROVIDER_CHARGESMITH" - // "PROVIDER_PLUGO" - Note: Next available value is 0x1271. + // "PROVIDER_PLUGO" + // "PROVIDER_ELECTRIC_ERA" - Note: Next available value is 0x1272. Provider string `json:"provider,omitempty"` // ForceSendFields is a list of field names (e.g. "Dataset") to @@ -48242,7 +48266,8 @@ type GeostoreOntologyRawGConceptInstanceProto struct { // "PROVIDER_EZVOLT" // "PROVIDER_JOLT" // "PROVIDER_CHARGESMITH" - // "PROVIDER_PLUGO" - Note: Next available value is 0x1271. + // "PROVIDER_PLUGO" + // "PROVIDER_ELECTRIC_ERA" - Note: Next available value is 0x1272. Provider string `json:"provider,omitempty"` SourceDataset string `json:"sourceDataset,omitempty"` @@ -50793,7 +50818,8 @@ type GeostoreProvenanceProto struct { // "PROVIDER_EZVOLT" // "PROVIDER_JOLT" // "PROVIDER_CHARGESMITH" - // "PROVIDER_PLUGO" - Note: Next available value is 0x1271. + // "PROVIDER_PLUGO" + // "PROVIDER_ELECTRIC_ERA" - Note: Next available value is 0x1272. Provider string `json:"provider,omitempty"` // ForceSendFields is a list of field names (e.g. "Dataset") to @@ -86817,6 +86843,7 @@ type KnowledgeAnswersSensitivityMyActivityPolicy struct { // "RETURN_CALL" // "RETURN_MISSED_CALL" // "ROUTINE" + // "ROUTINE_INVOCATION" // "DIAL_INTO_MEETING" // "SHARE_DIGITAL_OBJECT" // "COMPOSE_EMAIL" @@ -112087,7 +112114,8 @@ type QualityActionsReminder struct { // OOBE and use Morris in their next drive. // "MORRIS_OOBE_FROM_GMM_OPT_IN" // "MORRIS_OOBE_FROM_GMM_NOT_NOW" - // "MORRIS_DRIVING_SCREEN_OOBE_NEW_USER" + // "MORRIS_DRIVING_SCREEN_OOBE_NEW_USER" - Driving Screen and Micro + // were both turned down. // "MORRIS_DRIVING_SCREEN_OOBE_ALL_PERMISSIONS" // "MORRIS_DRIVING_SCREEN_OOBE_AR_PERMISSION" // "MORRIS_DRIVING_SCREEN_OOBE_NA_PERMISSION" @@ -126386,11 +126414,6 @@ type RepositoryWebrefMention struct { // NameMetadata: Metadata attached to the name. NameMetadata *RepositoryWebrefConceptNameMetadata `json:"nameMetadata,omitempty"` - // NonLocationalScore: Whether the mention is a non-locational reference - // to a geographical entity. Ranges from 0 (locational) to 1 - // (non-locational). - NonLocationalScore float64 `json:"nonLocationalScore,omitempty"` - // PerMentionLightweightToken: Provides concised access to all matched // MatchedLightweightToken. PerMentionLightweightToken *RepositoryWebrefLightweightTokensPerMentionLightweightToken `json:"perMentionLightweightToken,omitempty"` @@ -126457,7 +126480,6 @@ func (s *RepositoryWebrefMention) UnmarshalJSON(data []byte) error { type NoMethod RepositoryWebrefMention var s1 struct { ConfidenceScore gensupport.JSONFloat64 `json:"confidenceScore"` - NonLocationalScore gensupport.JSONFloat64 `json:"nonLocationalScore"` PriorProbability gensupport.JSONFloat64 `json:"priorProbability"` ReferenceScore gensupport.JSONFloat64 `json:"referenceScore"` ResolutionScore gensupport.JSONFloat64 `json:"resolutionScore"` @@ -126469,7 +126491,6 @@ func (s *RepositoryWebrefMention) UnmarshalJSON(data []byte) error { return err } s.ConfidenceScore = float64(s1.ConfidenceScore) - s.NonLocationalScore = float64(s1.NonLocationalScore) s.PriorProbability = float64(s1.PriorProbability) s.ReferenceScore = float64(s1.ReferenceScore) s.ResolutionScore = float64(s1.ResolutionScore) @@ -127854,31 +127875,19 @@ func (s *RepositoryWebrefPreprocessingUrlMatchingMetadata) MarshalJSON() ([]byte // RepositoryWebrefPreprocessingUrlSourceInfo: Information about where // the url comes from. type RepositoryWebrefPreprocessingUrlSourceInfo struct { - DeprecatedOldSchema *RepositoryWebrefPreprocessingUrlSourceInfoOldSchema `json:"deprecatedOldSchema,omitempty"` - - NewSchema *RepositoryWebrefPreprocessingUrlSourceInfoNewSchema `json:"newSchema,omitempty"` - OriginalUrl string `json:"originalUrl,omitempty"` // Possible values: - // "DEPRECATED_OLD_SCHEMA" + // "SOURCE_UNKNOWN" // "KG" // "KG_TRUSTED" - From kg topic and has trusted provenance (e.g. // ziki-basic, hume-curry). // "WIKIJOIN" // "PRODUCT_OFFER" // "OYSTER_FEATURE" - // "EXTRACTED_REFPAGE" - // "EXPERIMENT" - // "SOURCE_PROTO" - A fake reference page based on a text extracted - // from the source proto. For example, product clusters get such - // refpages based on the descriptions pulled from their source protos - // (catalog offers). // "MINED_REFERENCE_PAGE" - Since cl/142284568 this field represents // also book reference pages. // "WEBREF_YEAR" - Wikipedia URLs for webref year topic. - // "BOOK_REF_PAGES_MINING_PIPELINE" - Pages mined by book reference - // pages mining pipeline. // "LYRICS_REFERENCE_PAGE" - Reference pages for songs mined by // matching content of lyrics pages to the known lyrics of a song. NOTE: // The pipeline that produces these is maintained by the kg-music@. @@ -127892,38 +127901,10 @@ type RepositoryWebrefPreprocessingUrlSourceInfo struct { // "MINED_RELATED_PAGE" // "KG_SOCIAL_PROFILE" - Url to a social profile belonging to the // entity as read from KG. + // "DEEP_LINK" - Extracted from deep link triples (media entities). Source string `json:"source,omitempty"` - // ForceSendFields is a list of field names (e.g. "DeprecatedOldSchema") - // to unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "DeprecatedOldSchema") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefPreprocessingUrlSourceInfo) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingUrlSourceInfo - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// RepositoryWebrefPreprocessingUrlSourceInfoNewSchema: Source -// information for the new reference url Freebase schema. -type RepositoryWebrefPreprocessingUrlSourceInfoNewSchema struct { - SourceProperty string `json:"sourceProperty,omitempty"` - - // ForceSendFields is a list of field names (e.g. "SourceProperty") to + // ForceSendFields is a list of field names (e.g. "OriginalUrl") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -127931,46 +127912,17 @@ type RepositoryWebrefPreprocessingUrlSourceInfoNewSchema struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "SourceProperty") to - // include in API requests with the JSON null value. By default, fields - // with empty values are omitted from API requests. However, any field - // with an empty value appearing in NullFields will be sent to the - // server as null. It is an error if a field in this list has a - // non-empty value. This may be used to include null fields in Patch - // requests. - NullFields []string `json:"-"` -} - -func (s *RepositoryWebrefPreprocessingUrlSourceInfoNewSchema) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingUrlSourceInfoNewSchema - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - -// RepositoryWebrefPreprocessingUrlSourceInfoOldSchema: Source -// information for the old reference url Freebase schema. -type RepositoryWebrefPreprocessingUrlSourceInfoOldSchema struct { - IsOfficial bool `json:"isOfficial,omitempty"` - - // ForceSendFields is a list of field names (e.g. "IsOfficial") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "IsOfficial") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "OriginalUrl") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` } -func (s *RepositoryWebrefPreprocessingUrlSourceInfoOldSchema) MarshalJSON() ([]byte, error) { - type NoMethod RepositoryWebrefPreprocessingUrlSourceInfoOldSchema +func (s *RepositoryWebrefPreprocessingUrlSourceInfo) MarshalJSON() ([]byte, error) { + type NoMethod RepositoryWebrefPreprocessingUrlSourceInfo raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -142992,8 +142944,10 @@ type StorageGraphBfgTripleProvenance struct { // accessing Yeti publisher image data in KG. For now it should be used // ONLY for Yeti. YOU MUST CONTACT stadia-knowledge-eng@ before reading // or writing this data. - // "CONTRACTUAL_BBC_PROVIDER_METADATA" - In order to test BBC metadata - // before serving code populates them to the public + // "CONTRACTUAL_BBC_PROVIDER_METADATA" - This ACL was used to + // evaluating UMP GetMedia API changes for the BBC exclusive provider + // metadata launch. The evaluation was done and we don't cover BBC + // provider metadata with this ACL anymore in production. // "JANATA_USER_GENERATED_DATA" - WARNING! User generated data. DO NOT // use without permission and understanding of usage constraints. This // data is from the Janata feature and contains information that a user @@ -148948,6 +148902,8 @@ type VendingConsumerProtoTrustedGenomeAnnotation struct { // in subscenter. // "SAVE_FOR_LATER_CART_ABANDONMENT_SCREEN_SESSION_LEVEL" - Session // level test code for Save For Later cart abandonment screen. + // "CROSS_FORM_FACTOR_DETAILS_PAGEN_SESSION_LEVEL" - Test codes for + // form factor details page. See go/play-xff-dp-serving. // "SESSION_LEVEL_TEST_CODE_LIMIT" // "CART_ABANDONMENT_USER_LEVEL" - Cart abandonment flow for purchase // flow. @@ -150037,6 +149993,8 @@ type VideoAssetsVenomTransition struct { // other assets have been completed. Drives "is_fully_processed" in // VAPI. Limited to UGC and Reels. Also used to atomically publish all // latency-sensitive transcodes after an edit. + // "OBJECTIVE_PRIMARY_TRANSCODES_DONE" - Subset of + // OBJECTIVE_PRIMARY_ASSETS_DONE including transcode assets only. // "OBJECTIVE_PREVIEW_DONE" - A representation for the video in // advance of all completed assets is ready. // "OBJECTIVE_TRANSMUXED_DONE" - The transmuxed transcode for the @@ -165668,6 +165626,11 @@ type YoutubeCommentsApiCommentRestrictionReason struct { // "MALWARE" - MALWARE includes viruses, worms, trojans, adware and // even potentially unwanted software which may not necessarily be // harmful. + // "MISLEADING" - Policy to cover specific types of misinformation + // that actuates real world harm in ways that are not purely digital. 1) + // Misleading content related to civic and democratic processes, 2) + // Misleading health or medical content, 3) Deceptively manipulated + // media. // "PEDOPHILIA" - Not illegal, but image or text content promoting or // related to young pornography. // "PHISHING" @@ -165851,7 +165814,9 @@ type YoutubeCommentsClusteringMiniStanza struct { // "WEB_INTERNAL_ANALYTICS" - YouTube Internal Analytics // "WEB_PARENT_TOOLS" - YT Parent Tools web app (go/parent-zone-prd). // "WEB_PHONE_VERIFICATION" - YouTube Phone Verification web app - // "WEB_EMBEDDED_PLAYER" - (go/wexit-phone-verify). + // "WEB_SHOPPING_EXTENSION" - (go/wexit-phone-verify). YouTube + // Shopping Extension Client + // "WEB_EMBEDDED_PLAYER" - go/yt-shopping-chrome-extension // "WEB_EFFECT_MAKER" - YouTube Effect Maker web app. // "WEB_UNPLUGGED" - Unplugged web clients. Sign-in, member experience // (Polymer app). diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json index e0876c08acb..e506e999647 100644 --- a/dataproc/v1/dataproc-api.json +++ b/dataproc/v1/dataproc-api.json @@ -3006,7 +3006,7 @@ } } }, - "revision": "20231019", + "revision": "20231028", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3843,6 +3843,10 @@ "gcePdKmsKeyName": { "description": "Optional. The Cloud KMS key name to use for PD disk encryption for all instances in the cluster.", "type": "string" + }, + "kmsKey": { + "description": "Optional. The Cloud KMS key name to use for encrypting customer core content in spanner and cluster PD disk for all instances in the cluster.", + "type": "string" } }, "type": "object" @@ -5113,6 +5117,14 @@ "nextPageToken": { "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent ListJobsRequest.", "type": "string" + }, + "unreachable": { + "description": "Output only. List of jobs that could not be included in the response. Attempting to get one of these resources may indicate why it was not included in the list response.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" } }, "type": "object" diff --git a/dataproc/v1/dataproc-gen.go b/dataproc/v1/dataproc-gen.go index 1c82f007ba4..f3439b0ae2a 100644 --- a/dataproc/v1/dataproc-gen.go +++ b/dataproc/v1/dataproc-gen.go @@ -1627,6 +1627,11 @@ type EncryptionConfig struct { // encryption for all instances in the cluster. GcePdKmsKeyName string `json:"gcePdKmsKeyName,omitempty"` + // KmsKey: Optional. The Cloud KMS key name to use for encrypting + // customer core content in spanner and cluster PD disk for all + // instances in the cluster. + KmsKey string `json:"kmsKey,omitempty"` + // ForceSendFields is a list of field names (e.g. "GcePdKmsKeyName") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -3781,6 +3786,11 @@ type ListJobsResponse struct { // this value as the page_token in a subsequent ListJobsRequest. NextPageToken string `json:"nextPageToken,omitempty"` + // Unreachable: Output only. List of jobs that could not be included in + // the response. Attempting to get one of these resources may indicate + // why it was not included in the list response. + Unreachable []string `json:"unreachable,omitempty"` + // ServerResponse contains the HTTP response code and headers from the // server. googleapi.ServerResponse `json:"-"` diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 8c8127133d9..e34a8b90b04 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -2892,7 +2892,7 @@ } } }, - "revision": "20231016", + "revision": "20231026", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4717,7 +4717,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.", + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1", "type": "object" }, "query": { diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index c1b5cc2d16c..d9871580cf9 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -4011,9 +4011,12 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // Params: Additional search parameters. For public website search only, // supported values are: * `user_country_code`: string. Default empty. // If set to non-empty, results are restricted or boosted based on the - // location provided. * `search_type`: double. Default empty. Enables - // non-webpage searching depending on the value. The only valid - // non-default value is 1, which enables image searching. + // location provided. Example: user_country_code: "au" For available + // codes see Country Codes + // (https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + // * `search_type`: double. Default empty. Enables non-webpage searching + // depending on the value. The only valid non-default value is 1, which + // enables image searching. Example: search_type: 1 Params googleapi.RawMessage `json:"params,omitempty"` // Query: Raw search query. diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index d29caca0dd9..83218c33217 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -2658,7 +2658,7 @@ } } }, - "revision": "20231016", + "revision": "20231026", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4739,7 +4739,7 @@ "additionalProperties": { "type": "any" }, - "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching.", + "description": "Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: \"au\" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1", "type": "object" }, "query": { diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 3ab92b9ed8a..6c8c09ecd85 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -4309,9 +4309,12 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // Params: Additional search parameters. For public website search only, // supported values are: * `user_country_code`: string. Default empty. // If set to non-empty, results are restricted or boosted based on the - // location provided. * `search_type`: double. Default empty. Enables - // non-webpage searching depending on the value. The only valid - // non-default value is 1, which enables image searching. + // location provided. Example: user_country_code: "au" For available + // codes see Country Codes + // (https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) + // * `search_type`: double. Default empty. Enables non-webpage searching + // depending on the value. The only valid non-default value is 1, which + // enables image searching. Example: search_type: 1 Params googleapi.RawMessage `json:"params,omitempty"` // Query: Raw search query. diff --git a/dlp/v2/dlp-api.json b/dlp/v2/dlp-api.json index 6e78f5765e6..7c03707dc62 100644 --- a/dlp/v2/dlp-api.json +++ b/dlp/v2/dlp-api.json @@ -3714,7 +3714,7 @@ } } }, - "revision": "20231022", + "revision": "20231029", "rootUrl": "https://dlp.googleapis.com/", "schemas": { "GooglePrivacyDlpV2Action": { @@ -4530,7 +4530,7 @@ "type": "string" }, "otherMatches": { - "description": "Other types found within this column. List will be un-ordered.", + "description": "Other types found within this column. List will be unordered.", "items": { "$ref": "GooglePrivacyDlpV2OtherInfoTypeSummary" }, @@ -4576,7 +4576,7 @@ "type": "string" }, "tableDataProfile": { - "description": "The resource name to the table data profile.", + "description": "The resource name of the table data profile.", "type": "string" }, "tableFullResource": { @@ -4999,7 +4999,7 @@ }, "sensitivityScore": { "$ref": "GooglePrivacyDlpV2SensitivityScore", - "description": "Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedent over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling." + "description": "Sensitivity for this CustomInfoType. If this CustomInfoType extends an existing InfoType, the sensitivity here will take precedence over that of the original InfoType. If unset for a CustomInfoType, it will default to HIGH. This only applies to data profiling." }, "storedType": { "$ref": "GooglePrivacyDlpV2StoredType", @@ -5028,7 +5028,7 @@ "type": "object" }, "GooglePrivacyDlpV2DataProfileBigQueryRowSchema": { - "description": "The schema of data to be saved to the BigQuery when the `DataProfileAction` is enabled.", + "description": "The schema of data to be saved to the BigQuery table when the `DataProfileAction` is enabled.", "id": "GooglePrivacyDlpV2DataProfileBigQueryRowSchema", "properties": { "columnProfile": { @@ -6826,7 +6826,7 @@ "type": "boolean" }, "infoTypes": { - "description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose what detectors to run. By default this may be all types, but may change over time as detectors are updated. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.", + "description": "Restricts what info_types to look for. The values must correspond to InfoType values returned by ListInfoTypes or listed at https://cloud.google.com/dlp/docs/infotypes-reference. When no InfoTypes or CustomInfoTypes are specified in a request, the system may automatically choose a default list of detectors to run, which may change over time. If you need precise control and predictability as to what detectors are run you should specify specific InfoTypes listed in the reference, otherwise a default list will be used, which may change over time.", "items": { "$ref": "GooglePrivacyDlpV2InfoType" }, @@ -7534,7 +7534,7 @@ "type": "array" }, "nextPageToken": { - "description": "If the next page is available then the next page token to be used in the following ListDiscoveryConfigs request.", + "description": "If the next page is available then this value is the next page token to be used in the following ListDiscoveryConfigs request.", "type": "string" } }, @@ -7602,7 +7602,7 @@ "type": "array" }, "nextPageToken": { - "description": "If the next page is available then the next page token to be used in the following ListJobTriggers request.", + "description": "If the next page is available then this value is the next page token to be used in the following ListJobTriggers request.", "type": "string" } }, @@ -8421,7 +8421,7 @@ "type": "object" }, "GooglePrivacyDlpV2RequestedDeidentifyOptions": { - "description": "De-id options.", + "description": "De-identification options.", "id": "GooglePrivacyDlpV2RequestedDeidentifyOptions", "properties": { "snapshotDeidentifyTemplate": { diff --git a/dlp/v2/dlp-gen.go b/dlp/v2/dlp-gen.go index 6bbf2c9b4ce..6e18eccd598 100644 --- a/dlp/v2/dlp-gen.go +++ b/dlp/v2/dlp-gen.go @@ -1843,7 +1843,7 @@ type GooglePrivacyDlpV2ColumnDataProfile struct { Name string `json:"name,omitempty"` // OtherMatches: Other types found within this column. List will be - // un-ordered. + // unordered. OtherMatches []*GooglePrivacyDlpV2OtherInfoTypeSummary `json:"otherMatches,omitempty"` // PolicyState: Indicates if a policy tag has been applied to the @@ -1876,7 +1876,7 @@ type GooglePrivacyDlpV2ColumnDataProfile struct { // failed. State string `json:"state,omitempty"` - // TableDataProfile: The resource name to the table data profile. + // TableDataProfile: The resource name of the table data profile. TableDataProfile string `json:"tableDataProfile,omitempty"` // TableFullResource: The resource name of the table this column is @@ -2704,7 +2704,7 @@ type GooglePrivacyDlpV2CustomInfoType struct { // SensitivityScore: Sensitivity for this CustomInfoType. If this // CustomInfoType extends an existing InfoType, the sensitivity here - // will take precedent over that of the original InfoType. If unset for + // will take precedence over that of the original InfoType. If unset for // a CustomInfoType, it will default to HIGH. This only applies to data // profiling. SensitivityScore *GooglePrivacyDlpV2SensitivityScore `json:"sensitivityScore,omitempty"` @@ -2774,7 +2774,8 @@ func (s *GooglePrivacyDlpV2DataProfileAction) MarshalJSON() ([]byte, error) { } // GooglePrivacyDlpV2DataProfileBigQueryRowSchema: The schema of data to -// be saved to the BigQuery when the `DataProfileAction` is enabled. +// be saved to the BigQuery table when the `DataProfileAction` is +// enabled. type GooglePrivacyDlpV2DataProfileBigQueryRowSchema struct { // ColumnProfile: Column data profile column ColumnProfile *GooglePrivacyDlpV2ColumnDataProfile `json:"columnProfile,omitempty"` @@ -5879,11 +5880,11 @@ type GooglePrivacyDlpV2InspectConfig struct { // correspond to InfoType values returned by ListInfoTypes or listed at // https://cloud.google.com/dlp/docs/infotypes-reference. When no // InfoTypes or CustomInfoTypes are specified in a request, the system - // may automatically choose what detectors to run. By default this may - // be all types, but may change over time as detectors are updated. If - // you need precise control and predictability as to what detectors are - // run you should specify specific InfoTypes listed in the reference, - // otherwise a default list will be used, which may change over time. + // may automatically choose a default list of detectors to run, which + // may change over time. If you need precise control and predictability + // as to what detectors are run you should specify specific InfoTypes + // listed in the reference, otherwise a default list will be used, which + // may change over time. InfoTypes []*GooglePrivacyDlpV2InfoType `json:"infoTypes,omitempty"` // Limits: Configuration to control the number of findings returned. @@ -7114,8 +7115,9 @@ type GooglePrivacyDlpV2ListDiscoveryConfigsResponse struct { // ListDiscoveryConfigsRequest. DiscoveryConfigs []*GooglePrivacyDlpV2DiscoveryConfig `json:"discoveryConfigs,omitempty"` - // NextPageToken: If the next page is available then the next page token - // to be used in the following ListDiscoveryConfigs request. + // NextPageToken: If the next page is available then this value is the + // next page token to be used in the following ListDiscoveryConfigs + // request. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -7262,8 +7264,8 @@ type GooglePrivacyDlpV2ListJobTriggersResponse struct { // ListJobTriggersRequest. JobTriggers []*GooglePrivacyDlpV2JobTrigger `json:"jobTriggers,omitempty"` - // NextPageToken: If the next page is available then the next page token - // to be used in the following ListJobTriggers request. + // NextPageToken: If the next page is available then this value is the + // next page token to be used in the following ListJobTriggers request. NextPageToken string `json:"nextPageToken,omitempty"` // ServerResponse contains the HTTP response code and headers from the @@ -8795,7 +8797,8 @@ func (s *GooglePrivacyDlpV2ReplaceValueConfig) MarshalJSON() ([]byte, error) { type GooglePrivacyDlpV2ReplaceWithInfoTypeConfig struct { } -// GooglePrivacyDlpV2RequestedDeidentifyOptions: De-id options. +// GooglePrivacyDlpV2RequestedDeidentifyOptions: De-identification +// options. type GooglePrivacyDlpV2RequestedDeidentifyOptions struct { // SnapshotDeidentifyTemplate: Snapshot of the state of the // `DeidentifyTemplate` from the Deidentify action at the time this job diff --git a/healthcare/v1/healthcare-api.json b/healthcare/v1/healthcare-api.json index 5660cf7af41..4aac6dc1983 100644 --- a/healthcare/v1/healthcare-api.json +++ b/healthcare/v1/healthcare-api.json @@ -1922,7 +1922,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -1956,7 +1956,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -1990,7 +1990,7 @@ ] }, "searchForStudies": { - "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2053,7 +2053,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2189,7 +2189,7 @@ "studies": { "methods": { "delete": { - "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -2222,7 +2222,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2256,7 +2256,7 @@ ] }, "retrieveStudy": { - "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2290,7 +2290,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2324,7 +2324,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2358,7 +2358,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2399,7 +2399,7 @@ "series": { "methods": { "delete": { - "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -2433,7 +2433,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2467,7 +2467,7 @@ ] }, "retrieveSeries": { - "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -2501,7 +2501,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -2539,7 +2539,7 @@ "instances": { "methods": { "delete": { - "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", @@ -2573,7 +2573,7 @@ ] }, "retrieveInstance": { - "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance).", + "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -2607,7 +2607,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -2641,7 +2641,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -2679,7 +2679,7 @@ "frames": { "methods": { "retrieveFrames": { - "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -2713,7 +2713,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -3823,7 +3823,7 @@ ] }, "getHL7v2StoreMetrics": { - "description": "Gets metrics asssociated with the HL7v2 store.", + "description": "Gets metrics associated with the HL7v2 store.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", @@ -4431,7 +4431,7 @@ } } }, - "revision": "20231017", + "revision": "20231103", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "ActivateConsentRequest": { diff --git a/healthcare/v1/healthcare-gen.go b/healthcare/v1/healthcare-gen.go index 47749d1a6c3..d8606d33f51 100644 --- a/healthcare/v1/healthcare-gen.go +++ b/healthcare/v1/healthcare-gen.go @@ -15917,9 +15917,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -16002,7 +16001,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Do(opts ... gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -16057,9 +16056,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForSeries, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForSeries, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForSeries DICOMweb request. For // example, `series` or `studies/{study_uid}/series`. @@ -16141,7 +16139,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Do(opts ...goo gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -16196,9 +16194,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForStudies, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForStudies, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForStudies DICOMweb request. // For example, `studies`. @@ -16280,7 +16277,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Do(opts ...go gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForStudies returns a list of matching studies. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -16483,8 +16480,8 @@ type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call StoreInstances, see Storing DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). +// how to call StoreInstances, see Store DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). // // - dicomWebPath: The path of the StoreInstances DICOMweb request. For // example, `studies/[{study_uid}]`. Note that the `study_uid` is @@ -16554,7 +16551,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Do(opts ...goog gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -17060,8 +17057,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall struct { // marked successful when the deletion is complete. Warning: Instances // cannot be inserted into a study that is being deleted by an operation // until the operation completes. For samples that show how to call -// DeleteStudy, see Deleting a study, series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// DeleteStudy, see Delete a study, series, or instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteStudy request. For example, // `studies/{study_uid}`. @@ -17160,7 +17157,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Do(opts ...googl } return ret, nil // { - // "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteStudy deletes all instances within the given study. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -17215,8 +17212,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct { // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveStudyMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveStudyMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveStudyMetadata DICOMweb // request. For example, `studies/{study_uid}/metadata`. @@ -17298,7 +17295,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Do(opt gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -17353,8 +17350,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct { // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveStudy, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// show how to call RetrieveStudy, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveStudy DICOMweb request. For // example, `studies/{study_uid}`. @@ -17436,7 +17433,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Do(opts . gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -17491,9 +17488,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -17576,7 +17572,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Do(o gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -17631,9 +17627,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForSeries, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForSeries, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForSeries DICOMweb request. For // example, `series` or `studies/{study_uid}/series`. @@ -17715,7 +17710,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Do(opts gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForSeries returns a list of matching series. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -17770,8 +17765,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call StoreInstances, see Storing DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). +// how to call StoreInstances, see Store DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). // // - dicomWebPath: The path of the StoreInstances DICOMweb request. For // example, `studies/[{study_uid}]`. Note that the `study_uid` is @@ -17841,7 +17836,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Do(opts gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -17897,8 +17892,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall struct { // will be marked successful when the deletion is complete. Warning: // Instances cannot be inserted into a series that is being deleted by // an operation until the operation completes. For samples that show how -// to call DeleteSeries, see Deleting a study, series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// to call DeleteSeries, see Delete a study, series, or instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteSeries request. For example, // `studies/{study_uid}/series/{series_uid}`. @@ -18000,7 +17995,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Do(opts .. } return ret, nil // { - // "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteSeries deletes all instances within the given study and series. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -18056,8 +18051,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struc // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveSeriesMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveSeriesMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveSeriesMetadata DICOMweb // request. For example, @@ -18140,7 +18135,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -18195,8 +18190,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveSeries, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// show how to call RetrieveSeries, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveSeries DICOMweb request. For // example, `studies/{study_uid}/series/{series_uid}`. @@ -18278,7 +18273,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Do gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -18333,9 +18328,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall str // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -18418,7 +18412,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [Search Transaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.6). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -18470,8 +18464,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall struct // to the GET requests specified in the Retrieve transaction. Study and // series search results can take a few seconds to be updated after an // instance is deleted using DeleteInstance. For samples that show how -// to call DeleteInstance, see Deleting a study, series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// to call DeleteInstance, see Delete a study, series, or instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteInstance request. For example, // `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. @@ -18573,7 +18567,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) D } return ret, nil // { - // "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", @@ -18631,8 +18625,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceC // and DICOM instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call RetrieveInstance, see Retrieving an instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance). +// how to call RetrieveInstance, see Retrieve an instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance). // // - dicomWebPath: The path of the RetrieveInstance DICOMweb request. // For example, @@ -18715,7 +18709,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInsta gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance).", + // "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -18772,8 +18766,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataC // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveInstanceMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveInstanceMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveInstanceMetadata DICOMweb // request. For example, @@ -18857,7 +18851,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetad gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -18913,9 +18907,9 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedC // Rendered resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveRenderedInstance, see Retrieving consumer +// show how to call RetrieveRenderedInstance, see Retrieve consumer // image formats -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). // // - dicomWebPath: The path of the RetrieveRenderedInstance DICOMweb // request. For example, @@ -18999,7 +18993,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRende gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + // "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -19054,8 +19048,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFra // For details on the implementation of RetrieveFrames, see DICOM frames // (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the // Cloud Healthcare API conformance statement. For samples that show how -// to call RetrieveFrames, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// to call RetrieveFrames, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveFrames DICOMweb request. For // example, @@ -19139,7 +19133,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetriev gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4}. For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -19195,9 +19189,9 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRen // Rendered resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveRenderedFrames, see Retrieving consumer -// image formats -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). +// show how to call RetrieveRenderedFrames, see Retrieve consumer image +// formats +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). // // - dicomWebPath: The path of the RetrieveRenderedFrames DICOMweb // request. For example, @@ -19281,7 +19275,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetriev gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + // "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction] (http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -24476,7 +24470,7 @@ type ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall struct { header_ http.Header } -// GetHL7v2StoreMetrics: Gets metrics asssociated with the HL7v2 store. +// GetHL7v2StoreMetrics: Gets metrics associated with the HL7v2 store. // // - name: The resource name of the HL7v2 store to get metrics for, in // the format @@ -24587,7 +24581,7 @@ func (c *ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Do(opts . } return ret, nil // { - // "description": "Gets metrics asssociated with the HL7v2 store.", + // "description": "Gets metrics associated with the HL7v2 store.", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", diff --git a/healthcare/v1beta1/healthcare-api.json b/healthcare/v1beta1/healthcare-api.json index 944af865e5a..925675b767a 100644 --- a/healthcare/v1beta1/healthcare-api.json +++ b/healthcare/v1beta1/healthcare-api.json @@ -2445,7 +2445,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -2479,7 +2479,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -2513,7 +2513,7 @@ ] }, "searchForStudies": { - "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -2546,6 +2546,35 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, + "setBlobStorageSettings": { + "description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setBlobStorageSettings", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setBlobStorageSettings", + "request": { + "$ref": "SetBlobStorageSettingsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setIamPolicy", @@ -2576,7 +2605,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -2672,6 +2701,35 @@ "https://www.googleapis.com/auth/cloud-healthcare", "https://www.googleapis.com/auth/cloud-platform" ] + }, + "setBlobStorageSettings": { + "description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:setBlobStorageSettings", + "httpMethod": "POST", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/.*$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:setBlobStorageSettings", + "request": { + "$ref": "SetBlobStorageSettingsRequest" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] } }, "resources": { @@ -2703,6 +2761,38 @@ "https://www.googleapis.com/auth/cloud-platform" ] } + }, + "resources": { + "instances": { + "methods": { + "getStorageInfo": { + "description": "GetStorageInfo returns the storage info of the specified resource.", + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}:getStorageInfo", + "httpMethod": "GET", + "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo", + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`)", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+/instances/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1beta1/{+resource}:getStorageInfo", + "response": { + "$ref": "StorageInfo" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-healthcare", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } } } } @@ -2712,7 +2802,7 @@ "studies": { "methods": { "delete": { - "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -2745,7 +2835,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -2779,7 +2869,7 @@ ] }, "retrieveStudy": { - "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -2813,7 +2903,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -2847,7 +2937,7 @@ ] }, "searchForSeries": { - "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -2881,7 +2971,7 @@ ] }, "storeInstances": { - "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", "httpMethod": "POST", "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -2922,7 +3012,7 @@ "series": { "methods": { "delete": { - "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -2956,7 +3046,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -2990,7 +3080,7 @@ ] }, "retrieveSeries": { - "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -3024,7 +3114,7 @@ ] }, "searchForInstances": { - "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -3062,7 +3152,7 @@ "instances": { "methods": { "delete": { - "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "DELETE", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", @@ -3096,7 +3186,7 @@ ] }, "retrieveInstance": { - "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance).", + "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -3130,7 +3220,7 @@ ] }, "retrieveMetadata": { - "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -3164,7 +3254,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -3202,7 +3292,7 @@ "frames": { "methods": { "retrieveFrames": { - "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -3236,7 +3326,7 @@ ] }, "retrieveRendered": { - "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -4700,7 +4790,7 @@ ] }, "getHL7v2StoreMetrics": { - "description": "Gets metrics asssociated with the HL7v2 store.", + "description": "Gets metrics associated with the HL7v2 store.", "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", "httpMethod": "GET", "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", @@ -5361,7 +5451,7 @@ } } }, - "revision": "20231017", + "revision": "20231103", "rootUrl": "https://healthcare.googleapis.com/", "schemas": { "AccessDeterminationLogConfig": { @@ -5862,6 +5952,66 @@ }, "type": "object" }, + "BlobStorageInfo": { + "description": "BlobStorageInfo contains details about the data stored in Blob Storage for the referenced resource. Note: Storage class is only valid for DICOM and hence will only be populated for DICOM resources.", + "id": "BlobStorageInfo", + "properties": { + "sizeBytes": { + "description": "Size in bytes of data stored in Blob Storage.", + "format": "int64", + "type": "string" + }, + "storageClass": { + "description": "The storage class in which the Blob data is stored.", + "enum": [ + "BLOB_STORAGE_CLASS_UNSPECIFIED", + "STANDARD", + "NEARLINE", + "COLDLINE", + "ARCHIVE" + ], + "enumDescriptions": [ + "If unspecified in CreateDataset, the StorageClass defaults to STANDARD. If unspecified in UpdateDataset and the StorageClass is set in the field mask, an InvalidRequest error is thrown.", + "This stores the Object in Blob Standard Storage: https://cloud.google.com/storage/docs/storage-classes#standard", + "This stores the Object in Blob Nearline Storage: https://cloud.google.com/storage/docs/storage-classes#nearline", + "This stores the Object in Blob Coldline Storage: https://cloud.google.com/storage/docs/storage-classes#coldline", + "This stores the Object in Blob Archive Storage: https://cloud.google.com/storage/docs/storage-classes#archive" + ], + "type": "string" + }, + "storageClassUpdateTime": { + "description": "The time at which the storage class was updated. This is used to compute early deletion fees of the resource.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, + "BlobStorageSettings": { + "description": "Settings for data stored in Blob storage.", + "id": "BlobStorageSettings", + "properties": { + "blobStorageClass": { + "description": "The Storage class in which the Blob data is stored.", + "enum": [ + "BLOB_STORAGE_CLASS_UNSPECIFIED", + "STANDARD", + "NEARLINE", + "COLDLINE", + "ARCHIVE" + ], + "enumDescriptions": [ + "If unspecified in CreateDataset, the StorageClass defaults to STANDARD. If unspecified in UpdateDataset and the StorageClass is set in the field mask, an InvalidRequest error is thrown.", + "This stores the Object in Blob Standard Storage: https://cloud.google.com/storage/docs/storage-classes#standard", + "This stores the Object in Blob Nearline Storage: https://cloud.google.com/storage/docs/storage-classes#nearline", + "This stores the Object in Blob Coldline Storage: https://cloud.google.com/storage/docs/storage-classes#coldline", + "This stores the Object in Blob Archive Storage: https://cloud.google.com/storage/docs/storage-classes#archive" + ], + "type": "string" + } + }, + "type": "object" + }, "BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", "id": "BoundingPoly", @@ -7941,6 +8091,10 @@ "description": "Imports data into the specified DICOM store. Returns an error if any of the files to import are not DICOM files. This API accepts duplicate DICOM instances by ignoring the newly-pushed instance. It does not overwrite.", "id": "ImportDicomDataRequest", "properties": { + "blobStorageSettings": { + "$ref": "BlobStorageSettings", + "description": "Optional. The blob storage settings for the data imported by this operation." + }, "gcsSource": { "$ref": "GoogleCloudHealthcareV1beta1DicomGcsSource", "description": "Cloud Storage source data location and import configuration. The Cloud Healthcare Service Agent requires the `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage location." @@ -8897,7 +9051,7 @@ "id": "RollbackFhirResourceFilteringFields", "properties": { "metadataFilter": { - "description": "Optional. A string to use for filtering resource metadata. Complies with AIP-160 except without the has operator. Additionally, supports 2 functions: hastag(\"system\") = \"code\" for tag filtering and extension_ts_value(\"uri\") = timestamp for filtering extensions with timestamp, which is given as a unix timestamp. extension_ts_url can be used with \u003e, \u003c, \u003c=, \u003e=, != comparisons as well.", + "description": "Optional. A filter expression that matches data in the `Resource.meta` element. Supports all filters in [AIP-160](https://google.aip.dev/160) except the \"has\" (`:`) operator. Supports the following custom functions: * `tag(\"\") = \"\"` for tag filtering. * `extension_value_ts(\"\") = ` for filtering extensions with a timestamp, where `` is a Unix timestamp. Supports the `\u003e`, `\u003c`, `\u003c=`, `\u003e=`, and `!=` comparison operators.", "type": "string" }, "operationIds": { @@ -9236,6 +9390,27 @@ }, "type": "object" }, + "SetBlobStorageSettingsRequest": { + "description": "Request message for `SetBlobStorageSettings` method.", + "id": "SetBlobStorageSettingsRequest", + "properties": { + "blobStorageSettings": { + "$ref": "BlobStorageSettings", + "description": "The blob storage settings to update for the specified resources. Only fields listed in `update_mask` are applied." + }, + "filterConfig": { + "$ref": "DicomFilterConfig", + "description": "Optional. A filter configuration. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`." + } + }, + "type": "object" + }, + "SetBlobStorageSettingsResponse": { + "description": "Returns additional info in regards to a completed set blob storage settings API.", + "id": "SetBlobStorageSettingsResponse", + "properties": {}, + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "id": "SetIamPolicyRequest", @@ -9306,6 +9481,25 @@ }, "type": "object" }, + "StorageInfo": { + "description": "StorageInfo encapsulates all the storage info of a resource.", + "id": "StorageInfo", + "properties": { + "blobStorageInfo": { + "$ref": "BlobStorageInfo", + "description": "Info about the data stored in blob storage for the resource." + }, + "referencedResource": { + "description": "The resource whose storage info is returned. For example, to specify the resource path of a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicom_store_id}/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_uid}`", + "type": "string" + }, + "structuredStorageInfo": { + "$ref": "StructuredStorageInfo", + "description": "Info about the data stored in structured storage for the resource." + } + }, + "type": "object" + }, "StreamConfig": { "description": "Contains configuration for streaming FHIR export.", "id": "StreamConfig", @@ -9328,6 +9522,18 @@ }, "type": "object" }, + "StructuredStorageInfo": { + "description": "StructuredStorageInfo contains details about the data stored in Structured Storage for the referenced resource.", + "id": "StructuredStorageInfo", + "properties": { + "sizeBytes": { + "description": "Size in bytes of data stored in structured storage.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "StudyMetrics": { "description": "StudyMetrics contains metrics describing a DICOM study.", "id": "StudyMetrics", diff --git a/healthcare/v1beta1/healthcare-gen.go b/healthcare/v1beta1/healthcare-gen.go index baebac18c5d..093c5a77174 100644 --- a/healthcare/v1beta1/healthcare-gen.go +++ b/healthcare/v1beta1/healthcare-gen.go @@ -333,11 +333,23 @@ type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService struct { func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService(s *Service) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService { rs := &ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService{s: s} + rs.Instances = NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService(s) return rs } type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesService struct { s *Service + + Instances *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService +} + +func NewProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService(s *Service) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService { + rs := &ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService{s: s} + return rs +} + +type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService struct { + s *Service } func NewProjectsLocationsDatasetsDicomStoresStudiesService(s *Service) *ProjectsLocationsDatasetsDicomStoresStudiesService { @@ -1463,6 +1475,101 @@ func (s *Binding) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// BlobStorageInfo: BlobStorageInfo contains details about the data +// stored in Blob Storage for the referenced resource. Note: Storage +// class is only valid for DICOM and hence will only be populated for +// DICOM resources. +type BlobStorageInfo struct { + // SizeBytes: Size in bytes of data stored in Blob Storage. + SizeBytes int64 `json:"sizeBytes,omitempty,string"` + + // StorageClass: The storage class in which the Blob data is stored. + // + // Possible values: + // "BLOB_STORAGE_CLASS_UNSPECIFIED" - If unspecified in CreateDataset, + // the StorageClass defaults to STANDARD. If unspecified in + // UpdateDataset and the StorageClass is set in the field mask, an + // InvalidRequest error is thrown. + // "STANDARD" - This stores the Object in Blob Standard Storage: + // https://cloud.google.com/storage/docs/storage-classes#standard + // "NEARLINE" - This stores the Object in Blob Nearline Storage: + // https://cloud.google.com/storage/docs/storage-classes#nearline + // "COLDLINE" - This stores the Object in Blob Coldline Storage: + // https://cloud.google.com/storage/docs/storage-classes#coldline + // "ARCHIVE" - This stores the Object in Blob Archive Storage: + // https://cloud.google.com/storage/docs/storage-classes#archive + StorageClass string `json:"storageClass,omitempty"` + + // StorageClassUpdateTime: The time at which the storage class was + // updated. This is used to compute early deletion fees of the resource. + StorageClassUpdateTime string `json:"storageClassUpdateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "SizeBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SizeBytes") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *BlobStorageInfo) MarshalJSON() ([]byte, error) { + type NoMethod BlobStorageInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// BlobStorageSettings: Settings for data stored in Blob storage. +type BlobStorageSettings struct { + // BlobStorageClass: The Storage class in which the Blob data is stored. + // + // Possible values: + // "BLOB_STORAGE_CLASS_UNSPECIFIED" - If unspecified in CreateDataset, + // the StorageClass defaults to STANDARD. If unspecified in + // UpdateDataset and the StorageClass is set in the field mask, an + // InvalidRequest error is thrown. + // "STANDARD" - This stores the Object in Blob Standard Storage: + // https://cloud.google.com/storage/docs/storage-classes#standard + // "NEARLINE" - This stores the Object in Blob Nearline Storage: + // https://cloud.google.com/storage/docs/storage-classes#nearline + // "COLDLINE" - This stores the Object in Blob Coldline Storage: + // https://cloud.google.com/storage/docs/storage-classes#coldline + // "ARCHIVE" - This stores the Object in Blob Archive Storage: + // https://cloud.google.com/storage/docs/storage-classes#archive + BlobStorageClass string `json:"blobStorageClass,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlobStorageClass") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlobStorageClass") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *BlobStorageSettings) MarshalJSON() ([]byte, error) { + type NoMethod BlobStorageSettings + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // BoundingPoly: A bounding polygon for the detected image annotation. type BoundingPoly struct { // Label: A description of this polygon. @@ -5609,26 +5716,31 @@ type ImportAnnotationsResponse struct { // This API accepts duplicate DICOM instances by ignoring the // newly-pushed instance. It does not overwrite. type ImportDicomDataRequest struct { + // BlobStorageSettings: Optional. The blob storage settings for the data + // imported by this operation. + BlobStorageSettings *BlobStorageSettings `json:"blobStorageSettings,omitempty"` + // GcsSource: Cloud Storage source data location and import // configuration. The Cloud Healthcare Service Agent requires the // `roles/storage.objectViewer` Cloud IAM roles on the Cloud Storage // location. GcsSource *GoogleCloudHealthcareV1beta1DicomGcsSource `json:"gcsSource,omitempty"` - // ForceSendFields is a list of field names (e.g. "GcsSource") to - // unconditionally include in API requests. By default, fields with + // ForceSendFields is a list of field names (e.g. "BlobStorageSettings") + // to unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be // sent to the server regardless of whether the field is empty or not. // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "GcsSource") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. + // NullFields is a list of field names (e.g. "BlobStorageSettings") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. NullFields []string `json:"-"` } @@ -7510,13 +7622,13 @@ func (s *RevokeConsentRequest) MarshalJSON() ([]byte, error) { // RollbackFhirResourceFilteringFields: Filters to select resources that // need to be rolled back. type RollbackFhirResourceFilteringFields struct { - // MetadataFilter: Optional. A string to use for filtering resource - // metadata. Complies with AIP-160 except without the has operator. - // Additionally, supports 2 functions: hastag("system") = "code" for tag - // filtering and extension_ts_value("uri") = timestamp for filtering - // extensions with timestamp, which is given as a unix timestamp. - // extension_ts_url can be used with >, <, <=, >=, != comparisons as - // well. + // MetadataFilter: Optional. A filter expression that matches data in + // the `Resource.meta` element. Supports all filters in AIP-160 + // (https://google.aip.dev/160) except the "has" (`:`) operator. + // Supports the following custom functions: * `tag("") = "" for tag + // filtering. * `extension_value_ts("") = ` for filtering extensions + // with a timestamp, where `` is a Unix timestamp. Supports the `>`, + // `<`, `<=`, `>=`, and `!=` comparison operators. MetadataFilter string `json:"metadataFilter,omitempty"` // OperationIds: Optional. A list of operation IDs to roll back. Only @@ -8117,6 +8229,49 @@ func (s *SeriesMetrics) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// SetBlobStorageSettingsRequest: Request message for +// `SetBlobStorageSettings` method. +type SetBlobStorageSettingsRequest struct { + // BlobStorageSettings: The blob storage settings to update for the + // specified resources. Only fields listed in `update_mask` are applied. + BlobStorageSettings *BlobStorageSettings `json:"blobStorageSettings,omitempty"` + + // FilterConfig: Optional. A filter configuration. If `filter_config` is + // specified, set the value of `resource` to the resource name of a + // DICOM store in the format + // `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}` + // . + FilterConfig *DicomFilterConfig `json:"filterConfig,omitempty"` + + // ForceSendFields is a list of field names (e.g. "BlobStorageSettings") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlobStorageSettings") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *SetBlobStorageSettingsRequest) MarshalJSON() ([]byte, error) { + type NoMethod SetBlobStorageSettingsRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// SetBlobStorageSettingsResponse: Returns additional info in regards to +// a completed set blob storage settings API. +type SetBlobStorageSettingsResponse struct { +} + // SetIamPolicyRequest: Request message for `SetIamPolicy` method. type SetIamPolicyRequest struct { // Policy: REQUIRED: The complete policy to be applied to the @@ -8236,6 +8391,52 @@ func (s *Status) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StorageInfo: StorageInfo encapsulates all the storage info of a +// resource. +type StorageInfo struct { + // BlobStorageInfo: Info about the data stored in blob storage for the + // resource. + BlobStorageInfo *BlobStorageInfo `json:"blobStorageInfo,omitempty"` + + // ReferencedResource: The resource whose storage info is returned. For + // example, to specify the resource path of a DICOM Instance: + // `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicom_store_id + // }/dicomWeb/studi/{study_uid}/series/{series_uid}/instances/{instance_u + // id}` + ReferencedResource string `json:"referencedResource,omitempty"` + + // StructuredStorageInfo: Info about the data stored in structured + // storage for the resource. + StructuredStorageInfo *StructuredStorageInfo `json:"structuredStorageInfo,omitempty"` + + // ServerResponse contains the HTTP response code and headers from the + // server. + googleapi.ServerResponse `json:"-"` + + // ForceSendFields is a list of field names (e.g. "BlobStorageInfo") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "BlobStorageInfo") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *StorageInfo) MarshalJSON() ([]byte, error) { + type NoMethod StorageInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // StreamConfig: Contains configuration for streaming FHIR export. type StreamConfig struct { // BigqueryDestination: The destination BigQuery structure that contains @@ -8323,6 +8524,35 @@ func (s *StreamConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// StructuredStorageInfo: StructuredStorageInfo contains details about +// the data stored in Structured Storage for the referenced resource. +type StructuredStorageInfo struct { + // SizeBytes: Size in bytes of data stored in structured storage. + SizeBytes int64 `json:"sizeBytes,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "SizeBytes") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "SizeBytes") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *StructuredStorageInfo) MarshalJSON() ([]byte, error) { + type NoMethod StructuredStorageInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // StudyMetrics: StudyMetrics contains metrics describing a DICOM study. type StudyMetrics struct { // BlobStorageSizeBytes: Total blob storage bytes for all instances in @@ -20824,9 +21054,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -20909,7 +21138,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForInstancesCall) Do(opts ... gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForInstances", @@ -20964,9 +21193,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForSeries, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForSeries, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForSeries DICOMweb request. For // example, `series` or `studies/{study_uid}/series`. @@ -21048,7 +21276,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForSeriesCall) Do(opts ...goo gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/series", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForSeries", @@ -21103,9 +21331,8 @@ type ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForStudies, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForStudies, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForStudies DICOMweb request. // For example, `studies`. @@ -21187,7 +21414,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Do(opts ...go gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForStudies returns a list of matching studies. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForStudies, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForStudies, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.searchForStudies", @@ -21223,6 +21450,161 @@ func (c *ProjectsLocationsDatasetsDicomStoresSearchForStudiesCall) Do(opts ...go } +// method id "healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings": + +type ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall struct { + s *Service + resource string + setblobstoragesettingsrequest *SetBlobStorageSettingsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetBlobStorageSettings: SetBlobStorageSettings sets the blob storage +// settings of the specified resources. +// +// - resource: The path of the resource to update the blob storage +// settings in the format of +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}`, +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instance +// UID}`. If `filter_config` is specified, set the value of `resource` +// to the resource name of a DICOM store in the format +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }`. +func (r *ProjectsLocationsDatasetsDicomStoresService) SetBlobStorageSettings(resource string, setblobstoragesettingsrequest *SetBlobStorageSettingsRequest) *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall { + c := &ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.setblobstoragesettingsrequest = setblobstoragesettingsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall) Fields(s ...googleapi.Field) *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall) Context(ctx context.Context) *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.setblobstoragesettingsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+resource}:setBlobStorageSettings") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsDatasetsDicomStoresSetBlobStorageSettingsCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}:setBlobStorageSettings", + // "httpMethod": "POST", + // "id": "healthcare.projects.locations.datasets.dicomStores.setBlobStorageSettings", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+resource}:setBlobStorageSettings", + // "request": { + // "$ref": "SetBlobStorageSettingsRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-healthcare", + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "healthcare.projects.locations.datasets.dicomStores.setIamPolicy": type ProjectsLocationsDatasetsDicomStoresSetIamPolicyCall struct { @@ -21390,8 +21772,8 @@ type ProjectsLocationsDatasetsDicomStoresStoreInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call StoreInstances, see Storing DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). +// how to call StoreInstances, see Store DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). // // - dicomWebPath: The path of the StoreInstances DICOMweb request. For // example, `studies/[{study_uid}]`. Note that the `study_uid` is @@ -21461,7 +21843,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStoreInstancesCall) Do(opts ...goog gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.dicomStores.storeInstances", @@ -21800,6 +22182,161 @@ func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesGetStudyMetricsCall) } +// method id "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings": + +type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall struct { + s *Service + resource string + setblobstoragesettingsrequest *SetBlobStorageSettingsRequest + urlParams_ gensupport.URLParams + ctx_ context.Context + header_ http.Header +} + +// SetBlobStorageSettings: SetBlobStorageSettings sets the blob storage +// settings of the specified resources. +// +// - resource: The path of the resource to update the blob storage +// settings in the format of +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}`, +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instance +// UID}`. If `filter_config` is specified, set the value of `resource` +// to the resource name of a DICOM store in the format +// `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID +// }`. +func (r *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesService) SetBlobStorageSettings(resource string, setblobstoragesettingsrequest *SetBlobStorageSettingsRequest) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall { + c := &ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + c.setblobstoragesettingsrequest = setblobstoragesettingsrequest + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall) Fields(s ...googleapi.Field) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall) Context(ctx context.Context) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + var body io.Reader = nil + body, err := googleapi.WithoutDataWrapper.JSONReader(c.setblobstoragesettingsrequest) + if err != nil { + return nil, err + } + reqHeaders.Set("Content-Type", "application/json") + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+resource}:setBlobStorageSettings") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("POST", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings" call. +// Exactly one of *Operation or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *Operation.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSetBlobStorageSettingsCall) Do(opts ...googleapi.CallOption) (*Operation, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &Operation{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "SetBlobStorageSettings sets the blob storage settings of the specified resources.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}:setBlobStorageSettings", + // "httpMethod": "POST", + // "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.setBlobStorageSettings", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "Required. The path of the resource to update the blob storage settings in the format of `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}`, `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/`, or `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}/dicomWeb/studies/{studyUID}/series/{seriesUID}/instances/{instanceUID}`. If `filter_config` is specified, set the value of `resource` to the resource name of a DICOM store in the format `projects/{projectID}/datasets/{datasetID}/dicomStores/{dicomStoreID}`.", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/.*$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+resource}:setBlobStorageSettings", + // "request": { + // "$ref": "SetBlobStorageSettingsRequest" + // }, + // "response": { + // "$ref": "Operation" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-healthcare", + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.getSeriesMetrics": type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetricsCall struct { @@ -21950,6 +22487,158 @@ func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesGetSeriesMetri } +// method id "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo": + +type ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall struct { + s *Service + resource string + urlParams_ gensupport.URLParams + ifNoneMatch_ string + ctx_ context.Context + header_ http.Header +} + +// GetStorageInfo: GetStorageInfo returns the storage info of the +// specified resource. +// +// - resource: The path of the resource for which the storage info is +// requested (for exaxmple for a DICOM Instance: +// `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId +// }/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instan +// ce_uid}`). +func (r *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesService) GetStorageInfo(resource string) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall { + c := &ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall{s: r.s, urlParams_: make(gensupport.URLParams)} + c.resource = resource + return c +} + +// Fields allows partial responses to be retrieved. See +// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse +// for more information. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) Fields(s ...googleapi.Field) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall { + c.urlParams_.Set("fields", googleapi.CombineFields(s)) + return c +} + +// IfNoneMatch sets the optional parameter which makes the operation +// fail if the object's ETag matches the given value. This is useful for +// getting updates only after the object has changed since the last +// request. Use googleapi.IsNotModified to check whether the response +// error from Do is the result of In-None-Match. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) IfNoneMatch(entityTag string) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall { + c.ifNoneMatch_ = entityTag + return c +} + +// Context sets the context to be used in this call's Do method. Any +// pending HTTP request will be aborted if the provided context is +// canceled. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) Context(ctx context.Context) *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall { + c.ctx_ = ctx + return c +} + +// Header returns an http.Header that can be modified by the caller to +// add HTTP headers to the request. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) Header() http.Header { + if c.header_ == nil { + c.header_ = make(http.Header) + } + return c.header_ +} + +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) doRequest(alt string) (*http.Response, error) { + reqHeaders := make(http.Header) + reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) + for k, v := range c.header_ { + reqHeaders[k] = v + } + reqHeaders.Set("User-Agent", c.s.userAgent()) + if c.ifNoneMatch_ != "" { + reqHeaders.Set("If-None-Match", c.ifNoneMatch_) + } + var body io.Reader = nil + c.urlParams_.Set("alt", alt) + c.urlParams_.Set("prettyPrint", "false") + urls := googleapi.ResolveRelative(c.s.BasePath, "v1beta1/{+resource}:getStorageInfo") + urls += "?" + c.urlParams_.Encode() + req, err := http.NewRequest("GET", urls, body) + if err != nil { + return nil, err + } + req.Header = reqHeaders + googleapi.Expand(req.URL, map[string]string{ + "resource": c.resource, + }) + return gensupport.SendRequest(c.ctx_, c.s.client, req) +} + +// Do executes the "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo" call. +// Exactly one of *StorageInfo or error will be non-nil. Any non-2xx +// status code is an error. Response headers are in either +// *StorageInfo.ServerResponse.Header or (if a response was returned at +// all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified +// to check whether the returned error was because +// http.StatusNotModified was returned. +func (c *ProjectsLocationsDatasetsDicomStoresDicomWebStudiesSeriesInstancesGetStorageInfoCall) Do(opts ...googleapi.CallOption) (*StorageInfo, error) { + gensupport.SetOptions(c.urlParams_, opts...) + res, err := c.doRequest("json") + if res != nil && res.StatusCode == http.StatusNotModified { + if res.Body != nil { + res.Body.Close() + } + return nil, gensupport.WrapError(&googleapi.Error{ + Code: res.StatusCode, + Header: res.Header, + }) + } + if err != nil { + return nil, err + } + defer googleapi.CloseBody(res) + if err := googleapi.CheckResponse(res); err != nil { + return nil, gensupport.WrapError(err) + } + ret := &StorageInfo{ + ServerResponse: googleapi.ServerResponse{ + Header: res.Header, + HTTPStatusCode: res.StatusCode, + }, + } + target := &ret + if err := gensupport.DecodeResponse(target, res); err != nil { + return nil, err + } + return ret, nil + // { + // "description": "GetStorageInfo returns the storage info of the specified resource.", + // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}:getStorageInfo", + // "httpMethod": "GET", + // "id": "healthcare.projects.locations.datasets.dicomStores.dicomWeb.studies.series.instances.getStorageInfo", + // "parameterOrder": [ + // "resource" + // ], + // "parameters": { + // "resource": { + // "description": "Required. The path of the resource for which the storage info is requested (for exaxmple for a DICOM Instance: `projects/{projectid}/datasets/{datasetid}/dicomStores/{dicomStoreId}/dicomWeb/studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`)", + // "location": "path", + // "pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/dicomStores/[^/]+/dicomWeb/studies/[^/]+/series/[^/]+/instances/[^/]+$", + // "required": true, + // "type": "string" + // } + // }, + // "path": "v1beta1/{+resource}:getStorageInfo", + // "response": { + // "$ref": "StorageInfo" + // }, + // "scopes": [ + // "https://www.googleapis.com/auth/cloud-healthcare", + // "https://www.googleapis.com/auth/cloud-platform" + // ] + // } + +} + // method id "healthcare.projects.locations.datasets.dicomStores.studies.delete": type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall struct { @@ -21966,8 +22655,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall struct { // will be marked successful when the deletion is complete. Warning: // Instances cannot be inserted into a study that is being deleted by an // operation until the operation completes. For samples that show how to -// call DeleteStudy, see Deleting a study, series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// call DeleteStudy, see Delete a study, series, or instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteStudy request. For example, // `studies/{study_uid}`. @@ -22066,7 +22755,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesDeleteCall) Do(opts ...googl } return ret, nil // { - // "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteStudy deletes all instances within the given study using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a study that is being deleted by an operation until the operation completes. For samples that show how to call DeleteStudy, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.delete", @@ -22121,8 +22810,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall struct { // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveStudyMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveStudyMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveStudyMetadata DICOMweb // request. For example, `studies/{study_uid}/metadata`. @@ -22204,7 +22893,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesRetrieveMetadataCall) Do(opt gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveStudyMetadata returns instance associated with the given study presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudyMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudyMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveMetadata", @@ -22259,8 +22948,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall struct { // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveStudy, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// show how to call RetrieveStudy, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveStudy DICOMweb request. For // example, `studies/{study_uid}`. @@ -22342,7 +23031,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesRetrieveStudyCall) Do(opts . gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveStudy returns all instances within the given study. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveStudy, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveStudy, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.retrieveStudy", @@ -22397,9 +23086,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -22482,7 +23170,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSearchForInstancesCall) Do(o gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForInstances", @@ -22537,9 +23225,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForSeries, see Searching for studies, series, -// instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForSeries, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForSeries DICOMweb request. For // example, `series` or `studies/{study_uid}/series`. @@ -22621,7 +23308,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSearchForSeriesCall) Do(opts gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForSeries returns a list of matching series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForSeries, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForSeries, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.searchForSeries", @@ -22676,8 +23363,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall struct { // transaction // (https://cloud.google.com/healthcare/docs/dicom#store_transaction) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call StoreInstances, see Storing DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data). +// how to call StoreInstances, see Store DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom). // // - dicomWebPath: The path of the StoreInstances DICOMweb request. For // example, `studies/[{study_uid}]`. Note that the `study_uid` is @@ -22747,7 +23434,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesStoreInstancesCall) Do(opts gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Storing DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#storing_dicom_data).", + // "description": "StoreInstances stores DICOM instances associated with study instance unique identifiers (SUID). See [Store Transaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.5). For details on the implementation of StoreInstances, see [Store transaction](https://cloud.google.com/healthcare/docs/dicom#store_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call StoreInstances, see [Store DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#store-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}", // "httpMethod": "POST", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.storeInstances", @@ -22802,9 +23489,9 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall struct { // Operation which will be marked successful when the deletion is // complete. Warning: Instances cannot be inserted into a series that is // being deleted by an operation until the operation completes. For -// samples that show how to call DeleteSeries, see Deleting a study, +// samples that show how to call DeleteSeries, see Delete a study, // series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteSeries request. For example, // `studies/{study_uid}/series/{series_uid}`. @@ -22906,7 +23593,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesDeleteCall) Do(opts .. } return ret, nil // { - // "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteSeries deletes all instances within the given study and series using a long running operation. The method returns an Operation which will be marked successful when the deletion is complete. Warning: Instances cannot be inserted into a series that is being deleted by an operation until the operation completes. For samples that show how to call DeleteSeries, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.delete", @@ -22962,8 +23649,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall struc // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveSeriesMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveSeriesMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveSeriesMetadata DICOMweb // request. For example, @@ -23046,7 +23733,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveMetadataCall) gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveSeriesMetadata returns instance associated with the given study and series, presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeriesMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeriesMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveMetadata", @@ -23101,8 +23788,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall struct // study/series/instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveSeries, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// show how to call RetrieveSeries, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveSeries DICOMweb request. For // example, `studies/{study_uid}/series/{series_uid}`. @@ -23184,7 +23871,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesRetrieveSeriesCall) Do gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveSeries returns all instances within the given study and series. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveSeries, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveSeries, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.retrieveSeries", @@ -23239,9 +23926,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall str // transaction // (https://cloud.google.com/healthcare/docs/dicom#search_transaction) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call SearchForInstances, see Searching for studies, -// series, instances, and frames -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames). +// show how to call SearchForInstances, see Search for DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom). // // - dicomWebPath: The path of the SearchForInstancesRequest DICOMweb // request. For example, `instances`, `series/{series_uid}/instances`, @@ -23324,7 +24010,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesSearchForInstancesCall gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Searching for studies, series, instances, and frames](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#searching_for_studies_series_instances_and_frames).", + // "description": "SearchForInstances returns a list of matching instances. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of SearchForInstances, see [Search transaction](https://cloud.google.com/healthcare/docs/dicom#search_transaction) in the Cloud Healthcare API conformance statement. For samples that show how to call SearchForInstances, see [Search for DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#search-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.searchForInstances", @@ -23376,8 +24062,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall struct // to the GET requests specified in the Retrieve transaction. Study and // series search results can take a few seconds to be updated after an // instance is deleted using DeleteInstance. For samples that show how -// to call DeleteInstance, see Deleting a study, series, or instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance). +// to call DeleteInstance, see Delete a study, series, or instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom). // // - dicomWebPath: The path of the DeleteInstance request. For example, // `studies/{study_uid}/series/{series_uid}/instances/{instance_uid}`. @@ -23479,7 +24165,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesDeleteCall) D } return ret, nil // { - // "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Deleting a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#deleting_a_study_series_or_instance).", + // "description": "DeleteInstance deletes an instance associated with the given study, series, and SOP Instance UID. Delete requests are equivalent to the GET requests specified in the Retrieve transaction. Study and series search results can take a few seconds to be updated after an instance is deleted using DeleteInstance. For samples that show how to call DeleteInstance, see [Delete a study, series, or instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#delete-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", // "httpMethod": "DELETE", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.delete", @@ -23537,8 +24223,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInstanceC // and DICOM instances // (https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in // the Cloud Healthcare API conformance statement. For samples that show -// how to call RetrieveInstance, see Retrieving an instance -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance). +// how to call RetrieveInstance, see Retrieve an instance +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance). // // - dicomWebPath: The path of the RetrieveInstance DICOMweb request. // For example, @@ -23621,7 +24307,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveInsta gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieving an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_an_instance).", + // "description": "RetrieveInstance returns instance associated with the given study, series, and SOP Instance UID. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstance, see [DICOM study/series/instances](https://cloud.google.com/healthcare/docs/dicom#dicom_studyseriesinstances) and [DICOM instances](https://cloud.google.com/healthcare/docs/dicom#dicom_instances) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstance, see [Retrieve an instance](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-instance).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveInstance", @@ -23678,8 +24364,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetadataC // Metadata resources // (https://cloud.google.com/healthcare/docs/dicom#metadata_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveInstanceMetadata, see Retrieving metadata -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata). +// show how to call RetrieveInstanceMetadata, see Retrieve metadata +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata). // // - dicomWebPath: The path of the RetrieveInstanceMetadata DICOMweb // request. For example, @@ -23763,7 +24449,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveMetad gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieving metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_metadata).", + // "description": "RetrieveInstanceMetadata returns instance associated with the given study, series, and SOP Instance UID presented as metadata with the bulk data removed. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveInstanceMetadata, see [Metadata resources](https://cloud.google.com/healthcare/docs/dicom#metadata_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveInstanceMetadata, see [Retrieve metadata](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-metadata).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/metadata", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveMetadata", @@ -23819,9 +24505,9 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRenderedC // Rendered resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveRenderedInstance, see Retrieving consumer +// show how to call RetrieveRenderedInstance, see Retrieve consumer // image formats -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). // // - dicomWebPath: The path of the RetrieveRenderedInstance DICOMweb // request. For example, @@ -23905,7 +24591,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesRetrieveRende gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + // "description": "RetrieveRenderedInstance returns instance associated with the given study, series, and SOP Instance UID in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedInstance, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedInstance, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/rendered", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.retrieveRendered", @@ -23960,8 +24646,8 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveFra // For details on the implementation of RetrieveFrames, see DICOM frames // (https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the // Cloud Healthcare API conformance statement. For samples that show how -// to call RetrieveFrames, see Retrieving DICOM data -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data). +// to call RetrieveFrames, see Retrieve DICOM data +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom). // // - dicomWebPath: The path of the RetrieveFrames DICOMweb request. For // example, @@ -24045,7 +24731,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetriev gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieving DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_dicom_data).", + // "description": "RetrieveFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveFrames, see [DICOM frames](https://cloud.google.com/healthcare/docs/dicom#dicom_frames) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveFrames, see [Retrieve DICOM data](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-dicom).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveFrames", @@ -24101,9 +24787,9 @@ type ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetrieveRen // Rendered resources // (https://cloud.google.com/healthcare/docs/dicom#rendered_resources) // in the Cloud Healthcare API conformance statement. For samples that -// show how to call RetrieveRenderedFrames, see Retrieving consumer -// image formats -// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats). +// show how to call RetrieveRenderedFrames, see Retrieve consumer image +// formats +// (https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer). // // - dicomWebPath: The path of the RetrieveRenderedFrames DICOMweb // request. For example, @@ -24187,7 +24873,7 @@ func (c *ProjectsLocationsDatasetsDicomStoresStudiesSeriesInstancesFramesRetriev gensupport.SetOptions(c.urlParams_, opts...) return c.doRequest("") // { - // "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieving consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieving_consumer_image_formats).", + // "description": "RetrieveRenderedFrames returns instances associated with the given study, series, SOP Instance UID and frame numbers in an acceptable Rendered Media Type. See [RetrieveTransaction](http://dicom.nema.org/medical/dicom/current/output/html/part18.html#sect_10.4). For details on the implementation of RetrieveRenderedFrames, see [Rendered resources](https://cloud.google.com/healthcare/docs/dicom#rendered_resources) in the Cloud Healthcare API conformance statement. For samples that show how to call RetrieveRenderedFrames, see [Retrieve consumer image formats](https://cloud.google.com/healthcare/docs/how-tos/dicomweb#retrieve-consumer).", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/dicomStores/{dicomStoresId}/dicomWeb/studies/{studiesId}/series/{seriesId}/instances/{instancesId}/frames/{framesId}/rendered", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.dicomStores.studies.series.instances.frames.retrieveRendered", @@ -31010,7 +31696,7 @@ type ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall struct { header_ http.Header } -// GetHL7v2StoreMetrics: Gets metrics asssociated with the HL7v2 store. +// GetHL7v2StoreMetrics: Gets metrics associated with the HL7v2 store. // // - name: The resource name of the HL7v2 store to get metrics for, in // the format @@ -31121,7 +31807,7 @@ func (c *ProjectsLocationsDatasetsHl7V2StoresGetHL7v2StoreMetricsCall) Do(opts . } return ret, nil // { - // "description": "Gets metrics asssociated with the HL7v2 store.", + // "description": "Gets metrics associated with the HL7v2 store.", // "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/hl7V2Stores/{hl7V2StoresId}:getHL7v2StoreMetrics", // "httpMethod": "GET", // "id": "healthcare.projects.locations.datasets.hl7V2Stores.getHL7v2StoreMetrics", diff --git a/migrationcenter/v1alpha1/migrationcenter-api.json b/migrationcenter/v1alpha1/migrationcenter-api.json index 508533558a7..9e9fe302069 100644 --- a/migrationcenter/v1alpha1/migrationcenter-api.json +++ b/migrationcenter/v1alpha1/migrationcenter-api.json @@ -436,6 +436,11 @@ "required": true, "type": "string" }, + "showHidden": { + "description": "Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.", + "location": "query", + "type": "boolean" + }, "view": { "description": "View of the assets. Defaults to BASIC.", "enum": [ @@ -2102,7 +2107,7 @@ } } }, - "revision": "20231013", + "revision": "20231027", "rootUrl": "https://migrationcenter.googleapis.com/", "schemas": { "AddAssetsToGroupRequest": { @@ -2138,6 +2143,10 @@ "filter": { "description": "The aggregation will be performed on assets that match the provided filter.", "type": "string" + }, + "showHidden": { + "description": "Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.", + "type": "boolean" } }, "type": "object" @@ -2335,6 +2344,20 @@ "readOnly": true, "type": "string" }, + "hidden": { + "description": "Optional. Indicates if the asset is hidden.", + "type": "boolean" + }, + "hideReason": { + "description": "Optional. An optional reason for marking this asset as hidden.", + "type": "string" + }, + "hideTime": { + "description": "Output only. The timestamp when the asset was marked as hidden.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, "insightList": { "$ref": "InsightList", "description": "Output only. The list of insights associated with the asset.", diff --git a/migrationcenter/v1alpha1/migrationcenter-gen.go b/migrationcenter/v1alpha1/migrationcenter-gen.go index 07af79cc3b0..1e3ad162f28 100644 --- a/migrationcenter/v1alpha1/migrationcenter-gen.go +++ b/migrationcenter/v1alpha1/migrationcenter-gen.go @@ -353,6 +353,10 @@ type AggregateAssetsValuesRequest struct { // provided filter. Filter string `json:"filter,omitempty"` + // ShowHidden: Optional. When this value is set to 'true' the response + // will include all assets, including those that are hidden. + ShowHidden bool `json:"showHidden,omitempty"` + // ForceSendFields is a list of field names (e.g. "Aggregations") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any @@ -746,6 +750,17 @@ type Asset struct { // CreateTime: Output only. The timestamp when the asset was created. CreateTime string `json:"createTime,omitempty"` + // Hidden: Optional. Indicates if the asset is hidden. + Hidden bool `json:"hidden,omitempty"` + + // HideReason: Optional. An optional reason for marking this asset as + // hidden. + HideReason string `json:"hideReason,omitempty"` + + // HideTime: Output only. The timestamp when the asset was marked as + // hidden. + HideTime string `json:"hideTime,omitempty"` + // InsightList: Output only. The list of insights associated with the // asset. InsightList *InsightList `json:"insightList,omitempty"` @@ -8075,6 +8090,14 @@ func (c *ProjectsLocationsAssetsListCall) PageToken(pageToken string) *ProjectsL return c } +// ShowHidden sets the optional parameter "showHidden": When this value +// is set to 'true' the response will include all assets, including +// those that are hidden. +func (c *ProjectsLocationsAssetsListCall) ShowHidden(showHidden bool) *ProjectsLocationsAssetsListCall { + c.urlParams_.Set("showHidden", fmt.Sprint(showHidden)) + return c +} + // View sets the optional parameter "view": View of the assets. Defaults // to BASIC. // @@ -8235,6 +8258,11 @@ func (c *ProjectsLocationsAssetsListCall) Do(opts ...googleapi.CallOption) (*Lis // "required": true, // "type": "string" // }, + // "showHidden": { + // "description": "Optional. When this value is set to 'true' the response will include all assets, including those that are hidden.", + // "location": "query", + // "type": "boolean" + // }, // "view": { // "description": "View of the assets. Defaults to BASIC.", // "enum": [ diff --git a/networkconnectivity/v1/networkconnectivity-api.json b/networkconnectivity/v1/networkconnectivity-api.json index ccda6c724ca..86c3dcfb189 100644 --- a/networkconnectivity/v1/networkconnectivity-api.json +++ b/networkconnectivity/v1/networkconnectivity-api.json @@ -2358,34 +2358,6 @@ }, "spokes": { "methods": { - "accept": { - "description": "Accepts a proposal to attach a Network Connectivity Center spoke to the hub.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:accept", - "httpMethod": "POST", - "id": "networkconnectivity.projects.locations.spokes.accept", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spoke to accept.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:accept", - "request": { - "$ref": "AcceptSpokeRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "create": { "description": "Creates a Network Connectivity Center spoke.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes", @@ -2595,34 +2567,6 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, - "reject": { - "description": "Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub.", - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:reject", - "httpMethod": "POST", - "id": "networkconnectivity.projects.locations.spokes.reject", - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required. The name of the spoke to reject.", - "location": "path", - "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", - "required": true, - "type": "string" - } - }, - "path": "v1/{+name}:reject", - "request": { - "$ref": "RejectSpokeRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:setIamPolicy", @@ -2686,7 +2630,7 @@ } } }, - "revision": "20230921", + "revision": "20231030", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -2715,17 +2659,6 @@ }, "type": "object" }, - "AcceptSpokeRequest": { - "description": "The request for HubService.AcceptSpoke.", - "id": "AcceptSpokeRequest", - "properties": { - "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "type": "string" - } - }, - "type": "object" - }, "AuditConfig": { "description": "Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.", "id": "AuditConfig", @@ -4117,21 +4050,6 @@ }, "type": "object" }, - "RejectSpokeRequest": { - "description": "The request for HubService.RejectSpoke.", - "id": "RejectSpokeRequest", - "properties": { - "details": { - "description": "Optional. Additional information provided by the hub administrator in the `RejectSpoke` call.", - "type": "string" - }, - "requestId": { - "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server knows to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check to see whether the original operation was received. If it was, the server ignores the second request. This behavior prevents clients from mistakenly creating duplicate commitments. The request ID must be a valid UUID, with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", - "type": "string" - } - }, - "type": "object" - }, "Route": { "description": "A route defines a path from VM instances within a spoke to a specific destination resource. Only VPC spokes have routes.", "id": "Route", diff --git a/networkconnectivity/v1/networkconnectivity-gen.go b/networkconnectivity/v1/networkconnectivity-gen.go index eaf6232628d..273bd31a1cb 100644 --- a/networkconnectivity/v1/networkconnectivity-gen.go +++ b/networkconnectivity/v1/networkconnectivity-gen.go @@ -398,45 +398,6 @@ func (s *AcceptHubSpokeResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// AcceptSpokeRequest: The request for HubService.AcceptSpoke. -type AcceptSpokeRequest struct { - // RequestId: Optional. A request ID to identify requests. Specify a - // unique request ID so that if you must retry your request, the server - // knows to ignore the request if it has already been completed. The - // server guarantees that a request doesn't result in creation of - // duplicate commitments for at least 60 minutes. For example, consider - // a situation where you make an initial request and the request times - // out. If you make the request again with the same request ID, the - // server can check to see whether the original operation was received. - // If it was, the server ignores the second request. This behavior - // prevents clients from mistakenly creating duplicate commitments. The - // request ID must be a valid UUID, with the exception that zero UUID is - // not supported (00000000-0000-0000-0000-000000000000). - RequestId string `json:"requestId,omitempty"` - - // ForceSendFields is a list of field names (e.g. "RequestId") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "RequestId") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *AcceptSpokeRequest) MarshalJSON() ([]byte, error) { - type NoMethod AcceptSpokeRequest - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // AuditConfig: Specifies the audit configuration for a service. The // configuration determines which permission types are logged, and what // identities, if any, are exempted from logging. An AuditConfig must @@ -2702,49 +2663,6 @@ func (s *RejectHubSpokeResponse) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } -// RejectSpokeRequest: The request for HubService.RejectSpoke. -type RejectSpokeRequest struct { - // Details: Optional. Additional information provided by the hub - // administrator in the `RejectSpoke` call. - Details string `json:"details,omitempty"` - - // RequestId: Optional. A request ID to identify requests. Specify a - // unique request ID so that if you must retry your request, the server - // knows to ignore the request if it has already been completed. The - // server guarantees that a request doesn't result in creation of - // duplicate commitments for at least 60 minutes. For example, consider - // a situation where you make an initial request and the request times - // out. If you make the request again with the same request ID, the - // server can check to see whether the original operation was received. - // If it was, the server ignores the second request. This behavior - // prevents clients from mistakenly creating duplicate commitments. The - // request ID must be a valid UUID, with the exception that zero UUID is - // not supported (00000000-0000-0000-0000-000000000000). - RequestId string `json:"requestId,omitempty"` - - // ForceSendFields is a list of field names (e.g. "Details") to - // unconditionally include in API requests. By default, fields with - // empty or default values are omitted from API requests. However, any - // non-pointer, non-interface field appearing in ForceSendFields will be - // sent to the server regardless of whether the field is empty or not. - // This may be used to include empty fields in Patch requests. - ForceSendFields []string `json:"-"` - - // NullFields is a list of field names (e.g. "Details") to include in - // API requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as - // null. It is an error if a field in this list has a non-empty value. - // This may be used to include null fields in Patch requests. - NullFields []string `json:"-"` -} - -func (s *RejectSpokeRequest) MarshalJSON() ([]byte, error) { - type NoMethod RejectSpokeRequest - raw := NoMethod(*s) - return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) -} - // Route: A route defines a path from VM instances within a spoke to a // specific destination resource. Only VPC spokes have routes. type Route struct { @@ -14943,149 +14861,6 @@ func (c *ProjectsLocationsServiceConnectionTokensListCall) Pages(ctx context.Con } } -// method id "networkconnectivity.projects.locations.spokes.accept": - -type ProjectsLocationsSpokesAcceptCall struct { - s *Service - name string - acceptspokerequest *AcceptSpokeRequest - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Accept: Accepts a proposal to attach a Network Connectivity Center -// spoke to the hub. -// -// - name: The name of the spoke to accept. -func (r *ProjectsLocationsSpokesService) Accept(name string, acceptspokerequest *AcceptSpokeRequest) *ProjectsLocationsSpokesAcceptCall { - c := &ProjectsLocationsSpokesAcceptCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - c.acceptspokerequest = acceptspokerequest - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse -// for more information. -func (c *ProjectsLocationsSpokesAcceptCall) Fields(s ...googleapi.Field) *ProjectsLocationsSpokesAcceptCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. Any -// pending HTTP request will be aborted if the provided context is -// canceled. -func (c *ProjectsLocationsSpokesAcceptCall) Context(ctx context.Context) *ProjectsLocationsSpokesAcceptCall { - c.ctx_ = ctx - return c -} - -// Header returns an http.Header that can be modified by the caller to -// add HTTP headers to the request. -func (c *ProjectsLocationsSpokesAcceptCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsLocationsSpokesAcceptCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) - for k, v := range c.header_ { - reqHeaders[k] = v - } - reqHeaders.Set("User-Agent", c.s.userAgent()) - var body io.Reader = nil - body, err := googleapi.WithoutDataWrapper.JSONReader(c.acceptspokerequest) - if err != nil { - return nil, err - } - reqHeaders.Set("Content-Type", "application/json") - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:accept") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "networkconnectivity.projects.locations.spokes.accept" call. -// Exactly one of *GoogleLongrunningOperation or error will be non-nil. -// Any non-2xx status code is an error. Response headers are in either -// *GoogleLongrunningOperation.ServerResponse.Header or (if a response -// was returned at all) in error.(*googleapi.Error).Header. Use -// googleapi.IsNotModified to check whether the returned error was -// because http.StatusNotModified was returned. -func (c *ProjectsLocationsSpokesAcceptCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GoogleLongrunningOperation{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - if err := gensupport.DecodeResponse(target, res); err != nil { - return nil, err - } - return ret, nil - // { - // "description": "Accepts a proposal to attach a Network Connectivity Center spoke to the hub.", - // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:accept", - // "httpMethod": "POST", - // "id": "networkconnectivity.projects.locations.spokes.accept", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "Required. The name of the spoke to accept.", - // "location": "path", - // "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1/{+name}:accept", - // "request": { - // "$ref": "AcceptSpokeRequest" - // }, - // "response": { - // "$ref": "GoogleLongrunningOperation" - // }, - // "scopes": [ - // "https://www.googleapis.com/auth/cloud-platform" - // ] - // } - -} - // method id "networkconnectivity.projects.locations.spokes.create": type ProjectsLocationsSpokesCreateCall struct { @@ -16139,151 +15914,6 @@ func (c *ProjectsLocationsSpokesPatchCall) Do(opts ...googleapi.CallOption) (*Go } -// method id "networkconnectivity.projects.locations.spokes.reject": - -type ProjectsLocationsSpokesRejectCall struct { - s *Service - name string - rejectspokerequest *RejectSpokeRequest - urlParams_ gensupport.URLParams - ctx_ context.Context - header_ http.Header -} - -// Reject: Rejects a Network Connectivity Center spoke from being -// attached to the hub. If the spoke was previously in the `ACTIVE` -// state, it transitions to the `INACTIVE` state and is no longer able -// to connect to other spokes that are attached to the hub. -// -// - name: The name of the spoke to reject. -func (r *ProjectsLocationsSpokesService) Reject(name string, rejectspokerequest *RejectSpokeRequest) *ProjectsLocationsSpokesRejectCall { - c := &ProjectsLocationsSpokesRejectCall{s: r.s, urlParams_: make(gensupport.URLParams)} - c.name = name - c.rejectspokerequest = rejectspokerequest - return c -} - -// Fields allows partial responses to be retrieved. See -// https://developers.google.com/gdata/docs/2.0/basics#PartialResponse -// for more information. -func (c *ProjectsLocationsSpokesRejectCall) Fields(s ...googleapi.Field) *ProjectsLocationsSpokesRejectCall { - c.urlParams_.Set("fields", googleapi.CombineFields(s)) - return c -} - -// Context sets the context to be used in this call's Do method. Any -// pending HTTP request will be aborted if the provided context is -// canceled. -func (c *ProjectsLocationsSpokesRejectCall) Context(ctx context.Context) *ProjectsLocationsSpokesRejectCall { - c.ctx_ = ctx - return c -} - -// Header returns an http.Header that can be modified by the caller to -// add HTTP headers to the request. -func (c *ProjectsLocationsSpokesRejectCall) Header() http.Header { - if c.header_ == nil { - c.header_ = make(http.Header) - } - return c.header_ -} - -func (c *ProjectsLocationsSpokesRejectCall) doRequest(alt string) (*http.Response, error) { - reqHeaders := make(http.Header) - reqHeaders.Set("x-goog-api-client", "gl-go/"+gensupport.GoVersion()+" gdcl/"+internal.Version) - for k, v := range c.header_ { - reqHeaders[k] = v - } - reqHeaders.Set("User-Agent", c.s.userAgent()) - var body io.Reader = nil - body, err := googleapi.WithoutDataWrapper.JSONReader(c.rejectspokerequest) - if err != nil { - return nil, err - } - reqHeaders.Set("Content-Type", "application/json") - c.urlParams_.Set("alt", alt) - c.urlParams_.Set("prettyPrint", "false") - urls := googleapi.ResolveRelative(c.s.BasePath, "v1/{+name}:reject") - urls += "?" + c.urlParams_.Encode() - req, err := http.NewRequest("POST", urls, body) - if err != nil { - return nil, err - } - req.Header = reqHeaders - googleapi.Expand(req.URL, map[string]string{ - "name": c.name, - }) - return gensupport.SendRequest(c.ctx_, c.s.client, req) -} - -// Do executes the "networkconnectivity.projects.locations.spokes.reject" call. -// Exactly one of *GoogleLongrunningOperation or error will be non-nil. -// Any non-2xx status code is an error. Response headers are in either -// *GoogleLongrunningOperation.ServerResponse.Header or (if a response -// was returned at all) in error.(*googleapi.Error).Header. Use -// googleapi.IsNotModified to check whether the returned error was -// because http.StatusNotModified was returned. -func (c *ProjectsLocationsSpokesRejectCall) Do(opts ...googleapi.CallOption) (*GoogleLongrunningOperation, error) { - gensupport.SetOptions(c.urlParams_, opts...) - res, err := c.doRequest("json") - if res != nil && res.StatusCode == http.StatusNotModified { - if res.Body != nil { - res.Body.Close() - } - return nil, gensupport.WrapError(&googleapi.Error{ - Code: res.StatusCode, - Header: res.Header, - }) - } - if err != nil { - return nil, err - } - defer googleapi.CloseBody(res) - if err := googleapi.CheckResponse(res); err != nil { - return nil, gensupport.WrapError(err) - } - ret := &GoogleLongrunningOperation{ - ServerResponse: googleapi.ServerResponse{ - Header: res.Header, - HTTPStatusCode: res.StatusCode, - }, - } - target := &ret - if err := gensupport.DecodeResponse(target, res); err != nil { - return nil, err - } - return ret, nil - // { - // "description": "Rejects a Network Connectivity Center spoke from being attached to the hub. If the spoke was previously in the `ACTIVE` state, it transitions to the `INACTIVE` state and is no longer able to connect to other spokes that are attached to the hub.", - // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/spokes/{spokesId}:reject", - // "httpMethod": "POST", - // "id": "networkconnectivity.projects.locations.spokes.reject", - // "parameterOrder": [ - // "name" - // ], - // "parameters": { - // "name": { - // "description": "Required. The name of the spoke to reject.", - // "location": "path", - // "pattern": "^projects/[^/]+/locations/[^/]+/spokes/[^/]+$", - // "required": true, - // "type": "string" - // } - // }, - // "path": "v1/{+name}:reject", - // "request": { - // "$ref": "RejectSpokeRequest" - // }, - // "response": { - // "$ref": "GoogleLongrunningOperation" - // }, - // "scopes": [ - // "https://www.googleapis.com/auth/cloud-platform" - // ] - // } - -} - // method id "networkconnectivity.projects.locations.spokes.setIamPolicy": type ProjectsLocationsSpokesSetIamPolicyCall struct { diff --git a/searchads360/v0/searchads360-api.json b/searchads360/v0/searchads360-api.json index ce7f9b8c035..908df485b5e 100644 --- a/searchads360/v0/searchads360-api.json +++ b/searchads360/v0/searchads360-api.json @@ -260,7 +260,7 @@ } } }, - "revision": "20230818", + "revision": "20231031", "rootUrl": "https://searchads360.googleapis.com/", "schemas": { "GoogleAdsSearchads360V0Common__AdScheduleInfo": { @@ -394,6 +394,100 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Common__AssetUsage": { + "description": "Contains the usage information of the asset.", + "id": "GoogleAdsSearchads360V0Common__AssetUsage", + "properties": { + "asset": { + "description": "Resource name of the asset.", + "type": "string" + }, + "servedAssetFieldType": { + "description": "The served field type of the asset.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "HEADLINE_1", + "HEADLINE_2", + "HEADLINE_3", + "DESCRIPTION_1", + "DESCRIPTION_2", + "HEADLINE", + "HEADLINE_IN_PORTRAIT", + "LONG_HEADLINE", + "DESCRIPTION", + "DESCRIPTION_IN_PORTRAIT", + "BUSINESS_NAME_IN_PORTRAIT", + "BUSINESS_NAME", + "MARKETING_IMAGE", + "MARKETING_IMAGE_IN_PORTRAIT", + "SQUARE_MARKETING_IMAGE", + "PORTRAIT_MARKETING_IMAGE", + "LOGO", + "LANDSCAPE_LOGO", + "CALL_TO_ACTION", + "YOU_TUBE_VIDEO", + "SITELINK", + "CALL", + "MOBILE_APP", + "CALLOUT", + "STRUCTURED_SNIPPET", + "PRICE", + "PROMOTION", + "AD_IMAGE", + "LEAD_FORM", + "BUSINESS_LOGO" + ], + "enumDescriptions": [ + "No value has been specified.", + "The received value is not known in this version. This is a response-only value.", + "The asset is used in headline 1.", + "The asset is used in headline 2.", + "The asset is used in headline 3.", + "The asset is used in description 1.", + "The asset is used in description 2.", + "The asset was used in a headline. Use this only if there is only one headline in the ad. Otherwise, use the HEADLINE_1, HEADLINE_2 or HEADLINE_3 enums", + "The asset was used as a headline in portrait image.", + "The asset was used in a long headline (used in MultiAssetResponsiveAd).", + "The asset was used in a description. Use this only if there is only one description in the ad. Otherwise, use the DESCRIPTION_1 or DESCRIPTION_@ enums", + "The asset was used as description in portrait image.", + "The asset was used as business name in portrait image.", + "The asset was used as business name.", + "The asset was used as a marketing image.", + "The asset was used as a marketing image in portrait image.", + "The asset was used as a square marketing image.", + "The asset was used as a portrait marketing image.", + "The asset was used as a logo.", + "The asset was used as a landscape logo.", + "The asset was used as a call-to-action.", + "The asset was used as a YouTube video.", + "This asset is used as a sitelink.", + "This asset is used as a call.", + "This asset is used as a mobile app.", + "This asset is used as a callout.", + "This asset is used as a structured snippet.", + "This asset is used as a price.", + "This asset is used as a promotion.", + "This asset is used as an image.", + "The asset is used as a lead form.", + "The asset is used as a business logo." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Common__AudienceInfo": { + "description": "An audience criterion.", + "id": "GoogleAdsSearchads360V0Common__AudienceInfo", + "properties": { + "audience": { + "description": "The Audience resource name.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__BusinessProfileLocation": { "description": "Business Profile location data synced from the linked Business Profile account.", "id": "GoogleAdsSearchads360V0Common__BusinessProfileLocation", @@ -417,6 +511,59 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Common__CallToActionAsset": { + "description": "A call to action asset.", + "id": "GoogleAdsSearchads360V0Common__CallToActionAsset", + "properties": { + "callToAction": { + "description": "Call to action.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "LEARN_MORE", + "GET_QUOTE", + "APPLY_NOW", + "SIGN_UP", + "CONTACT_US", + "SUBSCRIBE", + "DOWNLOAD", + "BOOK_NOW", + "SHOP_NOW", + "BUY_NOW", + "DONATE_NOW", + "ORDER_NOW", + "PLAY_NOW", + "SEE_MORE", + "START_NOW", + "VISIT_SITE", + "WATCH_NOW" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The call to action type is learn more.", + "The call to action type is get quote.", + "The call to action type is apply now.", + "The call to action type is sign up.", + "The call to action type is contact us.", + "The call to action type is subscribe.", + "The call to action type is download.", + "The call to action type is book now.", + "The call to action type is shop now.", + "The call to action type is buy now.", + "The call to action type is donate now.", + "The call to action type is order now.", + "The call to action type is play now.", + "The call to action type is see more.", + "The call to action type is start now.", + "The call to action type is visit site.", + "The call to action type is watch now." + ], + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__CustomParameter": { "description": "A mapping that can be used by custom parameter tags in a `tracking_url_template`, `final_urls`, or `mobile_final_urls`.", "id": "GoogleAdsSearchads360V0Common__CustomParameter", @@ -498,6 +645,79 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Common__ImageAsset": { + "description": "An Image asset.", + "id": "GoogleAdsSearchads360V0Common__ImageAsset", + "properties": { + "fileSize": { + "description": "File size of the image asset in bytes.", + "format": "int64", + "type": "string" + }, + "fullSize": { + "$ref": "GoogleAdsSearchads360V0Common__ImageDimension", + "description": "Metadata for this image at its original size." + }, + "mimeType": { + "description": "MIME type of the image asset.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "IMAGE_JPEG", + "IMAGE_GIF", + "IMAGE_PNG", + "FLASH", + "TEXT_HTML", + "PDF", + "MSWORD", + "MSEXCEL", + "RTF", + "AUDIO_WAV", + "AUDIO_MP3", + "HTML5_AD_ZIP" + ], + "enumDescriptions": [ + "The mime type has not been specified.", + "The received value is not known in this version. This is a response-only value.", + "MIME type of image/jpeg.", + "MIME type of image/gif.", + "MIME type of image/png.", + "MIME type of application/x-shockwave-flash.", + "MIME type of text/html.", + "MIME type of application/pdf.", + "MIME type of application/msword.", + "MIME type of application/vnd.ms-excel.", + "MIME type of application/rtf.", + "MIME type of audio/wav.", + "MIME type of audio/mp3.", + "MIME type of application/x-html5-ad-zip." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Common__ImageDimension": { + "description": "Metadata for an image at a certain size, either original or resized.", + "id": "GoogleAdsSearchads360V0Common__ImageDimension", + "properties": { + "heightPixels": { + "description": "Height of the image.", + "format": "int64", + "type": "string" + }, + "url": { + "description": "A URL that returns the image with this height and width.", + "type": "string" + }, + "widthPixels": { + "description": "Width of the image.", + "format": "int64", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__Keyword": { "description": "A Keyword criterion segment.", "id": "GoogleAdsSearchads360V0Common__Keyword", @@ -807,6 +1027,46 @@ "format": "double", "type": "number" }, + "clientAccountCrossSellCostOfGoodsSoldMicros": { + "description": "Client account cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountCrossSellGrossProfitMicros": { + "description": "Client account cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountCrossSellRevenueMicros": { + "description": "Client account cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountCrossSellUnitsSold": { + "description": "Client account cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, + "clientAccountLeadCostOfGoodsSoldMicros": { + "description": "Client account lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountLeadGrossProfitMicros": { + "description": "Client account lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountLeadRevenueMicros": { + "description": "Client account lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "clientAccountLeadUnitsSold": { + "description": "Client account lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "clientAccountViewThroughConversions": { "description": "The total number of view-through conversions. These happen when a customer sees an image or rich media ad, then later completes a conversion on your site without interacting with (for example, clicking on) another ad.", "format": "int64", @@ -892,6 +1152,26 @@ "format": "double", "type": "number" }, + "crossSellCostOfGoodsSoldMicros": { + "description": "Cross-sell cost of goods sold (COGS) is the total cost of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell cost of goods sold is the total cost of the products sold that weren't advertised. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The cross-sell cost of goods sold for this order is $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "crossSellGrossProfitMicros": { + "description": "Cross-sell gross profit is the profit you made from products sold as a result of advertising a different product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the purchase is a sold product. If these products don't match then this is considered cross-sell. Cross-sell gross profit is the revenue you made from cross-sell attributed to your ads minus the cost of the goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The shirt is priced $20 and has a cost of goods sold value of $5. The cross-sell gross profit of this order is $15 = $20 - $5. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "crossSellRevenueMicros": { + "description": "Cross-sell revenue is the total amount you made from products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell revenue is the total value you made from cross-sell attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The cross-sell revenue of this order is $20. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "crossSellUnitsSold": { + "description": "Cross-sell units sold is the total number of products sold as a result of advertising a different product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If these products don't match then this is considered cross-sell. Cross-sell units sold is the total number of cross-sold products from all orders attributed to your ads. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The cross-sell units sold in this order is 2. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "ctr": { "description": "The number of clicks your ad receives (Clicks) divided by the number of times your ad is shown (Impressions).", "format": "double", @@ -1004,6 +1284,26 @@ "format": "int64", "type": "string" }, + "leadCostOfGoodsSoldMicros": { + "description": "Lead cost of goods sold (COGS) is the total cost of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the cost of these goods is counted under lead cost of goods sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat has a cost of goods sold value of $3, the shirt has a cost of goods sold value of $5. The lead cost of goods sold for this order is $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "leadGrossProfitMicros": { + "description": "Lead gross profit is the profit you made from products sold as a result of advertising the same product, minus cost of goods sold (COGS). How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the revenue you made from these sales minus the cost of goods sold is your lead gross profit. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and has a cost of goods sold value of $3. The lead gross profit of this order is $7 = $10 - $3. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "leadRevenueMicros": { + "description": "Lead revenue is the total amount you made from products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total value you made from the sales of these products is shown under lead revenue. Example: Someone clicked on a Shopping ad for a hat then bought the same hat and a shirt. The hat is priced $10 and the shirt is priced $20. The lead revenue of this order is $10. This metric is only available if you report conversions with cart data. This metric is a monetary value and returned in the customer's currency by default. See the metrics_currency parameter at https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause", + "format": "int64", + "type": "string" + }, + "leadUnitsSold": { + "description": "Lead units sold is the total number of products sold as a result of advertising the same product. How it works: You report conversions with cart data for completed purchases on your website. If the ad that was interacted with before the purchase has an associated product (see Shopping Ads) then this product is considered the advertised product. Any product included in the order the customer places is a sold product. If the advertised and sold products match, then the total number of these products sold is shown under lead units sold. Example: Someone clicked on a Shopping ad for a hat then bought the same hat, a shirt and a jacket. The lead units sold in this order is 1. This metric is only available if you report conversions with cart data.", + "format": "double", + "type": "number" + }, "mobileFriendlyClicksPercentage": { "description": "The percentage of mobile clicks that go to a mobile-friendly page.", "format": "double", @@ -1425,6 +1725,234 @@ "description": "Month as represented by the date of the first day of a month. Formatted as yyyy-MM-dd.", "type": "string" }, + "productBiddingCategoryLevel1": { + "description": "Bidding category (level 1) of the product.", + "type": "string" + }, + "productBiddingCategoryLevel2": { + "description": "Bidding category (level 2) of the product.", + "type": "string" + }, + "productBiddingCategoryLevel3": { + "description": "Bidding category (level 3) of the product.", + "type": "string" + }, + "productBiddingCategoryLevel4": { + "description": "Bidding category (level 4) of the product.", + "type": "string" + }, + "productBiddingCategoryLevel5": { + "description": "Bidding category (level 5) of the product.", + "type": "string" + }, + "productBrand": { + "description": "Brand of the product.", + "type": "string" + }, + "productChannel": { + "description": "Channel of the product.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ONLINE", + "LOCAL" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The item is sold online.", + "The item is sold in local stores." + ], + "type": "string" + }, + "productChannelExclusivity": { + "description": "Channel exclusivity of the product.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "SINGLE_CHANNEL", + "MULTI_CHANNEL" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The item is sold through one channel only, either local stores or online as indicated by its ProductChannel.", + "The item is matched to its online or local stores counterpart, indicating it is available for purchase in both ShoppingProductChannels." + ], + "type": "string" + }, + "productCondition": { + "description": "Condition of the product.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "OLD", + "NEW", + "REFURBISHED", + "USED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The product condition is old.", + "The product condition is new.", + "The product condition is refurbished.", + "The product condition is used." + ], + "type": "string" + }, + "productCountry": { + "description": "Resource name of the geo target constant for the country of sale of the product.", + "type": "string" + }, + "productCustomAttribute0": { + "description": "Custom attribute 0 of the product.", + "type": "string" + }, + "productCustomAttribute1": { + "description": "Custom attribute 1 of the product.", + "type": "string" + }, + "productCustomAttribute2": { + "description": "Custom attribute 2 of the product.", + "type": "string" + }, + "productCustomAttribute3": { + "description": "Custom attribute 3 of the product.", + "type": "string" + }, + "productCustomAttribute4": { + "description": "Custom attribute 4 of the product.", + "type": "string" + }, + "productItemId": { + "description": "Item ID of the product.", + "type": "string" + }, + "productLanguage": { + "description": "Resource name of the language constant for the language of the product.", + "type": "string" + }, + "productSoldBiddingCategoryLevel1": { + "description": "Bidding category (level 1) of the product sold.", + "type": "string" + }, + "productSoldBiddingCategoryLevel2": { + "description": "Bidding category (level 2) of the product sold.", + "type": "string" + }, + "productSoldBiddingCategoryLevel3": { + "description": "Bidding category (level 3) of the product sold.", + "type": "string" + }, + "productSoldBiddingCategoryLevel4": { + "description": "Bidding category (level 4) of the product sold.", + "type": "string" + }, + "productSoldBiddingCategoryLevel5": { + "description": "Bidding category (level 5) of the product sold.", + "type": "string" + }, + "productSoldBrand": { + "description": "Brand of the product sold.", + "type": "string" + }, + "productSoldCondition": { + "description": "Condition of the product sold.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "OLD", + "NEW", + "REFURBISHED", + "USED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The product condition is old.", + "The product condition is new.", + "The product condition is refurbished.", + "The product condition is used." + ], + "type": "string" + }, + "productSoldCustomAttribute0": { + "description": "Custom attribute 0 of the product sold.", + "type": "string" + }, + "productSoldCustomAttribute1": { + "description": "Custom attribute 1 of the product sold.", + "type": "string" + }, + "productSoldCustomAttribute2": { + "description": "Custom attribute 2 of the product sold.", + "type": "string" + }, + "productSoldCustomAttribute3": { + "description": "Custom attribute 3 of the product sold.", + "type": "string" + }, + "productSoldCustomAttribute4": { + "description": "Custom attribute 4 of the product sold.", + "type": "string" + }, + "productSoldItemId": { + "description": "Item ID of the product sold.", + "type": "string" + }, + "productSoldTitle": { + "description": "Title of the product sold.", + "type": "string" + }, + "productSoldTypeL1": { + "description": "Type (level 1) of the product sold.", + "type": "string" + }, + "productSoldTypeL2": { + "description": "Type (level 2) of the product sold.", + "type": "string" + }, + "productSoldTypeL3": { + "description": "Type (level 3) of the product sold.", + "type": "string" + }, + "productSoldTypeL4": { + "description": "Type (level 4) of the product sold.", + "type": "string" + }, + "productSoldTypeL5": { + "description": "Type (level 5) of the product sold.", + "type": "string" + }, + "productStoreId": { + "description": "Store ID of the product.", + "type": "string" + }, + "productTitle": { + "description": "Title of the product.", + "type": "string" + }, + "productTypeL1": { + "description": "Type (level 1) of the product.", + "type": "string" + }, + "productTypeL2": { + "description": "Type (level 2) of the product.", + "type": "string" + }, + "productTypeL3": { + "description": "Type (level 3) of the product.", + "type": "string" + }, + "productTypeL4": { + "description": "Type (level 4) of the product.", + "type": "string" + }, + "productTypeL5": { + "description": "Type (level 5) of the product.", + "type": "string" + }, "quarter": { "description": "Quarter as represented by the date of the first day of a quarter. Uses the calendar year for quarters, for example, the second quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd.", "type": "string" @@ -1609,6 +2137,17 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Common__TextAsset": { + "description": "A Text asset.", + "id": "GoogleAdsSearchads360V0Common__TextAsset", + "properties": { + "text": { + "description": "Text content of the text asset.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Common__TextLabel": { "description": "A type of label displaying text on a colored background.", "id": "GoogleAdsSearchads360V0Common__TextLabel", @@ -1931,16 +2470,31 @@ }, "type": "object" }, - "GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement": { - "description": "A part of a field path.", - "id": "GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement", + "GoogleAdsSearchads360V0Common__YoutubeVideoAsset": { + "description": "A YouTube asset.", + "id": "GoogleAdsSearchads360V0Common__YoutubeVideoAsset", "properties": { - "fieldName": { - "description": "The name of a field or a oneof", + "youtubeVideoId": { + "description": "YouTube video id. This is the 11 character string value used in the YouTube video URL.", "type": "string" }, - "index": { - "description": "If field_name is a repeated field, this is the element that failed", + "youtubeVideoTitle": { + "description": "YouTube video title.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement": { + "description": "A part of a field path.", + "id": "GoogleAdsSearchads360V0Errors_ErrorLocation_FieldPathElement", + "properties": { + "fieldName": { + "description": "The name of a field or a oneof", + "type": "string" + }, + "index": { + "description": "If field_name is a repeated field, this is the element that failed", "format": "int32", "type": "integer" } @@ -2292,7 +2846,7 @@ "type": "string" }, "quotaError": { - "description": "An error with the amonut of quota remaining.", + "description": "An error with the amount of quota remaining.", "enum": [ "UNSPECIFIED", "UNKNOWN", @@ -2787,6 +3341,176 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBiddingCategory": { + "description": "One element of a bidding category at a certain level. Top-level categories are at level 1, their children at level 2, and so on. We currently support up to 5 levels. The user must specify a dimension type that indicates the level of the category. All cases of the same subdivision must have the same dimension type (category level).", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBiddingCategory", + "properties": { + "id": { + "description": "ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436", + "format": "int64", + "type": "string" + }, + "level": { + "description": "Indicates the level of the category in the taxonomy.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "LEVEL1", + "LEVEL2", + "LEVEL3", + "LEVEL4", + "LEVEL5" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Level 1.", + "Level 2.", + "Level 3.", + "Level 4.", + "Level 5." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBrand": { + "description": "Brand of the product.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBrand", + "properties": { + "value": { + "description": "String value of the product brand.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductChannel": { + "description": "Locality of a product offer.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductChannel", + "properties": { + "channel": { + "description": "Value of the locality.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ONLINE", + "LOCAL" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The item is sold online.", + "The item is sold in local stores." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCondition": { + "description": "Condition of a product offer.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCondition", + "properties": { + "condition": { + "description": "Value of the condition.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "NEW", + "REFURBISHED", + "USED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The product condition is new.", + "The product condition is refurbished.", + "The product condition is used." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCustomAttribute": { + "description": "Custom attribute of a product offer.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCustomAttribute", + "properties": { + "index": { + "description": "Indicates the index of the custom attribute.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "INDEX0", + "INDEX1", + "INDEX2", + "INDEX3", + "INDEX4" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "First listing group filter custom attribute.", + "Second listing group filter custom attribute.", + "Third listing group filter custom attribute.", + "Fourth listing group filter custom attribute.", + "Fifth listing group filter custom attribute." + ], + "type": "string" + }, + "value": { + "description": "String value of the product custom attribute.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductItemId": { + "description": "Item id of a product offer.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductItemId", + "properties": { + "value": { + "description": "Value of the id.", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductType": { + "description": "Type of a product offer.", + "id": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductType", + "properties": { + "level": { + "description": "Level of the type.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "LEVEL1", + "LEVEL2", + "LEVEL3", + "LEVEL4", + "LEVEL5" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Level 1.", + "Level 2.", + "Level 3.", + "Level 4.", + "Level 5." + ], + "type": "string" + }, + "value": { + "description": "Value of the type.", + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__Ad": { "description": "An ad.", "id": "GoogleAdsSearchads360V0Resources__Ad", @@ -3713,6 +4437,10 @@ "description": "Output only. A unified call asset.", "readOnly": true }, + "callToActionAsset": { + "$ref": "GoogleAdsSearchads360V0Common__CallToActionAsset", + "description": "Immutable. A call to action asset." + }, "calloutAsset": { "$ref": "GoogleAdsSearchads360V0Common__UnifiedCalloutAsset", "description": "Output only. A unified callout asset.", @@ -3759,6 +4487,11 @@ "readOnly": true, "type": "string" }, + "imageAsset": { + "$ref": "GoogleAdsSearchads360V0Common__ImageAsset", + "description": "Output only. An image asset.", + "readOnly": true + }, "lastModifiedTime": { "description": "Output only. The datetime when this asset was last modified. The datetime is in the customer's time zone and in \"yyyy-MM-dd HH:mm:ss.ssssss\" format.", "readOnly": true, @@ -3773,6 +4506,10 @@ "$ref": "GoogleAdsSearchads360V0Common__MobileAppAsset", "description": "A mobile app asset." }, + "name": { + "description": "Optional name of the asset.", + "type": "string" + }, "pageFeedAsset": { "$ref": "GoogleAdsSearchads360V0Common__UnifiedPageFeedAsset", "description": "Output only. A unified page feed asset.", @@ -3808,6 +4545,11 @@ "readOnly": true, "type": "string" }, + "textAsset": { + "$ref": "GoogleAdsSearchads360V0Common__TextAsset", + "description": "Output only. A text asset.", + "readOnly": true + }, "trackingUrlTemplate": { "description": "URL template for constructing a tracking URL.", "type": "string" @@ -3878,131 +4620,473 @@ ], "readOnly": true, "type": "string" + }, + "youtubeVideoAsset": { + "$ref": "GoogleAdsSearchads360V0Common__YoutubeVideoAsset", + "description": "Immutable. A YouTube video asset." } }, "type": "object" }, - "GoogleAdsSearchads360V0Resources__AssetSet": { - "description": "An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.", - "id": "GoogleAdsSearchads360V0Resources__AssetSet", + "GoogleAdsSearchads360V0Resources__AssetGroup": { + "description": "An asset group. AssetGroupAsset is used to link an asset to the asset group. AssetGroupSignal is used to associate a signal to an asset group.", + "id": "GoogleAdsSearchads360V0Resources__AssetGroup", "properties": { + "adStrength": { + "description": "Output only. Overall ad strength of this asset group.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "PENDING", + "NO_ADS", + "POOR", + "AVERAGE", + "GOOD", + "EXCELLENT" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The ad strength is currently pending.", + "No ads could be generated.", + "Poor strength.", + "Average strength.", + "Good strength.", + "Excellent strength." + ], + "readOnly": true, + "type": "string" + }, + "campaign": { + "description": "Immutable. The campaign with which this asset group is associated. The asset which is linked to the asset group.", + "type": "string" + }, + "finalMobileUrls": { + "description": "A list of final mobile URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.", + "items": { + "type": "string" + }, + "type": "array" + }, + "finalUrls": { + "description": "A list of final URLs after all cross domain redirects. In performance max, by default, the urls are eligible for expansion unless opted out.", + "items": { + "type": "string" + }, + "type": "array" + }, "id": { - "description": "Output only. The ID of the asset set.", + "description": "Output only. The ID of the asset group.", "format": "int64", "readOnly": true, "type": "string" }, - "resourceName": { - "description": "Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`", + "name": { + "description": "Required. Name of the asset group. Required. It must have a minimum length of 1 and maximum length of 128. It must be unique under a campaign.", "type": "string" - } - }, - "type": "object" - }, - "GoogleAdsSearchads360V0Resources__AssetSetAsset": { - "description": "AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.", - "id": "GoogleAdsSearchads360V0Resources__AssetSetAsset", - "properties": { - "asset": { - "description": "Immutable. The asset which this asset set asset is linking to.", + }, + "path1": { + "description": "First part of text that may appear appended to the url displayed in the ad.", "type": "string" }, - "assetSet": { - "description": "Immutable. The asset set which this asset set asset is linking to.", + "path2": { + "description": "Second part of text that may appear appended to the url displayed in the ad. This field can only be set when path1 is set.", "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`", + "description": "Immutable. The resource name of the asset group. Asset group resource names have the form: `customers/{customer_id}/assetGroups/{asset_group_id}`", "type": "string" }, "status": { - "description": "Output only. The status of the asset set asset. Read-only.", + "description": "The status of the asset group.", "enum": [ "UNSPECIFIED", "UNKNOWN", "ENABLED", + "PAUSED", "REMOVED" ], "enumDescriptions": [ "The status has not been specified.", - "The received value is not known in this version. This is a response-only value.", - "The asset set asset is enabled.", - "The asset set asset is removed." + "The received value is not known in this version.", + "The asset group is enabled.", + "The asset group is paused.", + "The asset group is removed." ], - "readOnly": true, "type": "string" } }, "type": "object" }, - "GoogleAdsSearchads360V0Resources__BiddingStrategy": { - "description": "A bidding strategy.", - "id": "GoogleAdsSearchads360V0Resources__BiddingStrategy", + "GoogleAdsSearchads360V0Resources__AssetGroupAsset": { + "description": "AssetGroupAsset is the link between an asset and an asset group. Adding an AssetGroupAsset links an asset with an asset group.", + "id": "GoogleAdsSearchads360V0Resources__AssetGroupAsset", "properties": { - "campaignCount": { - "description": "Output only. The number of campaigns attached to this bidding strategy. This field is read-only.", - "format": "int64", - "readOnly": true, - "type": "string" - }, - "currencyCode": { - "description": "Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.", - "type": "string" - }, - "effectiveCurrencyCode": { - "description": "Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.", - "readOnly": true, - "type": "string" - }, - "enhancedCpc": { - "$ref": "GoogleAdsSearchads360V0Common__EnhancedCpc", - "description": "A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely." - }, - "id": { - "description": "Output only. The ID of the bidding strategy.", - "format": "int64", - "readOnly": true, + "asset": { + "description": "Immutable. The asset which this asset group asset is linking.", "type": "string" }, - "maximizeConversionValue": { - "$ref": "GoogleAdsSearchads360V0Common__MaximizeConversionValue", - "description": "An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget." - }, - "maximizeConversions": { - "$ref": "GoogleAdsSearchads360V0Common__MaximizeConversions", - "description": "An automated bidding strategy to help get the most conversions for your campaigns while spending your budget." - }, - "name": { - "description": "The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).", + "assetGroup": { + "description": "Immutable. The asset group which this asset group asset is linking.", "type": "string" }, - "nonRemovedCampaignCount": { - "description": "Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.", - "format": "int64", - "readOnly": true, + "fieldType": { + "description": "The description of the placement of the asset within the asset group. For example: HEADLINE, YOUTUBE_VIDEO etc", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "HEADLINE", + "DESCRIPTION", + "MANDATORY_AD_TEXT", + "MARKETING_IMAGE", + "MEDIA_BUNDLE", + "YOUTUBE_VIDEO", + "BOOK_ON_GOOGLE", + "LEAD_FORM", + "PROMOTION", + "CALLOUT", + "STRUCTURED_SNIPPET", + "SITELINK", + "MOBILE_APP", + "HOTEL_CALLOUT", + "CALL", + "PRICE", + "LONG_HEADLINE", + "BUSINESS_NAME", + "SQUARE_MARKETING_IMAGE", + "PORTRAIT_MARKETING_IMAGE", + "LOGO", + "LANDSCAPE_LOGO", + "VIDEO", + "CALL_TO_ACTION_SELECTION", + "AD_IMAGE", + "BUSINESS_LOGO", + "HOTEL_PROPERTY" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The asset is linked for use as a headline.", + "The asset is linked for use as a description.", + "The asset is linked for use as mandatory ad text.", + "The asset is linked for use as a marketing image.", + "The asset is linked for use as a media bundle.", + "The asset is linked for use as a YouTube video.", + "The asset is linked to indicate that a hotels campaign is \"Book on Google\" enabled.", + "The asset is linked for use as a Lead Form extension.", + "The asset is linked for use as a Promotion extension.", + "The asset is linked for use as a Callout extension.", + "The asset is linked for use as a Structured Snippet extension.", + "The asset is linked for use as a Sitelink.", + "The asset is linked for use as a Mobile App extension.", + "The asset is linked for use as a Hotel Callout extension.", + "The asset is linked for use as a Call extension.", + "The asset is linked for use as a Price extension.", + "The asset is linked for use as a long headline.", + "The asset is linked for use as a business name.", + "The asset is linked for use as a square marketing image.", + "The asset is linked for use as a portrait marketing image.", + "The asset is linked for use as a logo.", + "The asset is linked for use as a landscape logo.", + "The asset is linked for use as a non YouTube logo.", + "The asset is linked for use to select a call-to-action.", + "The asset is linked for use to select an ad image.", + "The asset is linked for use as a business logo.", + "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign." + ], "type": "string" }, "resourceName": { - "description": "Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`", + "description": "Immutable. The resource name of the asset group asset. Asset group asset resource name have the form: `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~{field_type}`", "type": "string" }, "status": { - "description": "Output only. The status of the bidding strategy. This field is read-only.", + "description": "The status of the link between an asset and asset group.", "enum": [ "UNSPECIFIED", "UNKNOWN", "ENABLED", - "REMOVED" + "REMOVED", + "PAUSED" ], "enumDescriptions": [ - "No value has been specified.", - "The received value is not known in this version. This is a response-only value.", - "The bidding strategy is enabled.", - "The bidding strategy is removed." + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Asset link is enabled.", + "Asset link has been removed.", + "Asset link is paused." ], - "readOnly": true, "type": "string" - }, + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData": { + "description": "Asset group asset combination data", + "id": "GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData", + "properties": { + "assetCombinationServedAssets": { + "description": "Output only. Served assets.", + "items": { + "$ref": "GoogleAdsSearchads360V0Common__AssetUsage" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter": { + "description": "AssetGroupListingGroupFilter represents a listing group filter tree node in an asset group.", + "id": "GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter", + "properties": { + "assetGroup": { + "description": "Immutable. The asset group which this asset group listing group filter is part of.", + "type": "string" + }, + "caseValue": { + "$ref": "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension", + "description": "Dimension value with which this listing group is refining its parent. Undefined for the root group." + }, + "id": { + "description": "Output only. The ID of the ListingGroupFilter.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "parentListingGroupFilter": { + "description": "Immutable. Resource name of the parent listing group subdivision. Null for the root listing group filter node.", + "type": "string" + }, + "path": { + "$ref": "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath", + "description": "Output only. The path of dimensions defining this listing group filter.", + "readOnly": true + }, + "resourceName": { + "description": "Immutable. The resource name of the asset group listing group filter. Asset group listing group filter resource name have the form: `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id}~{listing_group_filter_id}`", + "type": "string" + }, + "type": { + "description": "Immutable. Type of a listing group filter node.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "SUBDIVISION", + "UNIT_INCLUDED", + "UNIT_EXCLUDED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Subdivision of products along some listing dimensions.", + "An included listing group filter leaf node.", + "An excluded listing group filter leaf node." + ], + "type": "string" + }, + "vertical": { + "description": "Immutable. The vertical the current node tree represents. All nodes in the same tree must belong to the same vertical.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "SHOPPING" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Represents the shopping vertical." + ], + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetGroupSignal": { + "description": "AssetGroupSignal represents a signal in an asset group. The existence of a signal tells the performance max campaign who's most likely to convert. Performance Max uses the signal to look for new people with similar or stronger intent to find conversions across Search, Display, Video, and more.", + "id": "GoogleAdsSearchads360V0Resources__AssetGroupSignal", + "properties": { + "assetGroup": { + "description": "Immutable. The asset group which this asset group signal belongs to.", + "type": "string" + }, + "audience": { + "$ref": "GoogleAdsSearchads360V0Common__AudienceInfo", + "description": "Immutable. The audience signal to be used by the performance max campaign." + }, + "resourceName": { + "description": "Immutable. The resource name of the asset group signal. Asset group signal resource name have the form: `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView": { + "description": "A view on the usage of ad group ad asset combination.", + "id": "GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView", + "properties": { + "assetGroupTopCombinations": { + "description": "Output only. The top combinations of assets that served together.", + "items": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData" + }, + "readOnly": true, + "type": "array" + }, + "resourceName": { + "description": "Output only. The resource name of the asset group top combination view. AssetGroup Top Combination view resource names have the form: `\"customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_id}~{asset_combination_category}\"", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetSet": { + "description": "An asset set representing a collection of assets. Use AssetSetAsset to link an asset to the asset set.", + "id": "GoogleAdsSearchads360V0Resources__AssetSet", + "properties": { + "id": { + "description": "Output only. The ID of the asset set.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the asset set. Asset set resource names have the form: `customers/{customer_id}/assetSets/{asset_set_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__AssetSetAsset": { + "description": "AssetSetAsset is the link between an asset and an asset set. Adding an AssetSetAsset links an asset with an asset set.", + "id": "GoogleAdsSearchads360V0Resources__AssetSetAsset", + "properties": { + "asset": { + "description": "Immutable. The asset which this asset set asset is linking to.", + "type": "string" + }, + "assetSet": { + "description": "Immutable. The asset set which this asset set asset is linking to.", + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the asset set asset. Asset set asset resource names have the form: `customers/{customer_id}/assetSetAssets/{asset_set_id}~{asset_id}`", + "type": "string" + }, + "status": { + "description": "Output only. The status of the asset set asset. Read-only.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ENABLED", + "REMOVED" + ], + "enumDescriptions": [ + "The status has not been specified.", + "The received value is not known in this version. This is a response-only value.", + "The asset set asset is enabled.", + "The asset set asset is removed." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__Audience": { + "description": "Audience is an effective targeting option that lets you intersect different segment attributes, such as detailed demographics and affinities, to create audiences that represent sections of your target segments.", + "id": "GoogleAdsSearchads360V0Resources__Audience", + "properties": { + "description": { + "description": "Description of this audience.", + "type": "string" + }, + "id": { + "description": "Output only. ID of the audience.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Required. Name of the audience. It should be unique across all audiences. It must have a minimum length of 1 and maximum length of 255.", + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the audience. Audience names have the form: `customers/{customer_id}/audiences/{audience_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__BiddingStrategy": { + "description": "A bidding strategy.", + "id": "GoogleAdsSearchads360V0Resources__BiddingStrategy", + "properties": { + "campaignCount": { + "description": "Output only. The number of campaigns attached to this bidding strategy. This field is read-only.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "currencyCode": { + "description": "Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effective_currency_code field returns the currency used by the strategy.", + "type": "string" + }, + "effectiveCurrencyCode": { + "description": "Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currency_code. Bidding strategy metrics are reported in this currency. This field is read-only.", + "readOnly": true, + "type": "string" + }, + "enhancedCpc": { + "$ref": "GoogleAdsSearchads360V0Common__EnhancedCpc", + "description": "A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely." + }, + "id": { + "description": "Output only. The ID of the bidding strategy.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "maximizeConversionValue": { + "$ref": "GoogleAdsSearchads360V0Common__MaximizeConversionValue", + "description": "An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget." + }, + "maximizeConversions": { + "$ref": "GoogleAdsSearchads360V0Common__MaximizeConversions", + "description": "An automated bidding strategy to help get the most conversions for your campaigns while spending your budget." + }, + "name": { + "description": "The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).", + "type": "string" + }, + "nonRemovedCampaignCount": { + "description": "Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customer_id}/biddingStrategies/{bidding_strategy_id}`", + "type": "string" + }, + "status": { + "description": "Output only. The status of the bidding strategy. This field is read-only.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ENABLED", + "REMOVED" + ], + "enumDescriptions": [ + "No value has been specified.", + "The received value is not known in this version. This is a response-only value.", + "The bidding strategy is enabled.", + "The bidding strategy is removed." + ], + "readOnly": true, + "type": "string" + }, "targetCpa": { "$ref": "GoogleAdsSearchads360V0Common__TargetCpa", "description": "A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set." @@ -4694,7 +5778,7 @@ "Used for return value only. Represents value unknown in this version.", "Daily budget.", "Fixed daily budget.", - "Custom budget, added back in V5. Custom bugdet can be used with total_amount to specify lifetime budget limit." + "Custom budget can be used with total_amount to specify lifetime budget limit." ], "type": "string" }, @@ -4871,31 +5955,277 @@ "readOnly": true, "type": "string" }, - "userList": { - "$ref": "GoogleAdsSearchads360V0Common__UserListInfo", - "description": "Immutable. User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options." + "userList": { + "$ref": "GoogleAdsSearchads360V0Common__UserListInfo", + "description": "Immutable. User List. The Similar Audiences sunset starts May 2023. Refer to https://ads-developers.googleblog.com/2022/11/announcing-deprecation-and-sunset-of.html for other options." + }, + "webpage": { + "$ref": "GoogleAdsSearchads360V0Common__WebpageInfo", + "description": "Immutable. Webpage." + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__CampaignLabel": { + "description": "Represents a relationship between a campaign and a label.", + "id": "GoogleAdsSearchads360V0Resources__CampaignLabel", + "properties": { + "campaign": { + "description": "Immutable. The campaign to which the label is attached.", + "type": "string" + }, + "label": { + "description": "Immutable. The label assigned to the campaign.", + "type": "string" + }, + "resourceName": { + "description": "Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__CartDataSalesView": { + "description": "Cart data sales view.", + "id": "GoogleAdsSearchads360V0Resources__CartDataSalesView", + "properties": { + "resourceName": { + "description": "Output only. The resource name of the Cart data sales view. Cart data sales view resource names have the form: `customers/{customer_id}/cartDataSalesView`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__Conversion": { + "description": "A conversion.", + "id": "GoogleAdsSearchads360V0Resources__Conversion", + "properties": { + "adId": { + "description": "Output only. Ad ID. A value of 0 indicates that the ad is unattributed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "advertiserConversionId": { + "description": "Output only. For offline conversions, this is an ID provided by advertisers. If an advertiser doesn't specify such an ID, Search Ads 360 generates one. For online conversions, this is equal to the id column or the floodlight_order_id column depending on the advertiser's Floodlight instructions.", + "readOnly": true, + "type": "string" + }, + "assetFieldType": { + "description": "Output only. Asset field type of the conversion event.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "HEADLINE", + "DESCRIPTION", + "MANDATORY_AD_TEXT", + "MARKETING_IMAGE", + "MEDIA_BUNDLE", + "YOUTUBE_VIDEO", + "BOOK_ON_GOOGLE", + "LEAD_FORM", + "PROMOTION", + "CALLOUT", + "STRUCTURED_SNIPPET", + "SITELINK", + "MOBILE_APP", + "HOTEL_CALLOUT", + "CALL", + "PRICE", + "LONG_HEADLINE", + "BUSINESS_NAME", + "SQUARE_MARKETING_IMAGE", + "PORTRAIT_MARKETING_IMAGE", + "LOGO", + "LANDSCAPE_LOGO", + "VIDEO", + "CALL_TO_ACTION_SELECTION", + "AD_IMAGE", + "BUSINESS_LOGO", + "HOTEL_PROPERTY" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The asset is linked for use as a headline.", + "The asset is linked for use as a description.", + "The asset is linked for use as mandatory ad text.", + "The asset is linked for use as a marketing image.", + "The asset is linked for use as a media bundle.", + "The asset is linked for use as a YouTube video.", + "The asset is linked to indicate that a hotels campaign is \"Book on Google\" enabled.", + "The asset is linked for use as a Lead Form extension.", + "The asset is linked for use as a Promotion extension.", + "The asset is linked for use as a Callout extension.", + "The asset is linked for use as a Structured Snippet extension.", + "The asset is linked for use as a Sitelink.", + "The asset is linked for use as a Mobile App extension.", + "The asset is linked for use as a Hotel Callout extension.", + "The asset is linked for use as a Call extension.", + "The asset is linked for use as a Price extension.", + "The asset is linked for use as a long headline.", + "The asset is linked for use as a business name.", + "The asset is linked for use as a square marketing image.", + "The asset is linked for use as a portrait marketing image.", + "The asset is linked for use as a logo.", + "The asset is linked for use as a landscape logo.", + "The asset is linked for use as a non YouTube logo.", + "The asset is linked for use to select a call-to-action.", + "The asset is linked for use to select an ad image.", + "The asset is linked for use as a business logo.", + "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign." + ], + "readOnly": true, + "type": "string" + }, + "assetId": { + "description": "Output only. ID of the asset which was interacted with during the conversion event.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "attributionType": { + "description": "Output only. What the conversion is attributed to: Visit or Keyword+Ad.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "VISIT", + "CRITERION_AD" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The conversion is attributed to a visit.", + "The conversion is attributed to a criterion and ad pair." + ], + "readOnly": true, + "type": "string" + }, + "clickId": { + "description": "Output only. A unique string, for the visit that the conversion is attributed to, that is passed to the landing page as the click id URL parameter.", + "readOnly": true, + "type": "string" + }, + "conversionDateTime": { + "description": "Output only. The timestamp of the conversion event.", + "readOnly": true, + "type": "string" + }, + "conversionLastModifiedDateTime": { + "description": "Output only. The timestamp of the last time the conversion was modified.", + "readOnly": true, + "type": "string" + }, + "conversionQuantity": { + "description": "Output only. The quantity of items recorded by the conversion, as determined by the qty url parameter. The advertiser is responsible for dynamically populating the parameter (such as number of items sold in the conversion), otherwise it defaults to 1.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "conversionRevenueMicros": { + "description": "Output only. The adjusted revenue in micros for the conversion event. This will always be in the currency of the serving account.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "conversionVisitDateTime": { + "description": "Output only. The timestamp of the visit that the conversion is attributed to.", + "readOnly": true, + "type": "string" + }, + "criterionId": { + "description": "Output only. Search Ads 360 criterion ID. A value of 0 indicates that the criterion is unattributed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "floodlightOrderId": { + "description": "Output only. The Floodlight order ID provided by the advertiser for the conversion.", + "readOnly": true, + "type": "string" + }, + "floodlightOriginalRevenue": { + "description": "Output only. The original, unchanged revenue associated with the Floodlight event (in the currency of the current report), before Floodlight currency instruction modifications.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. The ID of the conversion", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "merchantId": { + "description": "Output only. The SearchAds360 inventory account ID containing the product that was clicked on. SearchAds360 generates this ID when you link an inventory account in SearchAds360.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "productChannel": { + "description": "Output only. The sales channel of the product that was clicked on: Online or Local.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ONLINE", + "LOCAL" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The item is sold online.", + "The item is sold in local stores." + ], + "readOnly": true, + "type": "string" + }, + "productCountryCode": { + "description": "Output only. The country (ISO-3166-format) registered for the inventory feed that contains the product clicked on.", + "readOnly": true, + "type": "string" }, - "webpage": { - "$ref": "GoogleAdsSearchads360V0Common__WebpageInfo", - "description": "Immutable. Webpage." - } - }, - "type": "object" - }, - "GoogleAdsSearchads360V0Resources__CampaignLabel": { - "description": "Represents a relationship between a campaign and a label.", - "id": "GoogleAdsSearchads360V0Resources__CampaignLabel", - "properties": { - "campaign": { - "description": "Immutable. The campaign to which the label is attached.", + "productId": { + "description": "Output only. The ID of the product clicked on.", + "readOnly": true, "type": "string" }, - "label": { - "description": "Immutable. The label assigned to the campaign.", + "productLanguageCode": { + "description": "Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.", + "readOnly": true, + "type": "string" + }, + "productStoreId": { + "description": "Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.", + "readOnly": true, "type": "string" }, "resourceName": { - "description": "Immutable. Name of the resource. Campaign label resource names have the form: `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}`", + "description": "Output only. The resource name of the conversion. Conversion resource names have the form: `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_conversion_id}`", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. The status of the conversion, either ENABLED or REMOVED..", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ENABLED", + "REMOVED" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The conversion is enabled.", + "The conversion has been removed." + ], + "readOnly": true, + "type": "string" + }, + "visitId": { + "description": "Output only. The SearchAds360 visit ID that the conversion is attributed to.", + "format": "int64", + "readOnly": true, "type": "string" } }, @@ -5777,6 +7107,89 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__LanguageConstant": { + "description": "A language.", + "id": "GoogleAdsSearchads360V0Resources__LanguageConstant", + "properties": { + "code": { + "description": "Output only. The language code, for example, \"en_US\", \"en_AU\", \"es\", \"fr\", etc.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. The ID of the language constant.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Output only. The full name of the language in English, for example, \"English (US)\", \"Spanish\", etc.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Output only. The resource name of the language constant. Language constant resource names have the form: `languageConstants/{criterion_id}`", + "readOnly": true, + "type": "string" + }, + "targetable": { + "description": "Output only. Whether the language is targetable.", + "readOnly": true, + "type": "boolean" + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension": { + "description": "Listing dimensions for the asset group listing group filter.", + "id": "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension", + "properties": { + "productBiddingCategory": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBiddingCategory", + "description": "Bidding category of a product offer." + }, + "productBrand": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductBrand", + "description": "Brand of a product offer." + }, + "productChannel": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductChannel", + "description": "Locality of a product offer." + }, + "productCondition": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCondition", + "description": "Condition of a product offer." + }, + "productCustomAttribute": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductCustomAttribute", + "description": "Custom attribute of a product offer." + }, + "productItemId": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductItemId", + "description": "Item id of a product offer." + }, + "productType": { + "$ref": "GoogleAdsSearchads360V0Resources_ListingGroupFilterDimension_ProductType", + "description": "Type of a product offer." + } + }, + "type": "object" + }, + "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath": { + "description": "The path defining of dimensions defining a listing group filter.", + "id": "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath", + "properties": { + "dimensions": { + "description": "Output only. The complete path of dimensions through the listing group filter hierarchy (excluding the root node) to this listing group filter.", + "items": { + "$ref": "GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__LocationView": { "description": "A location view summarizes the performance of campaigns by Location criteria.", "id": "GoogleAdsSearchads360V0Resources__LocationView", @@ -5789,6 +7202,84 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant": { + "description": "A Product Bidding Category.", + "id": "GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant", + "properties": { + "countryCode": { + "description": "Output only. Two-letter upper-case country code of the product bidding category.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. ID of the product bidding category. This ID is equivalent to the google_product_category ID as described in this article: https://support.google.com/merchants/answer/6324436.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "languageCode": { + "description": "Output only. Language code of the product bidding category.", + "readOnly": true, + "type": "string" + }, + "level": { + "description": "Output only. Level of the product bidding category.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "LEVEL1", + "LEVEL2", + "LEVEL3", + "LEVEL4", + "LEVEL5" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "Level 1.", + "Level 2.", + "Level 3.", + "Level 4.", + "Level 5." + ], + "readOnly": true, + "type": "string" + }, + "localizedName": { + "description": "Output only. Display value of the product bidding category localized according to language_code.", + "readOnly": true, + "type": "string" + }, + "productBiddingCategoryConstantParent": { + "description": "Output only. Resource name of the parent product bidding category.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Output only. The resource name of the product bidding category. Product bidding category resource names have the form: `productBiddingCategoryConstants/{country_code}~{level}~{id}`", + "readOnly": true, + "type": "string" + }, + "status": { + "description": "Output only. Status of the product bidding category.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ACTIVE", + "OBSOLETE" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The category is active and can be used for bidding.", + "The category is obsolete. Used only for reporting purposes." + ], + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__ProductGroupView": { "description": "A product group view.", "id": "GoogleAdsSearchads360V0Resources__ProductGroupView", @@ -5939,6 +7430,18 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__ShoppingPerformanceView": { + "description": "Shopping performance view. Provides Shopping campaign statistics aggregated at several product dimension levels. Product dimension values from Merchant Center such as brand, category, custom attributes, product condition and product type will reflect the state of each dimension as of the date and time when the corresponding event was recorded.", + "id": "GoogleAdsSearchads360V0Resources__ShoppingPerformanceView", + "properties": { + "resourceName": { + "description": "Output only. The resource name of the Shopping performance view. Shopping performance view resource names have the form: `customers/{customer_id}/shoppingPerformanceView`", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__UserList": { "description": "A user list. This is a list of users a customer may target.", "id": "GoogleAdsSearchads360V0Resources__UserList", @@ -5985,6 +7488,162 @@ }, "type": "object" }, + "GoogleAdsSearchads360V0Resources__Visit": { + "description": "A visit.", + "id": "GoogleAdsSearchads360V0Resources__Visit", + "properties": { + "adId": { + "description": "Output only. Ad ID. A value of 0 indicates that the ad is unattributed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "assetFieldType": { + "description": "Output only. Asset field type of the visit event.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "HEADLINE", + "DESCRIPTION", + "MANDATORY_AD_TEXT", + "MARKETING_IMAGE", + "MEDIA_BUNDLE", + "YOUTUBE_VIDEO", + "BOOK_ON_GOOGLE", + "LEAD_FORM", + "PROMOTION", + "CALLOUT", + "STRUCTURED_SNIPPET", + "SITELINK", + "MOBILE_APP", + "HOTEL_CALLOUT", + "CALL", + "PRICE", + "LONG_HEADLINE", + "BUSINESS_NAME", + "SQUARE_MARKETING_IMAGE", + "PORTRAIT_MARKETING_IMAGE", + "LOGO", + "LANDSCAPE_LOGO", + "VIDEO", + "CALL_TO_ACTION_SELECTION", + "AD_IMAGE", + "BUSINESS_LOGO", + "HOTEL_PROPERTY" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The asset is linked for use as a headline.", + "The asset is linked for use as a description.", + "The asset is linked for use as mandatory ad text.", + "The asset is linked for use as a marketing image.", + "The asset is linked for use as a media bundle.", + "The asset is linked for use as a YouTube video.", + "The asset is linked to indicate that a hotels campaign is \"Book on Google\" enabled.", + "The asset is linked for use as a Lead Form extension.", + "The asset is linked for use as a Promotion extension.", + "The asset is linked for use as a Callout extension.", + "The asset is linked for use as a Structured Snippet extension.", + "The asset is linked for use as a Sitelink.", + "The asset is linked for use as a Mobile App extension.", + "The asset is linked for use as a Hotel Callout extension.", + "The asset is linked for use as a Call extension.", + "The asset is linked for use as a Price extension.", + "The asset is linked for use as a long headline.", + "The asset is linked for use as a business name.", + "The asset is linked for use as a square marketing image.", + "The asset is linked for use as a portrait marketing image.", + "The asset is linked for use as a logo.", + "The asset is linked for use as a landscape logo.", + "The asset is linked for use as a non YouTube logo.", + "The asset is linked for use to select a call-to-action.", + "The asset is linked for use to select an ad image.", + "The asset is linked for use as a business logo.", + "The asset is linked for use as a hotel property in a Performance Max for travel goals campaign." + ], + "readOnly": true, + "type": "string" + }, + "assetId": { + "description": "Output only. ID of the asset which was interacted with during the visit event.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "clickId": { + "description": "Output only. A unique string for each visit that is passed to the landing page as the click id URL parameter.", + "readOnly": true, + "type": "string" + }, + "criterionId": { + "description": "Output only. Search Ads 360 keyword ID. A value of 0 indicates that the keyword is unattributed.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "Output only. The ID of the visit.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "merchantId": { + "description": "Output only. The Search Ads 360 inventory account ID containing the product that was clicked on. Search Ads 360 generates this ID when you link an inventory account in Search Ads 360.", + "format": "int64", + "readOnly": true, + "type": "string" + }, + "productChannel": { + "description": "Output only. The sales channel of the product that was clicked on: Online or Local.", + "enum": [ + "UNSPECIFIED", + "UNKNOWN", + "ONLINE", + "LOCAL" + ], + "enumDescriptions": [ + "Not specified.", + "Used for return value only. Represents value unknown in this version.", + "The item is sold online.", + "The item is sold in local stores." + ], + "readOnly": true, + "type": "string" + }, + "productCountryCode": { + "description": "Output only. The country (ISO-3166 format) registered for the inventory feed that contains the product clicked on.", + "readOnly": true, + "type": "string" + }, + "productId": { + "description": "Output only. The ID of the product clicked on.", + "readOnly": true, + "type": "string" + }, + "productLanguageCode": { + "description": "Output only. The language (ISO-639-1) that has been set for the Merchant Center feed containing data about the product.", + "readOnly": true, + "type": "string" + }, + "productStoreId": { + "description": "Output only. The store in the Local Inventory Ad that was clicked on. This should match the store IDs used in your local products feed.", + "readOnly": true, + "type": "string" + }, + "resourceName": { + "description": "Output only. The resource name of the visit. Visit resource names have the form: `customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit_id}`", + "readOnly": true, + "type": "string" + }, + "visitDateTime": { + "description": "Output only. The timestamp of the visit event. The timestamp is in the customer's time zone and in \"yyyy-MM-dd HH:mm:ss\" format.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "GoogleAdsSearchads360V0Resources__WebpageView": { "description": "A webpage view.", "id": "GoogleAdsSearchads360V0Resources__WebpageView", @@ -6097,6 +7756,26 @@ "$ref": "GoogleAdsSearchads360V0Resources__Asset", "description": "The asset referenced in the query." }, + "assetGroup": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroup", + "description": "The asset group referenced in the query." + }, + "assetGroupAsset": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroupAsset", + "description": "The asset group asset referenced in the query." + }, + "assetGroupListingGroupFilter": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter", + "description": "The asset group listing group filter referenced in the query." + }, + "assetGroupSignal": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroupSignal", + "description": "The asset group signal referenced in the query." + }, + "assetGroupTopCombinationView": { + "$ref": "GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView", + "description": "The asset group top combination view referenced in the query." + }, "assetSet": { "$ref": "GoogleAdsSearchads360V0Resources__AssetSet", "description": "The asset set referenced in the query." @@ -6105,6 +7784,10 @@ "$ref": "GoogleAdsSearchads360V0Resources__AssetSetAsset", "description": "The asset set asset referenced in the query." }, + "audience": { + "$ref": "GoogleAdsSearchads360V0Resources__Audience", + "description": "The Audience referenced in the query." + }, "biddingStrategy": { "$ref": "GoogleAdsSearchads360V0Resources__BiddingStrategy", "description": "The bidding strategy referenced in the query." @@ -6137,6 +7820,14 @@ "$ref": "GoogleAdsSearchads360V0Resources__CampaignLabel", "description": "The campaign label referenced in the query." }, + "cartDataSalesView": { + "$ref": "GoogleAdsSearchads360V0Resources__CartDataSalesView", + "description": "The cart data sales view referenced in the query." + }, + "conversion": { + "$ref": "GoogleAdsSearchads360V0Resources__Conversion", + "description": "The event level conversion referenced in the query." + }, "conversionAction": { "$ref": "GoogleAdsSearchads360V0Resources__ConversionAction", "description": "The conversion action referenced in the query." @@ -6188,6 +7879,10 @@ "$ref": "GoogleAdsSearchads360V0Resources__Label", "description": "The label referenced in the query." }, + "languageConstant": { + "$ref": "GoogleAdsSearchads360V0Resources__LanguageConstant", + "description": "The language constant referenced in the query." + }, "locationView": { "$ref": "GoogleAdsSearchads360V0Resources__LocationView", "description": "The location view referenced in the query." @@ -6196,6 +7891,10 @@ "$ref": "GoogleAdsSearchads360V0Common__Metrics", "description": "The metrics." }, + "productBiddingCategoryConstant": { + "$ref": "GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant", + "description": "The Product Bidding Category referenced in the query." + }, "productGroupView": { "$ref": "GoogleAdsSearchads360V0Resources__ProductGroupView", "description": "The product group view referenced in the query." @@ -6204,10 +7903,18 @@ "$ref": "GoogleAdsSearchads360V0Common__Segments", "description": "The segments." }, + "shoppingPerformanceView": { + "$ref": "GoogleAdsSearchads360V0Resources__ShoppingPerformanceView", + "description": "The shopping performance view referenced in the query." + }, "userList": { "$ref": "GoogleAdsSearchads360V0Resources__UserList", "description": "The user list referenced in the query." }, + "visit": { + "$ref": "GoogleAdsSearchads360V0Resources__Visit", + "description": "The event level visit referenced in the query." + }, "webpageView": { "$ref": "GoogleAdsSearchads360V0Resources__WebpageView", "description": "The webpage view referenced in the query." diff --git a/searchads360/v0/searchads360-gen.go b/searchads360/v0/searchads360-gen.go index 2c2a0cd579e..e95bdff55e6 100644 --- a/searchads360/v0/searchads360-gen.go +++ b/searchads360/v0/searchads360-gen.go @@ -350,6 +350,112 @@ func (s *GoogleAdsSearchads360V0Common__AssetInteractionTarget) MarshalJSON() ([ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Common__AssetUsage: Contains the usage +// information of the asset. +type GoogleAdsSearchads360V0Common__AssetUsage struct { + // Asset: Resource name of the asset. + Asset string `json:"asset,omitempty"` + + // ServedAssetFieldType: The served field type of the asset. + // + // Possible values: + // "UNSPECIFIED" - No value has been specified. + // "UNKNOWN" - The received value is not known in this version. This + // is a response-only value. + // "HEADLINE_1" - The asset is used in headline 1. + // "HEADLINE_2" - The asset is used in headline 2. + // "HEADLINE_3" - The asset is used in headline 3. + // "DESCRIPTION_1" - The asset is used in description 1. + // "DESCRIPTION_2" - The asset is used in description 2. + // "HEADLINE" - The asset was used in a headline. Use this only if + // there is only one headline in the ad. Otherwise, use the HEADLINE_1, + // HEADLINE_2 or HEADLINE_3 enums + // "HEADLINE_IN_PORTRAIT" - The asset was used as a headline in + // portrait image. + // "LONG_HEADLINE" - The asset was used in a long headline (used in + // MultiAssetResponsiveAd). + // "DESCRIPTION" - The asset was used in a description. Use this only + // if there is only one description in the ad. Otherwise, use the + // DESCRIPTION_1 or DESCRIPTION_@ enums + // "DESCRIPTION_IN_PORTRAIT" - The asset was used as description in + // portrait image. + // "BUSINESS_NAME_IN_PORTRAIT" - The asset was used as business name + // in portrait image. + // "BUSINESS_NAME" - The asset was used as business name. + // "MARKETING_IMAGE" - The asset was used as a marketing image. + // "MARKETING_IMAGE_IN_PORTRAIT" - The asset was used as a marketing + // image in portrait image. + // "SQUARE_MARKETING_IMAGE" - The asset was used as a square marketing + // image. + // "PORTRAIT_MARKETING_IMAGE" - The asset was used as a portrait + // marketing image. + // "LOGO" - The asset was used as a logo. + // "LANDSCAPE_LOGO" - The asset was used as a landscape logo. + // "CALL_TO_ACTION" - The asset was used as a call-to-action. + // "YOU_TUBE_VIDEO" - The asset was used as a YouTube video. + // "SITELINK" - This asset is used as a sitelink. + // "CALL" - This asset is used as a call. + // "MOBILE_APP" - This asset is used as a mobile app. + // "CALLOUT" - This asset is used as a callout. + // "STRUCTURED_SNIPPET" - This asset is used as a structured snippet. + // "PRICE" - This asset is used as a price. + // "PROMOTION" - This asset is used as a promotion. + // "AD_IMAGE" - This asset is used as an image. + // "LEAD_FORM" - The asset is used as a lead form. + // "BUSINESS_LOGO" - The asset is used as a business logo. + ServedAssetFieldType string `json:"servedAssetFieldType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Asset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Asset") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__AssetUsage) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__AssetUsage + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Common__AudienceInfo: An audience criterion. +type GoogleAdsSearchads360V0Common__AudienceInfo struct { + // Audience: The Audience resource name. + Audience string `json:"audience,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Audience") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Audience") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__AudienceInfo) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__AudienceInfo + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__BusinessProfileLocation: Business // Profile location data synced from the linked Business Profile // account. @@ -389,6 +495,57 @@ func (s *GoogleAdsSearchads360V0Common__BusinessProfileLocation) MarshalJSON() ( return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Common__CallToActionAsset: A call to action +// asset. +type GoogleAdsSearchads360V0Common__CallToActionAsset struct { + // CallToAction: Call to action. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "LEARN_MORE" - The call to action type is learn more. + // "GET_QUOTE" - The call to action type is get quote. + // "APPLY_NOW" - The call to action type is apply now. + // "SIGN_UP" - The call to action type is sign up. + // "CONTACT_US" - The call to action type is contact us. + // "SUBSCRIBE" - The call to action type is subscribe. + // "DOWNLOAD" - The call to action type is download. + // "BOOK_NOW" - The call to action type is book now. + // "SHOP_NOW" - The call to action type is shop now. + // "BUY_NOW" - The call to action type is buy now. + // "DONATE_NOW" - The call to action type is donate now. + // "ORDER_NOW" - The call to action type is order now. + // "PLAY_NOW" - The call to action type is play now. + // "SEE_MORE" - The call to action type is see more. + // "START_NOW" - The call to action type is start now. + // "VISIT_SITE" - The call to action type is visit site. + // "WATCH_NOW" - The call to action type is watch now. + CallToAction string `json:"callToAction,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CallToAction") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CallToAction") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__CallToActionAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__CallToActionAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__CustomParameter: A mapping that can be // used by custom parameter tags in a `tracking_url_template`, // `final_urls`, or `mobile_final_urls`. @@ -510,6 +667,92 @@ func (s *GoogleAdsSearchads360V0Common__GenderInfo) MarshalJSON() ([]byte, error return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Common__ImageAsset: An Image asset. +type GoogleAdsSearchads360V0Common__ImageAsset struct { + // FileSize: File size of the image asset in bytes. + FileSize int64 `json:"fileSize,omitempty,string"` + + // FullSize: Metadata for this image at its original size. + FullSize *GoogleAdsSearchads360V0Common__ImageDimension `json:"fullSize,omitempty"` + + // MimeType: MIME type of the image asset. + // + // Possible values: + // "UNSPECIFIED" - The mime type has not been specified. + // "UNKNOWN" - The received value is not known in this version. This + // is a response-only value. + // "IMAGE_JPEG" - MIME type of image/jpeg. + // "IMAGE_GIF" - MIME type of image/gif. + // "IMAGE_PNG" - MIME type of image/png. + // "FLASH" - MIME type of application/x-shockwave-flash. + // "TEXT_HTML" - MIME type of text/html. + // "PDF" - MIME type of application/pdf. + // "MSWORD" - MIME type of application/msword. + // "MSEXCEL" - MIME type of application/vnd.ms-excel. + // "RTF" - MIME type of application/rtf. + // "AUDIO_WAV" - MIME type of audio/wav. + // "AUDIO_MP3" - MIME type of audio/mp3. + // "HTML5_AD_ZIP" - MIME type of application/x-html5-ad-zip. + MimeType string `json:"mimeType,omitempty"` + + // ForceSendFields is a list of field names (e.g. "FileSize") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "FileSize") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__ImageAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__ImageAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Common__ImageDimension: Metadata for an image +// at a certain size, either original or resized. +type GoogleAdsSearchads360V0Common__ImageDimension struct { + // HeightPixels: Height of the image. + HeightPixels int64 `json:"heightPixels,omitempty,string"` + + // Url: A URL that returns the image with this height and width. + Url string `json:"url,omitempty"` + + // WidthPixels: Width of the image. + WidthPixels int64 `json:"widthPixels,omitempty,string"` + + // ForceSendFields is a list of field names (e.g. "HeightPixels") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "HeightPixels") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__ImageDimension) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__ImageDimension + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__Keyword: A Keyword criterion segment. type GoogleAdsSearchads360V0Common__Keyword struct { // AdGroupCriterion: The AdGroupCriterion resource name. @@ -994,6 +1237,149 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // optimize for these conversions. ClientAccountConversionsValue float64 `json:"clientAccountConversionsValue,omitempty"` + // ClientAccountCrossSellCostOfGoodsSoldMicros: Client account + // cross-sell cost of goods sold (COGS) is the total cost of products + // sold as a result of advertising a different product. How it works: + // You report conversions with cart data for completed purchases on your + // website. If the ad that was interacted with before the purchase has + // an associated product (see Shopping Ads) then this product is + // considered the advertised product. Any product included in the order + // the customer places is a sold product. If these products don't match + // then this is considered cross-sell. Cross-sell cost of goods sold is + // the total cost of the products sold that weren't advertised. Example: + // Someone clicked on a Shopping ad for a hat then bought the same hat + // and a shirt. The hat has a cost of goods sold value of $3, the shirt + // has a cost of goods sold value of $5. The cross-sell cost of goods + // sold for this order is $5. This metric is only available if you + // report conversions with cart data. This metric is a monetary value + // and returned in the customer's currency by default. See the + // metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountCrossSellCostOfGoodsSoldMicros int64 `json:"clientAccountCrossSellCostOfGoodsSoldMicros,omitempty,string"` + + // ClientAccountCrossSellGrossProfitMicros: Client account cross-sell + // gross profit is the profit you made from products sold as a result of + // advertising a different product, minus cost of goods sold (COGS). How + // it works: You report conversions with cart data for completed + // purchases on your website. If the ad that was interacted with before + // the purchase has an associated product (see Shopping Ads) then this + // product is considered the advertised product. Any product included in + // the purchase is a sold product. If these products don't match then + // this is considered cross-sell. Cross-sell gross profit is the revenue + // you made from cross-sell attributed to your ads minus the cost of the + // goods sold. Example: Someone clicked on a Shopping ad for a hat then + // bought the same hat and a shirt. The shirt is priced $20 and has a + // cost of goods sold value of $5. The cross-sell gross profit of this + // order is $15 = $20 - $5. This metric is only available if you report + // conversions with cart data. This metric is a monetary value and + // returned in the customer's currency by default. See the + // metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountCrossSellGrossProfitMicros int64 `json:"clientAccountCrossSellGrossProfitMicros,omitempty,string"` + + // ClientAccountCrossSellRevenueMicros: Client account cross-sell + // revenue is the total amount you made from products sold as a result + // of advertising a different product. How it works: You report + // conversions with cart data for completed purchases on your website. + // If the ad that was interacted with before the purchase has an + // associated product (see Shopping Ads) then this product is considered + // the advertised product. Any product included in the order the + // customer places is a sold product. If these products don't match then + // this is considered cross-sell. Cross-sell revenue is the total value + // you made from cross-sell attributed to your ads. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat and a + // shirt. The hat is priced $10 and the shirt is priced $20. The + // cross-sell revenue of this order is $20. This metric is only + // available if you report conversions with cart data. This metric is a + // monetary value and returned in the customer's currency by default. + // See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountCrossSellRevenueMicros int64 `json:"clientAccountCrossSellRevenueMicros,omitempty,string"` + + // ClientAccountCrossSellUnitsSold: Client account cross-sell units sold + // is the total number of products sold as a result of advertising a + // different product. How it works: You report conversions with cart + // data for completed purchases on your website. If the ad that was + // interacted with before the purchase has an associated product (see + // Shopping Ads) then this product is considered the advertised product. + // Any product included in the order the customer places is a sold + // product. If these products don't match then this is considered + // cross-sell. Cross-sell units sold is the total number of cross-sold + // products from all orders attributed to your ads. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat, a shirt + // and a jacket. The cross-sell units sold in this order is 2. This + // metric is only available if you report conversions with cart data. + ClientAccountCrossSellUnitsSold float64 `json:"clientAccountCrossSellUnitsSold,omitempty"` + + // ClientAccountLeadCostOfGoodsSoldMicros: Client account lead cost of + // goods sold (COGS) is the total cost of products sold as a result of + // advertising the same product. How it works: You report conversions + // with cart data for completed purchases on your website. If the ad + // that was interacted with has an associated product (see Shopping Ads) + // then this product is considered the advertised product. Any product + // included in the order the customer places is a sold product. If the + // advertised and sold products match, then the cost of these goods is + // counted under lead cost of goods sold. Example: Someone clicked on a + // Shopping ad for a hat then bought the same hat and a shirt. The hat + // has a cost of goods sold value of $3, the shirt has a cost of goods + // sold value of $5. The lead cost of goods sold for this order is $3. + // This metric is only available if you report conversions with cart + // data. This metric is a monetary value and returned in the customer's + // currency by default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountLeadCostOfGoodsSoldMicros int64 `json:"clientAccountLeadCostOfGoodsSoldMicros,omitempty,string"` + + // ClientAccountLeadGrossProfitMicros: Client account lead gross profit + // is the profit you made from products sold as a result of advertising + // the same product, minus cost of goods sold (COGS). How it works: You + // report conversions with cart data for completed purchases on your + // website. If the ad that was interacted with before the purchase has + // an associated product (see Shopping Ads) then this product is + // considered the advertised product. Any product included in the order + // the customer places is a sold product. If the advertised and sold + // products match, then the revenue you made from these sales minus the + // cost of goods sold is your lead gross profit. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat and a + // shirt. The hat is priced $10 and has a cost of goods sold value of + // $3. The lead gross profit of this order is $7 = $10 - $3. This metric + // is only available if you report conversions with cart data. This + // metric is a monetary value and returned in the customer's currency by + // default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountLeadGrossProfitMicros int64 `json:"clientAccountLeadGrossProfitMicros,omitempty,string"` + + // ClientAccountLeadRevenueMicros: Client account lead revenue is the + // total amount you made from products sold as a result of advertising + // the same product. How it works: You report conversions with cart data + // for completed purchases on your website. If the ad that was + // interacted with before the purchase has an associated product (see + // Shopping Ads) then this product is considered the advertised product. + // Any product included in the order the customer places is a sold + // product. If the advertised and sold products match, then the total + // value you made from the sales of these products is shown under lead + // revenue. Example: Someone clicked on a Shopping ad for a hat then + // bought the same hat and a shirt. The hat is priced $10 and the shirt + // is priced $20. The lead revenue of this order is $10. This metric is + // only available if you report conversions with cart data. This metric + // is a monetary value and returned in the customer's currency by + // default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + ClientAccountLeadRevenueMicros int64 `json:"clientAccountLeadRevenueMicros,omitempty,string"` + + // ClientAccountLeadUnitsSold: Client account lead units sold is the + // total number of products sold as a result of advertising the same + // product. How it works: You report conversions with cart data for + // completed purchases on your website. If the ad that was interacted + // with before the purchase has an associated product (see Shopping Ads) + // then this product is considered the advertised product. Any product + // included in the order the customer places is a sold product. If the + // advertised and sold products match, then the total number of these + // products sold is shown under lead units sold. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat, a shirt + // and a jacket. The lead units sold in this order is 1. This metric is + // only available if you report conversions with cart data. + ClientAccountLeadUnitsSold float64 `json:"clientAccountLeadUnitsSold,omitempty"` + // ClientAccountViewThroughConversions: The total number of view-through // conversions. These happen when a customer sees an image or rich media // ad, then later completes a conversion on your site without @@ -1089,6 +1475,77 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // conversions. CrossDeviceConversionsValue float64 `json:"crossDeviceConversionsValue,omitempty"` + // CrossSellCostOfGoodsSoldMicros: Cross-sell cost of goods sold (COGS) + // is the total cost of products sold as a result of advertising a + // different product. How it works: You report conversions with cart + // data for completed purchases on your website. If the ad that was + // interacted with before the purchase has an associated product (see + // Shopping Ads) then this product is considered the advertised product. + // Any product included in the order the customer places is a sold + // product. If these products don't match then this is considered + // cross-sell. Cross-sell cost of goods sold is the total cost of the + // products sold that weren't advertised. Example: Someone clicked on a + // Shopping ad for a hat then bought the same hat and a shirt. The hat + // has a cost of goods sold value of $3, the shirt has a cost of goods + // sold value of $5. The cross-sell cost of goods sold for this order is + // $5. This metric is only available if you report conversions with cart + // data. This metric is a monetary value and returned in the customer's + // currency by default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + CrossSellCostOfGoodsSoldMicros int64 `json:"crossSellCostOfGoodsSoldMicros,omitempty,string"` + + // CrossSellGrossProfitMicros: Cross-sell gross profit is the profit you + // made from products sold as a result of advertising a different + // product, minus cost of goods sold (COGS). How it works: You report + // conversions with cart data for completed purchases on your website. + // If the ad that was interacted with before the purchase has an + // associated product (see Shopping Ads) then this product is considered + // the advertised product. Any product included in the purchase is a + // sold product. If these products don't match then this is considered + // cross-sell. Cross-sell gross profit is the revenue you made from + // cross-sell attributed to your ads minus the cost of the goods sold. + // Example: Someone clicked on a Shopping ad for a hat then bought the + // same hat and a shirt. The shirt is priced $20 and has a cost of goods + // sold value of $5. The cross-sell gross profit of this order is $15 = + // $20 - $5. This metric is only available if you report conversions + // with cart data. This metric is a monetary value and returned in the + // customer's currency by default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + CrossSellGrossProfitMicros int64 `json:"crossSellGrossProfitMicros,omitempty,string"` + + // CrossSellRevenueMicros: Cross-sell revenue is the total amount you + // made from products sold as a result of advertising a different + // product. How it works: You report conversions with cart data for + // completed purchases on your website. If the ad that was interacted + // with before the purchase has an associated product (see Shopping Ads) + // then this product is considered the advertised product. Any product + // included in the order the customer places is a sold product. If these + // products don't match then this is considered cross-sell. Cross-sell + // revenue is the total value you made from cross-sell attributed to + // your ads. Example: Someone clicked on a Shopping ad for a hat then + // bought the same hat and a shirt. The hat is priced $10 and the shirt + // is priced $20. The cross-sell revenue of this order is $20. This + // metric is only available if you report conversions with cart data. + // This metric is a monetary value and returned in the customer's + // currency by default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + CrossSellRevenueMicros int64 `json:"crossSellRevenueMicros,omitempty,string"` + + // CrossSellUnitsSold: Cross-sell units sold is the total number of + // products sold as a result of advertising a different product. How it + // works: You report conversions with cart data for completed purchases + // on your website. If the ad that was interacted with before the + // purchase has an associated product (see Shopping Ads) then this + // product is considered the advertised product. Any product included in + // the order the customer places is a sold product. If these products + // don't match then this is considered cross-sell. Cross-sell units sold + // is the total number of cross-sold products from all orders attributed + // to your ads. Example: Someone clicked on a Shopping ad for a hat then + // bought the same hat, a shirt and a jacket. The cross-sell units sold + // in this order is 2. This metric is only available if you report + // conversions with cart data. + CrossSellUnitsSold float64 `json:"crossSellUnitsSold,omitempty"` + // Ctr: The number of clicks your ad receives (Clicks) divided by the // number of times your ad is shown (Impressions). Ctr float64 `json:"ctr,omitempty"` @@ -1174,6 +1631,75 @@ type GoogleAdsSearchads360V0Common__Metrics struct { // doesn't charge you for. InvalidClicks int64 `json:"invalidClicks,omitempty,string"` + // LeadCostOfGoodsSoldMicros: Lead cost of goods sold (COGS) is the + // total cost of products sold as a result of advertising the same + // product. How it works: You report conversions with cart data for + // completed purchases on your website. If the ad that was interacted + // with has an associated product (see Shopping Ads) then this product + // is considered the advertised product. Any product included in the + // order the customer places is a sold product. If the advertised and + // sold products match, then the cost of these goods is counted under + // lead cost of goods sold. Example: Someone clicked on a Shopping ad + // for a hat then bought the same hat and a shirt. The hat has a cost of + // goods sold value of $3, the shirt has a cost of goods sold value of + // $5. The lead cost of goods sold for this order is $3. This metric is + // only available if you report conversions with cart data. This metric + // is a monetary value and returned in the customer's currency by + // default. See the metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + LeadCostOfGoodsSoldMicros int64 `json:"leadCostOfGoodsSoldMicros,omitempty,string"` + + // LeadGrossProfitMicros: Lead gross profit is the profit you made from + // products sold as a result of advertising the same product, minus cost + // of goods sold (COGS). How it works: You report conversions with cart + // data for completed purchases on your website. If the ad that was + // interacted with before the purchase has an associated product (see + // Shopping Ads) then this product is considered the advertised product. + // Any product included in the order the customer places is a sold + // product. If the advertised and sold products match, then the revenue + // you made from these sales minus the cost of goods sold is your lead + // gross profit. Example: Someone clicked on a Shopping ad for a hat + // then bought the same hat and a shirt. The hat is priced $10 and has a + // cost of goods sold value of $3. The lead gross profit of this order + // is $7 = $10 - $3. This metric is only available if you report + // conversions with cart data. This metric is a monetary value and + // returned in the customer's currency by default. See the + // metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + LeadGrossProfitMicros int64 `json:"leadGrossProfitMicros,omitempty,string"` + + // LeadRevenueMicros: Lead revenue is the total amount you made from + // products sold as a result of advertising the same product. How it + // works: You report conversions with cart data for completed purchases + // on your website. If the ad that was interacted with before the + // purchase has an associated product (see Shopping Ads) then this + // product is considered the advertised product. Any product included in + // the order the customer places is a sold product. If the advertised + // and sold products match, then the total value you made from the sales + // of these products is shown under lead revenue. Example: Someone + // clicked on a Shopping ad for a hat then bought the same hat and a + // shirt. The hat is priced $10 and the shirt is priced $20. The lead + // revenue of this order is $10. This metric is only available if you + // report conversions with cart data. This metric is a monetary value + // and returned in the customer's currency by default. See the + // metrics_currency parameter at + // https://developers.google.com/search-ads/reporting/query/query-structure#parameters_clause + LeadRevenueMicros int64 `json:"leadRevenueMicros,omitempty,string"` + + // LeadUnitsSold: Lead units sold is the total number of products sold + // as a result of advertising the same product. How it works: You report + // conversions with cart data for completed purchases on your website. + // If the ad that was interacted with before the purchase has an + // associated product (see Shopping Ads) then this product is considered + // the advertised product. Any product included in the order the + // customer places is a sold product. If the advertised and sold + // products match, then the total number of these products sold is shown + // under lead units sold. Example: Someone clicked on a Shopping ad for + // a hat then bought the same hat, a shirt and a jacket. The lead units + // sold in this order is 1. This metric is only available if you report + // conversions with cart data. + LeadUnitsSold float64 `json:"leadUnitsSold,omitempty"` + // MobileFriendlyClicksPercentage: The percentage of mobile clicks that // go to a mobile-friendly page. MobileFriendlyClicksPercentage float64 `json:"mobileFriendlyClicksPercentage,omitempty"` @@ -1332,6 +1858,8 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro AverageCpm gensupport.JSONFloat64 `json:"averageCpm"` ClientAccountConversions gensupport.JSONFloat64 `json:"clientAccountConversions"` ClientAccountConversionsValue gensupport.JSONFloat64 `json:"clientAccountConversionsValue"` + ClientAccountCrossSellUnitsSold gensupport.JSONFloat64 `json:"clientAccountCrossSellUnitsSold"` + ClientAccountLeadUnitsSold gensupport.JSONFloat64 `json:"clientAccountLeadUnitsSold"` ContentBudgetLostImpressionShare gensupport.JSONFloat64 `json:"contentBudgetLostImpressionShare"` ContentImpressionShare gensupport.JSONFloat64 `json:"contentImpressionShare"` ContentRankLostImpressionShare gensupport.JSONFloat64 `json:"contentRankLostImpressionShare"` @@ -1347,9 +1875,11 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro CostPerCurrentModelAttributedConversion gensupport.JSONFloat64 `json:"costPerCurrentModelAttributedConversion"` CrossDeviceConversions gensupport.JSONFloat64 `json:"crossDeviceConversions"` CrossDeviceConversionsValue gensupport.JSONFloat64 `json:"crossDeviceConversionsValue"` + CrossSellUnitsSold gensupport.JSONFloat64 `json:"crossSellUnitsSold"` Ctr gensupport.JSONFloat64 `json:"ctr"` InteractionRate gensupport.JSONFloat64 `json:"interactionRate"` InvalidClickRate gensupport.JSONFloat64 `json:"invalidClickRate"` + LeadUnitsSold gensupport.JSONFloat64 `json:"leadUnitsSold"` MobileFriendlyClicksPercentage gensupport.JSONFloat64 `json:"mobileFriendlyClicksPercentage"` SearchAbsoluteTopImpressionShare gensupport.JSONFloat64 `json:"searchAbsoluteTopImpressionShare"` SearchBudgetLostAbsoluteTopImpressionShare gensupport.JSONFloat64 `json:"searchBudgetLostAbsoluteTopImpressionShare"` @@ -1394,6 +1924,8 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro s.AverageCpm = float64(s1.AverageCpm) s.ClientAccountConversions = float64(s1.ClientAccountConversions) s.ClientAccountConversionsValue = float64(s1.ClientAccountConversionsValue) + s.ClientAccountCrossSellUnitsSold = float64(s1.ClientAccountCrossSellUnitsSold) + s.ClientAccountLeadUnitsSold = float64(s1.ClientAccountLeadUnitsSold) s.ContentBudgetLostImpressionShare = float64(s1.ContentBudgetLostImpressionShare) s.ContentImpressionShare = float64(s1.ContentImpressionShare) s.ContentRankLostImpressionShare = float64(s1.ContentRankLostImpressionShare) @@ -1409,9 +1941,11 @@ func (s *GoogleAdsSearchads360V0Common__Metrics) UnmarshalJSON(data []byte) erro s.CostPerCurrentModelAttributedConversion = float64(s1.CostPerCurrentModelAttributedConversion) s.CrossDeviceConversions = float64(s1.CrossDeviceConversions) s.CrossDeviceConversionsValue = float64(s1.CrossDeviceConversionsValue) + s.CrossSellUnitsSold = float64(s1.CrossSellUnitsSold) s.Ctr = float64(s1.Ctr) s.InteractionRate = float64(s1.InteractionRate) s.InvalidClickRate = float64(s1.InvalidClickRate) + s.LeadUnitsSold = float64(s1.LeadUnitsSold) s.MobileFriendlyClicksPercentage = float64(s1.MobileFriendlyClicksPercentage) s.SearchAbsoluteTopImpressionShare = float64(s1.SearchAbsoluteTopImpressionShare) s.SearchBudgetLostAbsoluteTopImpressionShare = float64(s1.SearchBudgetLostAbsoluteTopImpressionShare) @@ -1833,6 +2367,182 @@ type GoogleAdsSearchads360V0Common__Segments struct { // Formatted as yyyy-MM-dd. Month string `json:"month,omitempty"` + // ProductBiddingCategoryLevel1: Bidding category (level 1) of the + // product. + ProductBiddingCategoryLevel1 string `json:"productBiddingCategoryLevel1,omitempty"` + + // ProductBiddingCategoryLevel2: Bidding category (level 2) of the + // product. + ProductBiddingCategoryLevel2 string `json:"productBiddingCategoryLevel2,omitempty"` + + // ProductBiddingCategoryLevel3: Bidding category (level 3) of the + // product. + ProductBiddingCategoryLevel3 string `json:"productBiddingCategoryLevel3,omitempty"` + + // ProductBiddingCategoryLevel4: Bidding category (level 4) of the + // product. + ProductBiddingCategoryLevel4 string `json:"productBiddingCategoryLevel4,omitempty"` + + // ProductBiddingCategoryLevel5: Bidding category (level 5) of the + // product. + ProductBiddingCategoryLevel5 string `json:"productBiddingCategoryLevel5,omitempty"` + + // ProductBrand: Brand of the product. + ProductBrand string `json:"productBrand,omitempty"` + + // ProductChannel: Channel of the product. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ONLINE" - The item is sold online. + // "LOCAL" - The item is sold in local stores. + ProductChannel string `json:"productChannel,omitempty"` + + // ProductChannelExclusivity: Channel exclusivity of the product. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "SINGLE_CHANNEL" - The item is sold through one channel only, + // either local stores or online as indicated by its ProductChannel. + // "MULTI_CHANNEL" - The item is matched to its online or local stores + // counterpart, indicating it is available for purchase in both + // ShoppingProductChannels. + ProductChannelExclusivity string `json:"productChannelExclusivity,omitempty"` + + // ProductCondition: Condition of the product. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "OLD" - The product condition is old. + // "NEW" - The product condition is new. + // "REFURBISHED" - The product condition is refurbished. + // "USED" - The product condition is used. + ProductCondition string `json:"productCondition,omitempty"` + + // ProductCountry: Resource name of the geo target constant for the + // country of sale of the product. + ProductCountry string `json:"productCountry,omitempty"` + + // ProductCustomAttribute0: Custom attribute 0 of the product. + ProductCustomAttribute0 string `json:"productCustomAttribute0,omitempty"` + + // ProductCustomAttribute1: Custom attribute 1 of the product. + ProductCustomAttribute1 string `json:"productCustomAttribute1,omitempty"` + + // ProductCustomAttribute2: Custom attribute 2 of the product. + ProductCustomAttribute2 string `json:"productCustomAttribute2,omitempty"` + + // ProductCustomAttribute3: Custom attribute 3 of the product. + ProductCustomAttribute3 string `json:"productCustomAttribute3,omitempty"` + + // ProductCustomAttribute4: Custom attribute 4 of the product. + ProductCustomAttribute4 string `json:"productCustomAttribute4,omitempty"` + + // ProductItemId: Item ID of the product. + ProductItemId string `json:"productItemId,omitempty"` + + // ProductLanguage: Resource name of the language constant for the + // language of the product. + ProductLanguage string `json:"productLanguage,omitempty"` + + // ProductSoldBiddingCategoryLevel1: Bidding category (level 1) of the + // product sold. + ProductSoldBiddingCategoryLevel1 string `json:"productSoldBiddingCategoryLevel1,omitempty"` + + // ProductSoldBiddingCategoryLevel2: Bidding category (level 2) of the + // product sold. + ProductSoldBiddingCategoryLevel2 string `json:"productSoldBiddingCategoryLevel2,omitempty"` + + // ProductSoldBiddingCategoryLevel3: Bidding category (level 3) of the + // product sold. + ProductSoldBiddingCategoryLevel3 string `json:"productSoldBiddingCategoryLevel3,omitempty"` + + // ProductSoldBiddingCategoryLevel4: Bidding category (level 4) of the + // product sold. + ProductSoldBiddingCategoryLevel4 string `json:"productSoldBiddingCategoryLevel4,omitempty"` + + // ProductSoldBiddingCategoryLevel5: Bidding category (level 5) of the + // product sold. + ProductSoldBiddingCategoryLevel5 string `json:"productSoldBiddingCategoryLevel5,omitempty"` + + // ProductSoldBrand: Brand of the product sold. + ProductSoldBrand string `json:"productSoldBrand,omitempty"` + + // ProductSoldCondition: Condition of the product sold. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "OLD" - The product condition is old. + // "NEW" - The product condition is new. + // "REFURBISHED" - The product condition is refurbished. + // "USED" - The product condition is used. + ProductSoldCondition string `json:"productSoldCondition,omitempty"` + + // ProductSoldCustomAttribute0: Custom attribute 0 of the product sold. + ProductSoldCustomAttribute0 string `json:"productSoldCustomAttribute0,omitempty"` + + // ProductSoldCustomAttribute1: Custom attribute 1 of the product sold. + ProductSoldCustomAttribute1 string `json:"productSoldCustomAttribute1,omitempty"` + + // ProductSoldCustomAttribute2: Custom attribute 2 of the product sold. + ProductSoldCustomAttribute2 string `json:"productSoldCustomAttribute2,omitempty"` + + // ProductSoldCustomAttribute3: Custom attribute 3 of the product sold. + ProductSoldCustomAttribute3 string `json:"productSoldCustomAttribute3,omitempty"` + + // ProductSoldCustomAttribute4: Custom attribute 4 of the product sold. + ProductSoldCustomAttribute4 string `json:"productSoldCustomAttribute4,omitempty"` + + // ProductSoldItemId: Item ID of the product sold. + ProductSoldItemId string `json:"productSoldItemId,omitempty"` + + // ProductSoldTitle: Title of the product sold. + ProductSoldTitle string `json:"productSoldTitle,omitempty"` + + // ProductSoldTypeL1: Type (level 1) of the product sold. + ProductSoldTypeL1 string `json:"productSoldTypeL1,omitempty"` + + // ProductSoldTypeL2: Type (level 2) of the product sold. + ProductSoldTypeL2 string `json:"productSoldTypeL2,omitempty"` + + // ProductSoldTypeL3: Type (level 3) of the product sold. + ProductSoldTypeL3 string `json:"productSoldTypeL3,omitempty"` + + // ProductSoldTypeL4: Type (level 4) of the product sold. + ProductSoldTypeL4 string `json:"productSoldTypeL4,omitempty"` + + // ProductSoldTypeL5: Type (level 5) of the product sold. + ProductSoldTypeL5 string `json:"productSoldTypeL5,omitempty"` + + // ProductStoreId: Store ID of the product. + ProductStoreId string `json:"productStoreId,omitempty"` + + // ProductTitle: Title of the product. + ProductTitle string `json:"productTitle,omitempty"` + + // ProductTypeL1: Type (level 1) of the product. + ProductTypeL1 string `json:"productTypeL1,omitempty"` + + // ProductTypeL2: Type (level 2) of the product. + ProductTypeL2 string `json:"productTypeL2,omitempty"` + + // ProductTypeL3: Type (level 3) of the product. + ProductTypeL3 string `json:"productTypeL3,omitempty"` + + // ProductTypeL4: Type (level 4) of the product. + ProductTypeL4 string `json:"productTypeL4,omitempty"` + + // ProductTypeL5: Type (level 5) of the product. + ProductTypeL5 string `json:"productTypeL5,omitempty"` + // Quarter: Quarter as represented by the date of the first day of a // quarter. Uses the calendar year for quarters, for example, the second // quarter of 2018 starts on 2018-04-01. Formatted as yyyy-MM-dd. @@ -2189,6 +2899,34 @@ func (s *GoogleAdsSearchads360V0Common__TargetingSetting) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Common__TextAsset: A Text asset. +type GoogleAdsSearchads360V0Common__TextAsset struct { + // Text: Text content of the text asset. + Text string `json:"text,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Text") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Text") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__TextAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__TextAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Common__TextLabel: A type of label displaying // text on a colored background. type GoogleAdsSearchads360V0Common__TextLabel struct { @@ -2716,6 +3454,39 @@ func (s *GoogleAdsSearchads360V0Common__WebpageInfo) UnmarshalJSON(data []byte) return nil } +// GoogleAdsSearchads360V0Common__YoutubeVideoAsset: A YouTube asset. +type GoogleAdsSearchads360V0Common__YoutubeVideoAsset struct { + // YoutubeVideoId: YouTube video id. This is the 11 character string + // value used in the YouTube video URL. + YoutubeVideoId string `json:"youtubeVideoId,omitempty"` + + // YoutubeVideoTitle: YouTube video title. + YoutubeVideoTitle string `json:"youtubeVideoTitle,omitempty"` + + // ForceSendFields is a list of field names (e.g. "YoutubeVideoId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "YoutubeVideoId") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Common__YoutubeVideoAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Common__YoutubeVideoAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0ErrorsErrorLocationFieldPathElement: A part of // a field path. type GoogleAdsSearchads360V0ErrorsErrorLocationFieldPathElement struct { @@ -3024,7 +3795,7 @@ type GoogleAdsSearchads360V0Errors__ErrorCode struct { // (right-hand-side operands) in a filter exceeds the limit. QueryError string `json:"queryError,omitempty"` - // QuotaError: An error with the amonut of quota remaining. + // QuotaError: An error with the amount of quota remaining. // // Possible values: // "UNSPECIFIED" - Enum unspecified. @@ -3860,13 +4631,277 @@ func (s *GoogleAdsSearchads360V0ResourcesConversionActionValueSettings) Unmarsha return nil } -// GoogleAdsSearchads360V0Resources__Ad: An ad. -type GoogleAdsSearchads360V0Resources__Ad struct { - // DisplayUrl: The URL that appears in the ad description for some ad - // formats. - DisplayUrl string `json:"displayUrl,omitempty"` +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBidd +// ingCategory: One element of a bidding category at a certain level. +// Top-level categories are at level 1, their children at level 2, and +// so on. We currently support up to 5 levels. The user must specify a +// dimension type that indicates the level of the category. All cases of +// the same subdivision must have the same dimension type (category +// level). +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBiddingCategory struct { + // Id: ID of the product bidding category. This ID is equivalent to the + // google_product_category ID as described in this article: + // https://support.google.com/merchants/answer/6324436 + Id int64 `json:"id,omitempty,string"` - // ExpandedDynamicSearchAd: Immutable. Details pertaining to an expanded + // Level: Indicates the level of the category in the taxonomy. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "LEVEL1" - Level 1. + // "LEVEL2" - Level 2. + // "LEVEL3" - Level 3. + // "LEVEL4" - Level 4. + // "LEVEL5" - Level 5. + Level string `json:"level,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Id") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Id") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBiddingCategory) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBiddingCategory + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBran +// d: Brand of the product. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBrand struct { + // Value: String value of the product brand. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Value") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Value") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBrand) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBrand + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductChan +// nel: Locality of a product offer. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductChannel struct { + // Channel: Value of the locality. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ONLINE" - The item is sold online. + // "LOCAL" - The item is sold in local stores. + Channel string `json:"channel,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Channel") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Channel") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductChannel) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductChannel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCond +// ition: Condition of a product offer. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCondition struct { + // Condition: Value of the condition. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "NEW" - The product condition is new. + // "REFURBISHED" - The product condition is refurbished. + // "USED" - The product condition is used. + Condition string `json:"condition,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Condition") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Condition") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCondition) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCondition + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCust +// omAttribute: Custom attribute of a product offer. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCustomAttribute struct { + // Index: Indicates the index of the custom attribute. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "INDEX0" - First listing group filter custom attribute. + // "INDEX1" - Second listing group filter custom attribute. + // "INDEX2" - Third listing group filter custom attribute. + // "INDEX3" - Fourth listing group filter custom attribute. + // "INDEX4" - Fifth listing group filter custom attribute. + Index string `json:"index,omitempty"` + + // Value: String value of the product custom attribute. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Index") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Index") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCustomAttribute) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCustomAttribute + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductItem +// Id: Item id of a product offer. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductItemId struct { + // Value: Value of the id. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Value") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Value") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductItemId) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductItemId + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductType +// : Type of a product offer. +type GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductType struct { + // Level: Level of the type. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "LEVEL1" - Level 1. + // "LEVEL2" - Level 2. + // "LEVEL3" - Level 3. + // "LEVEL4" - Level 4. + // "LEVEL5" - Level 5. + Level string `json:"level,omitempty"` + + // Value: Value of the type. + Value string `json:"value,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Level") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Level") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductType) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductType + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__Ad: An ad. +type GoogleAdsSearchads360V0Resources__Ad struct { + // DisplayUrl: The URL that appears in the ad description for some ad + // formats. + DisplayUrl string `json:"displayUrl,omitempty"` + + // ExpandedDynamicSearchAd: Immutable. Details pertaining to an expanded // dynamic search ad. ExpandedDynamicSearchAd *GoogleAdsSearchads360V0Common__SearchAds360ExpandedDynamicSearchAdInfo `json:"expandedDynamicSearchAd,omitempty"` @@ -4819,6 +5854,9 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // CallAsset: Output only. A unified call asset. CallAsset *GoogleAdsSearchads360V0Common__UnifiedCallAsset `json:"callAsset,omitempty"` + // CallToActionAsset: Immutable. A call to action asset. + CallToActionAsset *GoogleAdsSearchads360V0Common__CallToActionAsset `json:"callToActionAsset,omitempty"` + // CalloutAsset: Output only. A unified callout asset. CalloutAsset *GoogleAdsSearchads360V0Common__UnifiedCalloutAsset `json:"calloutAsset,omitempty"` @@ -4847,6 +5885,9 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // Id: Output only. The ID of the asset. Id int64 `json:"id,omitempty,string"` + // ImageAsset: Output only. An image asset. + ImageAsset *GoogleAdsSearchads360V0Common__ImageAsset `json:"imageAsset,omitempty"` + // LastModifiedTime: Output only. The datetime when this asset was last // modified. The datetime is in the customer's time zone and in // "yyyy-MM-dd HH:mm:ss.ssssss" format. @@ -4858,69 +5899,368 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // MobileAppAsset: A mobile app asset. MobileAppAsset *GoogleAdsSearchads360V0Common__MobileAppAsset `json:"mobileAppAsset,omitempty"` + // Name: Optional name of the asset. + Name string `json:"name,omitempty"` + // PageFeedAsset: Output only. A unified page feed asset. PageFeedAsset *GoogleAdsSearchads360V0Common__UnifiedPageFeedAsset `json:"pageFeedAsset,omitempty"` - // ResourceName: Immutable. The resource name of the asset. Asset - // resource names have the form: - // `customers/{customer_id}/assets/{asset_id}` + // ResourceName: Immutable. The resource name of the asset. Asset + // resource names have the form: + // `customers/{customer_id}/assets/{asset_id}` + ResourceName string `json:"resourceName,omitempty"` + + // SitelinkAsset: Output only. A unified sitelink asset. + SitelinkAsset *GoogleAdsSearchads360V0Common__UnifiedSitelinkAsset `json:"sitelinkAsset,omitempty"` + + // Status: Output only. The status of the asset. + // + // Possible values: + // "UNSPECIFIED" - The status has not been specified. + // "UNKNOWN" - The received value is not known in this version. This + // is a response-only value. + // "ENABLED" - The asset is enabled. + // "REMOVED" - The asset is removed. + // "ARCHIVED" - The asset is archived. + // "PENDING_SYSTEM_GENERATED" - The asset is system generated pending + // user review. + Status string `json:"status,omitempty"` + + // TextAsset: Output only. A text asset. + TextAsset *GoogleAdsSearchads360V0Common__TextAsset `json:"textAsset,omitempty"` + + // TrackingUrlTemplate: URL template for constructing a tracking URL. + TrackingUrlTemplate string `json:"trackingUrlTemplate,omitempty"` + + // Type: Output only. Type of the asset. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "YOUTUBE_VIDEO" - YouTube video asset. + // "MEDIA_BUNDLE" - Media bundle asset. + // "IMAGE" - Image asset. + // "TEXT" - Text asset. + // "LEAD_FORM" - Lead form asset. + // "BOOK_ON_GOOGLE" - Book on Google asset. + // "PROMOTION" - Promotion asset. + // "CALLOUT" - Callout asset. + // "STRUCTURED_SNIPPET" - Structured Snippet asset. + // "SITELINK" - Sitelink asset. + // "PAGE_FEED" - Page Feed asset. + // "DYNAMIC_EDUCATION" - Dynamic Education asset. + // "MOBILE_APP" - Mobile app asset. + // "HOTEL_CALLOUT" - Hotel callout asset. + // "CALL" - Call asset. + // "PRICE" - Price asset. + // "CALL_TO_ACTION" - Call to action asset. + // "DYNAMIC_REAL_ESTATE" - Dynamic real estate asset. + // "DYNAMIC_CUSTOM" - Dynamic custom asset. + // "DYNAMIC_HOTELS_AND_RENTALS" - Dynamic hotels and rentals asset. + // "DYNAMIC_FLIGHTS" - Dynamic flights asset. + // "DISCOVERY_CAROUSEL_CARD" - Discovery Carousel Card asset. + // "DYNAMIC_TRAVEL" - Dynamic travel asset. + // "DYNAMIC_LOCAL" - Dynamic local asset. + // "DYNAMIC_JOBS" - Dynamic jobs asset. + // "LOCATION" - Location asset. + // "HOTEL_PROPERTY" - Hotel property asset. + Type string `json:"type,omitempty"` + + // YoutubeVideoAsset: Immutable. A YouTube video asset. + YoutubeVideoAsset *GoogleAdsSearchads360V0Common__YoutubeVideoAsset `json:"youtubeVideoAsset,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CallAsset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CallAsset") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__Asset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__Asset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroup: An asset group. +// AssetGroupAsset is used to link an asset to the asset group. +// AssetGroupSignal is used to associate a signal to an asset group. +type GoogleAdsSearchads360V0Resources__AssetGroup struct { + // AdStrength: Output only. Overall ad strength of this asset group. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "PENDING" - The ad strength is currently pending. + // "NO_ADS" - No ads could be generated. + // "POOR" - Poor strength. + // "AVERAGE" - Average strength. + // "GOOD" - Good strength. + // "EXCELLENT" - Excellent strength. + AdStrength string `json:"adStrength,omitempty"` + + // Campaign: Immutable. The campaign with which this asset group is + // associated. The asset which is linked to the asset group. + Campaign string `json:"campaign,omitempty"` + + // FinalMobileUrls: A list of final mobile URLs after all cross domain + // redirects. In performance max, by default, the urls are eligible for + // expansion unless opted out. + FinalMobileUrls []string `json:"finalMobileUrls,omitempty"` + + // FinalUrls: A list of final URLs after all cross domain redirects. In + // performance max, by default, the urls are eligible for expansion + // unless opted out. + FinalUrls []string `json:"finalUrls,omitempty"` + + // Id: Output only. The ID of the asset group. + Id int64 `json:"id,omitempty,string"` + + // Name: Required. Name of the asset group. Required. It must have a + // minimum length of 1 and maximum length of 128. It must be unique + // under a campaign. + Name string `json:"name,omitempty"` + + // Path1: First part of text that may appear appended to the url + // displayed in the ad. + Path1 string `json:"path1,omitempty"` + + // Path2: Second part of text that may appear appended to the url + // displayed in the ad. This field can only be set when path1 is set. + Path2 string `json:"path2,omitempty"` + + // ResourceName: Immutable. The resource name of the asset group. Asset + // group resource names have the form: + // `customers/{customer_id}/assetGroups/{asset_group_id}` + ResourceName string `json:"resourceName,omitempty"` + + // Status: The status of the asset group. + // + // Possible values: + // "UNSPECIFIED" - The status has not been specified. + // "UNKNOWN" - The received value is not known in this version. + // "ENABLED" - The asset group is enabled. + // "PAUSED" - The asset group is paused. + // "REMOVED" - The asset group is removed. + Status string `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AdStrength") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdStrength") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetGroup) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroup + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroupAsset: AssetGroupAsset is +// the link between an asset and an asset group. Adding an +// AssetGroupAsset links an asset with an asset group. +type GoogleAdsSearchads360V0Resources__AssetGroupAsset struct { + // Asset: Immutable. The asset which this asset group asset is linking. + Asset string `json:"asset,omitempty"` + + // AssetGroup: Immutable. The asset group which this asset group asset + // is linking. + AssetGroup string `json:"assetGroup,omitempty"` + + // FieldType: The description of the placement of the asset within the + // asset group. For example: HEADLINE, YOUTUBE_VIDEO etc + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "HEADLINE" - The asset is linked for use as a headline. + // "DESCRIPTION" - The asset is linked for use as a description. + // "MANDATORY_AD_TEXT" - The asset is linked for use as mandatory ad + // text. + // "MARKETING_IMAGE" - The asset is linked for use as a marketing + // image. + // "MEDIA_BUNDLE" - The asset is linked for use as a media bundle. + // "YOUTUBE_VIDEO" - The asset is linked for use as a YouTube video. + // "BOOK_ON_GOOGLE" - The asset is linked to indicate that a hotels + // campaign is "Book on Google" enabled. + // "LEAD_FORM" - The asset is linked for use as a Lead Form extension. + // "PROMOTION" - The asset is linked for use as a Promotion extension. + // "CALLOUT" - The asset is linked for use as a Callout extension. + // "STRUCTURED_SNIPPET" - The asset is linked for use as a Structured + // Snippet extension. + // "SITELINK" - The asset is linked for use as a Sitelink. + // "MOBILE_APP" - The asset is linked for use as a Mobile App + // extension. + // "HOTEL_CALLOUT" - The asset is linked for use as a Hotel Callout + // extension. + // "CALL" - The asset is linked for use as a Call extension. + // "PRICE" - The asset is linked for use as a Price extension. + // "LONG_HEADLINE" - The asset is linked for use as a long headline. + // "BUSINESS_NAME" - The asset is linked for use as a business name. + // "SQUARE_MARKETING_IMAGE" - The asset is linked for use as a square + // marketing image. + // "PORTRAIT_MARKETING_IMAGE" - The asset is linked for use as a + // portrait marketing image. + // "LOGO" - The asset is linked for use as a logo. + // "LANDSCAPE_LOGO" - The asset is linked for use as a landscape logo. + // "VIDEO" - The asset is linked for use as a non YouTube logo. + // "CALL_TO_ACTION_SELECTION" - The asset is linked for use to select + // a call-to-action. + // "AD_IMAGE" - The asset is linked for use to select an ad image. + // "BUSINESS_LOGO" - The asset is linked for use as a business logo. + // "HOTEL_PROPERTY" - The asset is linked for use as a hotel property + // in a Performance Max for travel goals campaign. + FieldType string `json:"fieldType,omitempty"` + + // ResourceName: Immutable. The resource name of the asset group asset. + // Asset group asset resource name have the form: + // `customers/{customer_id}/assetGroupAssets/{asset_group_id}~{asset_id}~ + // {field_type}` + ResourceName string `json:"resourceName,omitempty"` + + // Status: The status of the link between an asset and asset group. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ENABLED" - Asset link is enabled. + // "REMOVED" - Asset link has been removed. + // "PAUSED" - Asset link is paused. + Status string `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Asset") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Asset") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetGroupAsset) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroupAsset + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData: +// Asset group asset combination data +type GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData struct { + // AssetCombinationServedAssets: Output only. Served assets. + AssetCombinationServedAssets []*GoogleAdsSearchads360V0Common__AssetUsage `json:"assetCombinationServedAssets,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AssetCombinationServedAssets") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "AssetCombinationServedAssets") to include in API requests with the + // JSON null value. By default, fields with empty values are omitted + // from API requests. However, any field with an empty value appearing + // in NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter: +// AssetGroupListingGroupFilter represents a listing group filter tree +// node in an asset group. +type GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter struct { + // AssetGroup: Immutable. The asset group which this asset group listing + // group filter is part of. + AssetGroup string `json:"assetGroup,omitempty"` + + // CaseValue: Dimension value with which this listing group is refining + // its parent. Undefined for the root group. + CaseValue *GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension `json:"caseValue,omitempty"` + + // Id: Output only. The ID of the ListingGroupFilter. + Id int64 `json:"id,omitempty,string"` + + // ParentListingGroupFilter: Immutable. Resource name of the parent + // listing group subdivision. Null for the root listing group filter + // node. + ParentListingGroupFilter string `json:"parentListingGroupFilter,omitempty"` + + // Path: Output only. The path of dimensions defining this listing group + // filter. + Path *GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath `json:"path,omitempty"` + + // ResourceName: Immutable. The resource name of the asset group listing + // group filter. Asset group listing group filter resource name have the + // form: + // `customers/{customer_id}/assetGroupListingGroupFilters/{asset_group_id + // }~{listing_group_filter_id}` ResourceName string `json:"resourceName,omitempty"` - // SitelinkAsset: Output only. A unified sitelink asset. - SitelinkAsset *GoogleAdsSearchads360V0Common__UnifiedSitelinkAsset `json:"sitelinkAsset,omitempty"` - - // Status: Output only. The status of the asset. + // Type: Immutable. Type of a listing group filter node. // // Possible values: - // "UNSPECIFIED" - The status has not been specified. - // "UNKNOWN" - The received value is not known in this version. This - // is a response-only value. - // "ENABLED" - The asset is enabled. - // "REMOVED" - The asset is removed. - // "ARCHIVED" - The asset is archived. - // "PENDING_SYSTEM_GENERATED" - The asset is system generated pending - // user review. - Status string `json:"status,omitempty"` - - // TrackingUrlTemplate: URL template for constructing a tracking URL. - TrackingUrlTemplate string `json:"trackingUrlTemplate,omitempty"` + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "SUBDIVISION" - Subdivision of products along some listing + // dimensions. + // "UNIT_INCLUDED" - An included listing group filter leaf node. + // "UNIT_EXCLUDED" - An excluded listing group filter leaf node. + Type string `json:"type,omitempty"` - // Type: Output only. Type of the asset. + // Vertical: Immutable. The vertical the current node tree represents. + // All nodes in the same tree must belong to the same vertical. // // Possible values: // "UNSPECIFIED" - Not specified. // "UNKNOWN" - Used for return value only. Represents value unknown in // this version. - // "YOUTUBE_VIDEO" - YouTube video asset. - // "MEDIA_BUNDLE" - Media bundle asset. - // "IMAGE" - Image asset. - // "TEXT" - Text asset. - // "LEAD_FORM" - Lead form asset. - // "BOOK_ON_GOOGLE" - Book on Google asset. - // "PROMOTION" - Promotion asset. - // "CALLOUT" - Callout asset. - // "STRUCTURED_SNIPPET" - Structured Snippet asset. - // "SITELINK" - Sitelink asset. - // "PAGE_FEED" - Page Feed asset. - // "DYNAMIC_EDUCATION" - Dynamic Education asset. - // "MOBILE_APP" - Mobile app asset. - // "HOTEL_CALLOUT" - Hotel callout asset. - // "CALL" - Call asset. - // "PRICE" - Price asset. - // "CALL_TO_ACTION" - Call to action asset. - // "DYNAMIC_REAL_ESTATE" - Dynamic real estate asset. - // "DYNAMIC_CUSTOM" - Dynamic custom asset. - // "DYNAMIC_HOTELS_AND_RENTALS" - Dynamic hotels and rentals asset. - // "DYNAMIC_FLIGHTS" - Dynamic flights asset. - // "DISCOVERY_CAROUSEL_CARD" - Discovery Carousel Card asset. - // "DYNAMIC_TRAVEL" - Dynamic travel asset. - // "DYNAMIC_LOCAL" - Dynamic local asset. - // "DYNAMIC_JOBS" - Dynamic jobs asset. - // "LOCATION" - Location asset. - // "HOTEL_PROPERTY" - Hotel property asset. - Type string `json:"type,omitempty"` + // "SHOPPING" - Represents the shopping vertical. + Vertical string `json:"vertical,omitempty"` - // ForceSendFields is a list of field names (e.g. "CallAsset") to + // ForceSendFields is a list of field names (e.g. "AssetGroup") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -4928,7 +6268,7 @@ type GoogleAdsSearchads360V0Resources__Asset struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "CallAsset") to include in + // NullFields is a list of field names (e.g. "AssetGroup") to include in // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as @@ -4937,8 +6277,91 @@ type GoogleAdsSearchads360V0Resources__Asset struct { NullFields []string `json:"-"` } -func (s *GoogleAdsSearchads360V0Resources__Asset) MarshalJSON() ([]byte, error) { - type NoMethod GoogleAdsSearchads360V0Resources__Asset +func (s *GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroupSignal: AssetGroupSignal +// represents a signal in an asset group. The existence of a signal +// tells the performance max campaign who's most likely to convert. +// Performance Max uses the signal to look for new people with similar +// or stronger intent to find conversions across Search, Display, Video, +// and more. +type GoogleAdsSearchads360V0Resources__AssetGroupSignal struct { + // AssetGroup: Immutable. The asset group which this asset group signal + // belongs to. + AssetGroup string `json:"assetGroup,omitempty"` + + // Audience: Immutable. The audience signal to be used by the + // performance max campaign. + Audience *GoogleAdsSearchads360V0Common__AudienceInfo `json:"audience,omitempty"` + + // ResourceName: Immutable. The resource name of the asset group signal. + // Asset group signal resource name have the form: + // `customers/{customer_id}/assetGroupSignals/{asset_group_id}~{signal_id + // }` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AssetGroup") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AssetGroup") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetGroupSignal) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroupSignal + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView: A +// view on the usage of ad group ad asset combination. +type GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView struct { + // AssetGroupTopCombinations: Output only. The top combinations of + // assets that served together. + AssetGroupTopCombinations []*GoogleAdsSearchads360V0Resources__AssetGroupAssetCombinationData `json:"assetGroupTopCombinations,omitempty"` + + // ResourceName: Output only. The resource name of the asset group top + // combination view. AssetGroup Top Combination view resource names have + // the form: + // "customers/{customer_id}/assetGroupTopCombinationViews/{asset_group_i + // d}~{asset_combination_category}" + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "AssetGroupTopCombinations") to unconditionally include in API + // requests. By default, fields with empty or default values are omitted + // from API requests. However, any non-pointer, non-interface field + // appearing in ForceSendFields will be sent to the server regardless of + // whether the field is empty or not. This may be used to include empty + // fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. + // "AssetGroupTopCombinations") to include in API requests with the JSON + // null value. By default, fields with empty values are omitted from API + // requests. However, any field with an empty value appearing in + // NullFields will be sent to the server as null. It is an error if a + // field in this list has a non-empty value. This may be used to include + // null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -5027,6 +6450,50 @@ func (s *GoogleAdsSearchads360V0Resources__AssetSetAsset) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__Audience: Audience is an effective +// targeting option that lets you intersect different segment +// attributes, such as detailed demographics and affinities, to create +// audiences that represent sections of your target segments. +type GoogleAdsSearchads360V0Resources__Audience struct { + // Description: Description of this audience. + Description string `json:"description,omitempty"` + + // Id: Output only. ID of the audience. + Id int64 `json:"id,omitempty,string"` + + // Name: Required. Name of the audience. It should be unique across all + // audiences. It must have a minimum length of 1 and maximum length of + // 255. + Name string `json:"name,omitempty"` + + // ResourceName: Immutable. The resource name of the audience. Audience + // names have the form: + // `customers/{customer_id}/audiences/{audience_id}` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__Audience) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__Audience + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__BiddingStrategy: A bidding // strategy. type GoogleAdsSearchads360V0Resources__BiddingStrategy struct { @@ -5845,8 +7312,8 @@ type GoogleAdsSearchads360V0Resources__CampaignBudget struct { // this version. // "DAILY" - Daily budget. // "FIXED_DAILY" - Fixed daily budget. - // "CUSTOM_PERIOD" - Custom budget, added back in V5. Custom bugdet - // can be used with total_amount to specify lifetime budget limit. + // "CUSTOM_PERIOD" - Custom budget can be used with total_amount to + // specify lifetime budget limit. Period string `json:"period,omitempty"` // ResourceName: Immutable. The resource name of the campaign budget. @@ -6039,15 +7506,245 @@ type GoogleAdsSearchads360V0Resources__CampaignLabel struct { // Campaign: Immutable. The campaign to which the label is attached. Campaign string `json:"campaign,omitempty"` - // Label: Immutable. The label assigned to the campaign. - Label string `json:"label,omitempty"` + // Label: Immutable. The label assigned to the campaign. + Label string `json:"label,omitempty"` + + // ResourceName: Immutable. Name of the resource. Campaign label + // resource names have the form: + // `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Campaign") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Campaign") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__CampaignLabel) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__CampaignLabel + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__CartDataSalesView: Cart data sales +// view. +type GoogleAdsSearchads360V0Resources__CartDataSalesView struct { + // ResourceName: Output only. The resource name of the Cart data sales + // view. Cart data sales view resource names have the form: + // `customers/{customer_id}/cartDataSalesView` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ResourceName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ResourceName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__CartDataSalesView) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__CartDataSalesView + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__Conversion: A conversion. +type GoogleAdsSearchads360V0Resources__Conversion struct { + // AdId: Output only. Ad ID. A value of 0 indicates that the ad is + // unattributed. + AdId int64 `json:"adId,omitempty,string"` + + // AdvertiserConversionId: Output only. For offline conversions, this is + // an ID provided by advertisers. If an advertiser doesn't specify such + // an ID, Search Ads 360 generates one. For online conversions, this is + // equal to the id column or the floodlight_order_id column depending on + // the advertiser's Floodlight instructions. + AdvertiserConversionId string `json:"advertiserConversionId,omitempty"` + + // AssetFieldType: Output only. Asset field type of the conversion + // event. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "HEADLINE" - The asset is linked for use as a headline. + // "DESCRIPTION" - The asset is linked for use as a description. + // "MANDATORY_AD_TEXT" - The asset is linked for use as mandatory ad + // text. + // "MARKETING_IMAGE" - The asset is linked for use as a marketing + // image. + // "MEDIA_BUNDLE" - The asset is linked for use as a media bundle. + // "YOUTUBE_VIDEO" - The asset is linked for use as a YouTube video. + // "BOOK_ON_GOOGLE" - The asset is linked to indicate that a hotels + // campaign is "Book on Google" enabled. + // "LEAD_FORM" - The asset is linked for use as a Lead Form extension. + // "PROMOTION" - The asset is linked for use as a Promotion extension. + // "CALLOUT" - The asset is linked for use as a Callout extension. + // "STRUCTURED_SNIPPET" - The asset is linked for use as a Structured + // Snippet extension. + // "SITELINK" - The asset is linked for use as a Sitelink. + // "MOBILE_APP" - The asset is linked for use as a Mobile App + // extension. + // "HOTEL_CALLOUT" - The asset is linked for use as a Hotel Callout + // extension. + // "CALL" - The asset is linked for use as a Call extension. + // "PRICE" - The asset is linked for use as a Price extension. + // "LONG_HEADLINE" - The asset is linked for use as a long headline. + // "BUSINESS_NAME" - The asset is linked for use as a business name. + // "SQUARE_MARKETING_IMAGE" - The asset is linked for use as a square + // marketing image. + // "PORTRAIT_MARKETING_IMAGE" - The asset is linked for use as a + // portrait marketing image. + // "LOGO" - The asset is linked for use as a logo. + // "LANDSCAPE_LOGO" - The asset is linked for use as a landscape logo. + // "VIDEO" - The asset is linked for use as a non YouTube logo. + // "CALL_TO_ACTION_SELECTION" - The asset is linked for use to select + // a call-to-action. + // "AD_IMAGE" - The asset is linked for use to select an ad image. + // "BUSINESS_LOGO" - The asset is linked for use as a business logo. + // "HOTEL_PROPERTY" - The asset is linked for use as a hotel property + // in a Performance Max for travel goals campaign. + AssetFieldType string `json:"assetFieldType,omitempty"` + + // AssetId: Output only. ID of the asset which was interacted with + // during the conversion event. + AssetId int64 `json:"assetId,omitempty,string"` + + // AttributionType: Output only. What the conversion is attributed to: + // Visit or Keyword+Ad. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "VISIT" - The conversion is attributed to a visit. + // "CRITERION_AD" - The conversion is attributed to a criterion and ad + // pair. + AttributionType string `json:"attributionType,omitempty"` + + // ClickId: Output only. A unique string, for the visit that the + // conversion is attributed to, that is passed to the landing page as + // the click id URL parameter. + ClickId string `json:"clickId,omitempty"` + + // ConversionDateTime: Output only. The timestamp of the conversion + // event. + ConversionDateTime string `json:"conversionDateTime,omitempty"` + + // ConversionLastModifiedDateTime: Output only. The timestamp of the + // last time the conversion was modified. + ConversionLastModifiedDateTime string `json:"conversionLastModifiedDateTime,omitempty"` + + // ConversionQuantity: Output only. The quantity of items recorded by + // the conversion, as determined by the qty url parameter. The + // advertiser is responsible for dynamically populating the parameter + // (such as number of items sold in the conversion), otherwise it + // defaults to 1. + ConversionQuantity int64 `json:"conversionQuantity,omitempty,string"` + + // ConversionRevenueMicros: Output only. The adjusted revenue in micros + // for the conversion event. This will always be in the currency of the + // serving account. + ConversionRevenueMicros int64 `json:"conversionRevenueMicros,omitempty,string"` + + // ConversionVisitDateTime: Output only. The timestamp of the visit that + // the conversion is attributed to. + ConversionVisitDateTime string `json:"conversionVisitDateTime,omitempty"` + + // CriterionId: Output only. Search Ads 360 criterion ID. A value of 0 + // indicates that the criterion is unattributed. + CriterionId int64 `json:"criterionId,omitempty,string"` + + // FloodlightOrderId: Output only. The Floodlight order ID provided by + // the advertiser for the conversion. + FloodlightOrderId string `json:"floodlightOrderId,omitempty"` + + // FloodlightOriginalRevenue: Output only. The original, unchanged + // revenue associated with the Floodlight event (in the currency of the + // current report), before Floodlight currency instruction + // modifications. + FloodlightOriginalRevenue int64 `json:"floodlightOriginalRevenue,omitempty,string"` + + // Id: Output only. The ID of the conversion + Id int64 `json:"id,omitempty,string"` + + // MerchantId: Output only. The SearchAds360 inventory account ID + // containing the product that was clicked on. SearchAds360 generates + // this ID when you link an inventory account in SearchAds360. + MerchantId int64 `json:"merchantId,omitempty,string"` + + // ProductChannel: Output only. The sales channel of the product that + // was clicked on: Online or Local. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ONLINE" - The item is sold online. + // "LOCAL" - The item is sold in local stores. + ProductChannel string `json:"productChannel,omitempty"` + + // ProductCountryCode: Output only. The country (ISO-3166-format) + // registered for the inventory feed that contains the product clicked + // on. + ProductCountryCode string `json:"productCountryCode,omitempty"` + + // ProductId: Output only. The ID of the product clicked on. + ProductId string `json:"productId,omitempty"` + + // ProductLanguageCode: Output only. The language (ISO-639-1) that has + // been set for the Merchant Center feed containing data about the + // product. + ProductLanguageCode string `json:"productLanguageCode,omitempty"` + + // ProductStoreId: Output only. The store in the Local Inventory Ad that + // was clicked on. This should match the store IDs used in your local + // products feed. + ProductStoreId string `json:"productStoreId,omitempty"` + + // ResourceName: Output only. The resource name of the conversion. + // Conversion resource names have the form: + // `customers/{customer_id}/conversions/{ad_group_id}~{criterion_id}~{ds_ + // conversion_id}` + ResourceName string `json:"resourceName,omitempty"` + + // Status: Output only. The status of the conversion, either ENABLED or + // REMOVED.. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ENABLED" - The conversion is enabled. + // "REMOVED" - The conversion has been removed. + Status string `json:"status,omitempty"` - // ResourceName: Immutable. Name of the resource. Campaign label - // resource names have the form: - // `customers/{customer_id}/campaignLabels/{campaign_id}~{label_id}` - ResourceName string `json:"resourceName,omitempty"` + // VisitId: Output only. The SearchAds360 visit ID that the conversion + // is attributed to. + VisitId int64 `json:"visitId,omitempty,string"` - // ForceSendFields is a list of field names (e.g. "Campaign") to + // ForceSendFields is a list of field names (e.g. "AdId") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -6055,8 +7752,8 @@ type GoogleAdsSearchads360V0Resources__CampaignLabel struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Campaign") to include in - // API requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "AdId") to include in API + // requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. @@ -6064,8 +7761,8 @@ type GoogleAdsSearchads360V0Resources__CampaignLabel struct { NullFields []string `json:"-"` } -func (s *GoogleAdsSearchads360V0Resources__CampaignLabel) MarshalJSON() ([]byte, error) { - type NoMethod GoogleAdsSearchads360V0Resources__CampaignLabel +func (s *GoogleAdsSearchads360V0Resources__Conversion) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__Conversion raw := NoMethod(*s) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } @@ -7105,6 +8802,130 @@ func (s *GoogleAdsSearchads360V0Resources__Label) MarshalJSON() ([]byte, error) return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__LanguageConstant: A language. +type GoogleAdsSearchads360V0Resources__LanguageConstant struct { + // Code: Output only. The language code, for example, "en_US", "en_AU", + // "es", "fr", etc. + Code string `json:"code,omitempty"` + + // Id: Output only. The ID of the language constant. + Id int64 `json:"id,omitempty,string"` + + // Name: Output only. The full name of the language in English, for + // example, "English (US)", "Spanish", etc. + Name string `json:"name,omitempty"` + + // ResourceName: Output only. The resource name of the language + // constant. Language constant resource names have the form: + // `languageConstants/{criterion_id}` + ResourceName string `json:"resourceName,omitempty"` + + // Targetable: Output only. Whether the language is targetable. + Targetable bool `json:"targetable,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Code") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Code") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__LanguageConstant) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__LanguageConstant + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension: +// Listing dimensions for the asset group listing group filter. +type GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension struct { + // ProductBiddingCategory: Bidding category of a product offer. + ProductBiddingCategory *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBiddingCategory `json:"productBiddingCategory,omitempty"` + + // ProductBrand: Brand of a product offer. + ProductBrand *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductBrand `json:"productBrand,omitempty"` + + // ProductChannel: Locality of a product offer. + ProductChannel *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductChannel `json:"productChannel,omitempty"` + + // ProductCondition: Condition of a product offer. + ProductCondition *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCondition `json:"productCondition,omitempty"` + + // ProductCustomAttribute: Custom attribute of a product offer. + ProductCustomAttribute *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductCustomAttribute `json:"productCustomAttribute,omitempty"` + + // ProductItemId: Item id of a product offer. + ProductItemId *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductItemId `json:"productItemId,omitempty"` + + // ProductType: Type of a product offer. + ProductType *GoogleAdsSearchads360V0ResourcesListingGroupFilterDimensionProductType `json:"productType,omitempty"` + + // ForceSendFields is a list of field names (e.g. + // "ProductBiddingCategory") to unconditionally include in API requests. + // By default, fields with empty or default values are omitted from API + // requests. However, any non-pointer, non-interface field appearing in + // ForceSendFields will be sent to the server regardless of whether the + // field is empty or not. This may be used to include empty fields in + // Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ProductBiddingCategory") + // to include in API requests with the JSON null value. By default, + // fields with empty values are omitted from API requests. However, any + // field with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + +// GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath: +// The path defining of dimensions defining a listing group filter. +type GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath struct { + // Dimensions: Output only. The complete path of dimensions through the + // listing group filter hierarchy (excluding the root node) to this + // listing group filter. + Dimensions []*GoogleAdsSearchads360V0Resources__ListingGroupFilterDimension `json:"dimensions,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Dimensions") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Dimensions") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__ListingGroupFilterDimensionPath + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__LocationView: A location view // summarizes the performance of campaigns by Location criteria. type GoogleAdsSearchads360V0Resources__LocationView struct { @@ -7136,6 +8957,82 @@ func (s *GoogleAdsSearchads360V0Resources__LocationView) MarshalJSON() ([]byte, return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant: A +// Product Bidding Category. +type GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant struct { + // CountryCode: Output only. Two-letter upper-case country code of the + // product bidding category. + CountryCode string `json:"countryCode,omitempty"` + + // Id: Output only. ID of the product bidding category. This ID is + // equivalent to the google_product_category ID as described in this + // article: https://support.google.com/merchants/answer/6324436. + Id int64 `json:"id,omitempty,string"` + + // LanguageCode: Output only. Language code of the product bidding + // category. + LanguageCode string `json:"languageCode,omitempty"` + + // Level: Output only. Level of the product bidding category. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "LEVEL1" - Level 1. + // "LEVEL2" - Level 2. + // "LEVEL3" - Level 3. + // "LEVEL4" - Level 4. + // "LEVEL5" - Level 5. + Level string `json:"level,omitempty"` + + // LocalizedName: Output only. Display value of the product bidding + // category localized according to language_code. + LocalizedName string `json:"localizedName,omitempty"` + + // ProductBiddingCategoryConstantParent: Output only. Resource name of + // the parent product bidding category. + ProductBiddingCategoryConstantParent string `json:"productBiddingCategoryConstantParent,omitempty"` + + // ResourceName: Output only. The resource name of the product bidding + // category. Product bidding category resource names have the form: + // `productBiddingCategoryConstants/{country_code}~{level}~{id}` + ResourceName string `json:"resourceName,omitempty"` + + // Status: Output only. Status of the product bidding category. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ACTIVE" - The category is active and can be used for bidding. + // "OBSOLETE" - The category is obsolete. Used only for reporting + // purposes. + Status string `json:"status,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CountryCode") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CountryCode") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__ProductGroupView: A product group // view. type GoogleAdsSearchads360V0Resources__ProductGroupView struct { @@ -7301,6 +9198,41 @@ func (s *GoogleAdsSearchads360V0Resources__SearchAds360Field) MarshalJSON() ([]b return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__ShoppingPerformanceView: Shopping +// performance view. Provides Shopping campaign statistics aggregated at +// several product dimension levels. Product dimension values from +// Merchant Center such as brand, category, custom attributes, product +// condition and product type will reflect the state of each dimension +// as of the date and time when the corresponding event was recorded. +type GoogleAdsSearchads360V0Resources__ShoppingPerformanceView struct { + // ResourceName: Output only. The resource name of the Shopping + // performance view. Shopping performance view resource names have the + // form: `customers/{customer_id}/shoppingPerformanceView` + ResourceName string `json:"resourceName,omitempty"` + + // ForceSendFields is a list of field names (e.g. "ResourceName") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "ResourceName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__ShoppingPerformanceView) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__ShoppingPerformanceView + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__UserList: A user list. This is a // list of users a customer may target. type GoogleAdsSearchads360V0Resources__UserList struct { @@ -7359,6 +9291,140 @@ func (s *GoogleAdsSearchads360V0Resources__UserList) MarshalJSON() ([]byte, erro return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// GoogleAdsSearchads360V0Resources__Visit: A visit. +type GoogleAdsSearchads360V0Resources__Visit struct { + // AdId: Output only. Ad ID. A value of 0 indicates that the ad is + // unattributed. + AdId int64 `json:"adId,omitempty,string"` + + // AssetFieldType: Output only. Asset field type of the visit event. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "HEADLINE" - The asset is linked for use as a headline. + // "DESCRIPTION" - The asset is linked for use as a description. + // "MANDATORY_AD_TEXT" - The asset is linked for use as mandatory ad + // text. + // "MARKETING_IMAGE" - The asset is linked for use as a marketing + // image. + // "MEDIA_BUNDLE" - The asset is linked for use as a media bundle. + // "YOUTUBE_VIDEO" - The asset is linked for use as a YouTube video. + // "BOOK_ON_GOOGLE" - The asset is linked to indicate that a hotels + // campaign is "Book on Google" enabled. + // "LEAD_FORM" - The asset is linked for use as a Lead Form extension. + // "PROMOTION" - The asset is linked for use as a Promotion extension. + // "CALLOUT" - The asset is linked for use as a Callout extension. + // "STRUCTURED_SNIPPET" - The asset is linked for use as a Structured + // Snippet extension. + // "SITELINK" - The asset is linked for use as a Sitelink. + // "MOBILE_APP" - The asset is linked for use as a Mobile App + // extension. + // "HOTEL_CALLOUT" - The asset is linked for use as a Hotel Callout + // extension. + // "CALL" - The asset is linked for use as a Call extension. + // "PRICE" - The asset is linked for use as a Price extension. + // "LONG_HEADLINE" - The asset is linked for use as a long headline. + // "BUSINESS_NAME" - The asset is linked for use as a business name. + // "SQUARE_MARKETING_IMAGE" - The asset is linked for use as a square + // marketing image. + // "PORTRAIT_MARKETING_IMAGE" - The asset is linked for use as a + // portrait marketing image. + // "LOGO" - The asset is linked for use as a logo. + // "LANDSCAPE_LOGO" - The asset is linked for use as a landscape logo. + // "VIDEO" - The asset is linked for use as a non YouTube logo. + // "CALL_TO_ACTION_SELECTION" - The asset is linked for use to select + // a call-to-action. + // "AD_IMAGE" - The asset is linked for use to select an ad image. + // "BUSINESS_LOGO" - The asset is linked for use as a business logo. + // "HOTEL_PROPERTY" - The asset is linked for use as a hotel property + // in a Performance Max for travel goals campaign. + AssetFieldType string `json:"assetFieldType,omitempty"` + + // AssetId: Output only. ID of the asset which was interacted with + // during the visit event. + AssetId int64 `json:"assetId,omitempty,string"` + + // ClickId: Output only. A unique string for each visit that is passed + // to the landing page as the click id URL parameter. + ClickId string `json:"clickId,omitempty"` + + // CriterionId: Output only. Search Ads 360 keyword ID. A value of 0 + // indicates that the keyword is unattributed. + CriterionId int64 `json:"criterionId,omitempty,string"` + + // Id: Output only. The ID of the visit. + Id int64 `json:"id,omitempty,string"` + + // MerchantId: Output only. The Search Ads 360 inventory account ID + // containing the product that was clicked on. Search Ads 360 generates + // this ID when you link an inventory account in Search Ads 360. + MerchantId int64 `json:"merchantId,omitempty,string"` + + // ProductChannel: Output only. The sales channel of the product that + // was clicked on: Online or Local. + // + // Possible values: + // "UNSPECIFIED" - Not specified. + // "UNKNOWN" - Used for return value only. Represents value unknown in + // this version. + // "ONLINE" - The item is sold online. + // "LOCAL" - The item is sold in local stores. + ProductChannel string `json:"productChannel,omitempty"` + + // ProductCountryCode: Output only. The country (ISO-3166 format) + // registered for the inventory feed that contains the product clicked + // on. + ProductCountryCode string `json:"productCountryCode,omitempty"` + + // ProductId: Output only. The ID of the product clicked on. + ProductId string `json:"productId,omitempty"` + + // ProductLanguageCode: Output only. The language (ISO-639-1) that has + // been set for the Merchant Center feed containing data about the + // product. + ProductLanguageCode string `json:"productLanguageCode,omitempty"` + + // ProductStoreId: Output only. The store in the Local Inventory Ad that + // was clicked on. This should match the store IDs used in your local + // products feed. + ProductStoreId string `json:"productStoreId,omitempty"` + + // ResourceName: Output only. The resource name of the visit. Visit + // resource names have the form: + // `customers/{customer_id}/visits/{ad_group_id}~{criterion_id}~{ds_visit + // _id}` + ResourceName string `json:"resourceName,omitempty"` + + // VisitDateTime: Output only. The timestamp of the visit event. The + // timestamp is in the customer's time zone and in "yyyy-MM-dd HH:mm:ss" + // format. + VisitDateTime string `json:"visitDateTime,omitempty"` + + // ForceSendFields is a list of field names (e.g. "AdId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "AdId") to include in API + // requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *GoogleAdsSearchads360V0Resources__Visit) MarshalJSON() ([]byte, error) { + type NoMethod GoogleAdsSearchads360V0Resources__Visit + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // GoogleAdsSearchads360V0Resources__WebpageView: A webpage view. type GoogleAdsSearchads360V0Resources__WebpageView struct { // ResourceName: Output only. The resource name of the webpage view. @@ -7532,12 +9598,32 @@ type GoogleAdsSearchads360V0Services__SearchAds360Row struct { // Asset: The asset referenced in the query. Asset *GoogleAdsSearchads360V0Resources__Asset `json:"asset,omitempty"` + // AssetGroup: The asset group referenced in the query. + AssetGroup *GoogleAdsSearchads360V0Resources__AssetGroup `json:"assetGroup,omitempty"` + + // AssetGroupAsset: The asset group asset referenced in the query. + AssetGroupAsset *GoogleAdsSearchads360V0Resources__AssetGroupAsset `json:"assetGroupAsset,omitempty"` + + // AssetGroupListingGroupFilter: The asset group listing group filter + // referenced in the query. + AssetGroupListingGroupFilter *GoogleAdsSearchads360V0Resources__AssetGroupListingGroupFilter `json:"assetGroupListingGroupFilter,omitempty"` + + // AssetGroupSignal: The asset group signal referenced in the query. + AssetGroupSignal *GoogleAdsSearchads360V0Resources__AssetGroupSignal `json:"assetGroupSignal,omitempty"` + + // AssetGroupTopCombinationView: The asset group top combination view + // referenced in the query. + AssetGroupTopCombinationView *GoogleAdsSearchads360V0Resources__AssetGroupTopCombinationView `json:"assetGroupTopCombinationView,omitempty"` + // AssetSet: The asset set referenced in the query. AssetSet *GoogleAdsSearchads360V0Resources__AssetSet `json:"assetSet,omitempty"` // AssetSetAsset: The asset set asset referenced in the query. AssetSetAsset *GoogleAdsSearchads360V0Resources__AssetSetAsset `json:"assetSetAsset,omitempty"` + // Audience: The Audience referenced in the query. + Audience *GoogleAdsSearchads360V0Resources__Audience `json:"audience,omitempty"` + // BiddingStrategy: The bidding strategy referenced in the query. BiddingStrategy *GoogleAdsSearchads360V0Resources__BiddingStrategy `json:"biddingStrategy,omitempty"` @@ -7563,6 +9649,12 @@ type GoogleAdsSearchads360V0Services__SearchAds360Row struct { // CampaignLabel: The campaign label referenced in the query. CampaignLabel *GoogleAdsSearchads360V0Resources__CampaignLabel `json:"campaignLabel,omitempty"` + // CartDataSalesView: The cart data sales view referenced in the query. + CartDataSalesView *GoogleAdsSearchads360V0Resources__CartDataSalesView `json:"cartDataSalesView,omitempty"` + + // Conversion: The event level conversion referenced in the query. + Conversion *GoogleAdsSearchads360V0Resources__Conversion `json:"conversion,omitempty"` + // ConversionAction: The conversion action referenced in the query. ConversionAction *GoogleAdsSearchads360V0Resources__ConversionAction `json:"conversionAction,omitempty"` @@ -7600,21 +9692,35 @@ type GoogleAdsSearchads360V0Services__SearchAds360Row struct { // Label: The label referenced in the query. Label *GoogleAdsSearchads360V0Resources__Label `json:"label,omitempty"` + // LanguageConstant: The language constant referenced in the query. + LanguageConstant *GoogleAdsSearchads360V0Resources__LanguageConstant `json:"languageConstant,omitempty"` + // LocationView: The location view referenced in the query. LocationView *GoogleAdsSearchads360V0Resources__LocationView `json:"locationView,omitempty"` // Metrics: The metrics. Metrics *GoogleAdsSearchads360V0Common__Metrics `json:"metrics,omitempty"` + // ProductBiddingCategoryConstant: The Product Bidding Category + // referenced in the query. + ProductBiddingCategoryConstant *GoogleAdsSearchads360V0Resources__ProductBiddingCategoryConstant `json:"productBiddingCategoryConstant,omitempty"` + // ProductGroupView: The product group view referenced in the query. ProductGroupView *GoogleAdsSearchads360V0Resources__ProductGroupView `json:"productGroupView,omitempty"` // Segments: The segments. Segments *GoogleAdsSearchads360V0Common__Segments `json:"segments,omitempty"` + // ShoppingPerformanceView: The shopping performance view referenced in + // the query. + ShoppingPerformanceView *GoogleAdsSearchads360V0Resources__ShoppingPerformanceView `json:"shoppingPerformanceView,omitempty"` + // UserList: The user list referenced in the query. UserList *GoogleAdsSearchads360V0Resources__UserList `json:"userList,omitempty"` + // Visit: The event level visit referenced in the query. + Visit *GoogleAdsSearchads360V0Resources__Visit `json:"visit,omitempty"` + // WebpageView: The webpage view referenced in the query. WebpageView *GoogleAdsSearchads360V0Resources__WebpageView `json:"webpageView,omitempty"` diff --git a/securitycenter/v1/securitycenter-api.json b/securitycenter/v1/securitycenter-api.json index 2e0449dbc5d..34d61980c72 100644 --- a/securitycenter/v1/securitycenter-api.json +++ b/securitycenter/v1/securitycenter-api.json @@ -5110,7 +5110,7 @@ } } }, - "revision": "20231023", + "revision": "20231102", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -5615,6 +5615,30 @@ }, "type": "object" }, + "CloudLoggingEntry": { + "description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", + "id": "CloudLoggingEntry", + "properties": { + "insertId": { + "description": "A unique identifier for the log entry.", + "type": "string" + }, + "logId": { + "description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", + "type": "string" + }, + "resourceContainer": { + "description": "The organization, folder, or project of the monitored resource that produced this log entry.", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -6324,6 +6348,13 @@ }, "type": "array" }, + "logEntries": { + "description": "Log entries that are relevant to the finding.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT\u0026CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -7892,6 +7923,17 @@ }, "type": "object" }, + "LogEntry": { + "description": "An individual entry in a log.", + "id": "LogEntry", + "properties": { + "cloudLoggingEntry": { + "$ref": "CloudLoggingEntry", + "description": "An individual entry in a log stored in Cloud Logging." + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -8231,6 +8273,13 @@ "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "group": { "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" diff --git a/securitycenter/v1/securitycenter-gen.go b/securitycenter/v1/securitycenter-gen.go index fe104a4f2da..91ce54175fd 100644 --- a/securitycenter/v1/securitycenter-gen.go +++ b/securitycenter/v1/securitycenter-gen.go @@ -1656,6 +1656,49 @@ func (s *CloudDlpInspection) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// CloudLoggingEntry: Metadata taken from a Cloud Logging LogEntry +// (https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) +type CloudLoggingEntry struct { + // InsertId: A unique identifier for the log entry. + InsertId string `json:"insertId,omitempty"` + + // LogId: The type of the log (part of `log_name`. `log_name` is the + // resource name of the log to which this log entry belongs). For + // example: `cloudresourcemanager.googleapis.com/activity`. Note that + // this field is not URL-encoded, unlike the `LOG_ID` field in + // `LogEntry`. + LogId string `json:"logId,omitempty"` + + // ResourceContainer: The organization, folder, or project of the + // monitored resource that produced this log entry. + ResourceContainer string `json:"resourceContainer,omitempty"` + + // Timestamp: The time the event described by the log entry occurred. + Timestamp string `json:"timestamp,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InsertId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InsertId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudLoggingEntry) MarshalJSON() ([]byte, error) { + type NoMethod CloudLoggingEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Compliance: Contains compliance information about a security standard // indicating unmet recommendations. type Compliance struct { @@ -2691,6 +2734,9 @@ type Finding struct { // LoadBalancers: The load balancers associated with the finding. LoadBalancers []*LoadBalancer `json:"loadBalancers,omitempty"` + // LogEntries: Log entries that are relevant to the finding. + LogEntries []*LogEntry `json:"logEntries,omitempty"` + // MitreAttack: MITRE ATT&CK tactics and techniques related to this // finding. See: https://attack.mitre.org MitreAttack *MitreAttack `json:"mitreAttack,omitempty"` @@ -5423,6 +5469,36 @@ func (s *LoadBalancer) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// LogEntry: An individual entry in a log. +type LogEntry struct { + // CloudLoggingEntry: An individual entry in a log stored in Cloud + // Logging. + CloudLoggingEntry *CloudLoggingEntry `json:"cloudLoggingEntry,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CloudLoggingEntry") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CloudLoggingEntry") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *LogEntry) MarshalJSON() ([]byte, error) { + type NoMethod LogEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // MemoryHashSignature: A signature corresponding to memory page hashes. type MemoryHashSignature struct { // BinaryFamily: The binary family. @@ -5741,6 +5817,9 @@ func (s *NotificationConfig) MarshalJSON() ([]byte, error) { // by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, // Binding, or AccessReview. type Object struct { + // Containers: Pod containers associated with this finding, if any. + Containers []*Container `json:"containers,omitempty"` + // Group: Kubernetes object group, such as "policy.k8s.io/v1". Group string `json:"group,omitempty"` @@ -5756,7 +5835,7 @@ type Object struct { // https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. Ns string `json:"ns,omitempty"` - // ForceSendFields is a list of field names (e.g. "Group") to + // ForceSendFields is a list of field names (e.g. "Containers") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -5764,8 +5843,8 @@ type Object struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Group") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Containers") to include in + // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. diff --git a/securitycenter/v1beta1/securitycenter-api.json b/securitycenter/v1beta1/securitycenter-api.json index e0687ac1613..309f7ce5d8c 100644 --- a/securitycenter/v1beta1/securitycenter-api.json +++ b/securitycenter/v1beta1/securitycenter-api.json @@ -896,7 +896,7 @@ } } }, - "revision": "20231023", + "revision": "20231102", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -1227,6 +1227,30 @@ }, "type": "object" }, + "CloudLoggingEntry": { + "description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", + "id": "CloudLoggingEntry", + "properties": { + "insertId": { + "description": "A unique identifier for the log entry.", + "type": "string" + }, + "logId": { + "description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", + "type": "string" + }, + "resourceContainer": { + "description": "The organization, folder, or project of the monitored resource that produced this log entry.", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -1829,6 +1853,13 @@ }, "type": "array" }, + "logEntries": { + "description": "Log entries that are relevant to the finding.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT\u0026CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -3235,6 +3266,17 @@ }, "type": "object" }, + "LogEntry": { + "description": "An individual entry in a log.", + "id": "LogEntry", + "properties": { + "cloudLoggingEntry": { + "$ref": "CloudLoggingEntry", + "description": "An individual entry in a log stored in Cloud Logging." + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -3546,6 +3588,13 @@ "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "group": { "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" diff --git a/securitycenter/v1beta1/securitycenter-gen.go b/securitycenter/v1beta1/securitycenter-gen.go index ddab4d08841..25623e37d27 100644 --- a/securitycenter/v1beta1/securitycenter-gen.go +++ b/securitycenter/v1beta1/securitycenter-gen.go @@ -792,6 +792,49 @@ func (s *CloudDlpInspection) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// CloudLoggingEntry: Metadata taken from a Cloud Logging LogEntry +// (https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) +type CloudLoggingEntry struct { + // InsertId: A unique identifier for the log entry. + InsertId string `json:"insertId,omitempty"` + + // LogId: The type of the log (part of `log_name`. `log_name` is the + // resource name of the log to which this log entry belongs). For + // example: `cloudresourcemanager.googleapis.com/activity`. Note that + // this field is not URL-encoded, unlike the `LOG_ID` field in + // `LogEntry`. + LogId string `json:"logId,omitempty"` + + // ResourceContainer: The organization, folder, or project of the + // monitored resource that produced this log entry. + ResourceContainer string `json:"resourceContainer,omitempty"` + + // Timestamp: The time the event described by the log entry occurred. + Timestamp string `json:"timestamp,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InsertId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InsertId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudLoggingEntry) MarshalJSON() ([]byte, error) { + type NoMethod CloudLoggingEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Compliance: Contains compliance information about a security standard // indicating unmet recommendations. type Compliance struct { @@ -1647,6 +1690,9 @@ type Finding struct { // LoadBalancers: The load balancers associated with the finding. LoadBalancers []*LoadBalancer `json:"loadBalancers,omitempty"` + // LogEntries: Log entries that are relevant to the finding. + LogEntries []*LogEntry `json:"logEntries,omitempty"` + // MitreAttack: MITRE ATT&CK tactics and techniques related to this // finding. See: https://attack.mitre.org MitreAttack *MitreAttack `json:"mitreAttack,omitempty"` @@ -3954,6 +4000,36 @@ func (s *LoadBalancer) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// LogEntry: An individual entry in a log. +type LogEntry struct { + // CloudLoggingEntry: An individual entry in a log stored in Cloud + // Logging. + CloudLoggingEntry *CloudLoggingEntry `json:"cloudLoggingEntry,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CloudLoggingEntry") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CloudLoggingEntry") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *LogEntry) MarshalJSON() ([]byte, error) { + type NoMethod LogEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // MemoryHashSignature: A signature corresponding to memory page hashes. type MemoryHashSignature struct { // BinaryFamily: The binary family. @@ -4216,6 +4292,9 @@ func (s *NodePool) MarshalJSON() ([]byte, error) { // by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, // Binding, or AccessReview. type Object struct { + // Containers: Pod containers associated with this finding, if any. + Containers []*Container `json:"containers,omitempty"` + // Group: Kubernetes object group, such as "policy.k8s.io/v1". Group string `json:"group,omitempty"` @@ -4231,7 +4310,7 @@ type Object struct { // https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. Ns string `json:"ns,omitempty"` - // ForceSendFields is a list of field names (e.g. "Group") to + // ForceSendFields is a list of field names (e.g. "Containers") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -4239,8 +4318,8 @@ type Object struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Group") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Containers") to include in + // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. diff --git a/securitycenter/v1beta2/securitycenter-api.json b/securitycenter/v1beta2/securitycenter-api.json index 84631c77027..82b1105708d 100644 --- a/securitycenter/v1beta2/securitycenter-api.json +++ b/securitycenter/v1beta2/securitycenter-api.json @@ -1906,7 +1906,7 @@ } } }, - "revision": "20231023", + "revision": "20231102", "rootUrl": "https://securitycenter.googleapis.com/", "schemas": { "Access": { @@ -2097,6 +2097,30 @@ }, "type": "object" }, + "CloudLoggingEntry": { + "description": "Metadata taken from a [Cloud Logging LogEntry](https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry)", + "id": "CloudLoggingEntry", + "properties": { + "insertId": { + "description": "A unique identifier for the log entry.", + "type": "string" + }, + "logId": { + "description": "The type of the log (part of `log_name`. `log_name` is the resource name of the log to which this log entry belongs). For example: `cloudresourcemanager.googleapis.com/activity`. Note that this field is not URL-encoded, unlike the `LOG_ID` field in `LogEntry`.", + "type": "string" + }, + "resourceContainer": { + "description": "The organization, folder, or project of the monitored resource that produced this log entry.", + "type": "string" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred.", + "format": "google-datetime", + "type": "string" + } + }, + "type": "object" + }, "Compliance": { "description": "Contains compliance information about a security standard indicating unmet recommendations.", "id": "Compliance", @@ -2846,6 +2870,13 @@ }, "type": "array" }, + "logEntries": { + "description": "Log entries that are relevant to the finding.", + "items": { + "$ref": "LogEntry" + }, + "type": "array" + }, "mitreAttack": { "$ref": "MitreAttack", "description": "MITRE ATT\u0026CK tactics and techniques related to this finding. See: https://attack.mitre.org" @@ -3899,6 +3930,17 @@ }, "type": "object" }, + "LogEntry": { + "description": "An individual entry in a log.", + "id": "LogEntry", + "properties": { + "cloudLoggingEntry": { + "$ref": "CloudLoggingEntry", + "description": "An individual entry in a log stored in Cloud Logging." + } + }, + "type": "object" + }, "MemoryHashSignature": { "description": "A signature corresponding to memory page hashes.", "id": "MemoryHashSignature", @@ -4210,6 +4252,13 @@ "description": "Kubernetes object related to the finding, uniquely identified by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, Binding, or AccessReview.", "id": "Object", "properties": { + "containers": { + "description": "Pod containers associated with this finding, if any.", + "items": { + "$ref": "Container" + }, + "type": "array" + }, "group": { "description": "Kubernetes object group, such as \"policy.k8s.io/v1\".", "type": "string" diff --git a/securitycenter/v1beta2/securitycenter-gen.go b/securitycenter/v1beta2/securitycenter-gen.go index 59a5c4012a6..c76133147f2 100644 --- a/securitycenter/v1beta2/securitycenter-gen.go +++ b/securitycenter/v1beta2/securitycenter-gen.go @@ -742,6 +742,49 @@ func (s *CloudDlpInspection) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// CloudLoggingEntry: Metadata taken from a Cloud Logging LogEntry +// (https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry) +type CloudLoggingEntry struct { + // InsertId: A unique identifier for the log entry. + InsertId string `json:"insertId,omitempty"` + + // LogId: The type of the log (part of `log_name`. `log_name` is the + // resource name of the log to which this log entry belongs). For + // example: `cloudresourcemanager.googleapis.com/activity`. Note that + // this field is not URL-encoded, unlike the `LOG_ID` field in + // `LogEntry`. + LogId string `json:"logId,omitempty"` + + // ResourceContainer: The organization, folder, or project of the + // monitored resource that produced this log entry. + ResourceContainer string `json:"resourceContainer,omitempty"` + + // Timestamp: The time the event described by the log entry occurred. + Timestamp string `json:"timestamp,omitempty"` + + // ForceSendFields is a list of field names (e.g. "InsertId") to + // unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "InsertId") to include in + // API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. However, any field with an + // empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *CloudLoggingEntry) MarshalJSON() ([]byte, error) { + type NoMethod CloudLoggingEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // Compliance: Contains compliance information about a security standard // indicating unmet recommendations. type Compliance struct { @@ -1791,6 +1834,9 @@ type Finding struct { // LoadBalancers: The load balancers associated with the finding. LoadBalancers []*LoadBalancer `json:"loadBalancers,omitempty"` + // LogEntries: Log entries that are relevant to the finding. + LogEntries []*LogEntry `json:"logEntries,omitempty"` + // MitreAttack: MITRE ATT&CK tactics and techniques related to this // finding. See: https://attack.mitre.org MitreAttack *MitreAttack `json:"mitreAttack,omitempty"` @@ -3416,6 +3462,36 @@ func (s *LoadBalancer) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// LogEntry: An individual entry in a log. +type LogEntry struct { + // CloudLoggingEntry: An individual entry in a log stored in Cloud + // Logging. + CloudLoggingEntry *CloudLoggingEntry `json:"cloudLoggingEntry,omitempty"` + + // ForceSendFields is a list of field names (e.g. "CloudLoggingEntry") + // to unconditionally include in API requests. By default, fields with + // empty or default values are omitted from API requests. However, any + // non-pointer, non-interface field appearing in ForceSendFields will be + // sent to the server regardless of whether the field is empty or not. + // This may be used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "CloudLoggingEntry") to + // include in API requests with the JSON null value. By default, fields + // with empty values are omitted from API requests. However, any field + // with an empty value appearing in NullFields will be sent to the + // server as null. It is an error if a field in this list has a + // non-empty value. This may be used to include null fields in Patch + // requests. + NullFields []string `json:"-"` +} + +func (s *LogEntry) MarshalJSON() ([]byte, error) { + type NoMethod LogEntry + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // MemoryHashSignature: A signature corresponding to memory page hashes. type MemoryHashSignature struct { // BinaryFamily: The binary family. @@ -3678,6 +3754,9 @@ func (s *NodePool) MarshalJSON() ([]byte, error) { // by GKNN. Used if the object Kind is not one of Pod, Node, NodePool, // Binding, or AccessReview. type Object struct { + // Containers: Pod containers associated with this finding, if any. + Containers []*Container `json:"containers,omitempty"` + // Group: Kubernetes object group, such as "policy.k8s.io/v1". Group string `json:"group,omitempty"` @@ -3693,7 +3772,7 @@ type Object struct { // https://kubernetes.io/docs/tasks/administer-cluster/namespaces/. Ns string `json:"ns,omitempty"` - // ForceSendFields is a list of field names (e.g. "Group") to + // ForceSendFields is a list of field names (e.g. "Containers") to // unconditionally include in API requests. By default, fields with // empty or default values are omitted from API requests. However, any // non-pointer, non-interface field appearing in ForceSendFields will be @@ -3701,8 +3780,8 @@ type Object struct { // This may be used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Group") to include in API - // requests with the JSON null value. By default, fields with empty + // NullFields is a list of field names (e.g. "Containers") to include in + // API requests with the JSON null value. By default, fields with empty // values are omitted from API requests. However, any field with an // empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value.