diff --git a/accesscontextmanager/v1/accesscontextmanager-api.json b/accesscontextmanager/v1/accesscontextmanager-api.json index 4b6ee8717dd..9c9b84e40ab 100644 --- a/accesscontextmanager/v1/accesscontextmanager-api.json +++ b/accesscontextmanager/v1/accesscontextmanager-api.json @@ -1295,7 +1295,7 @@ } } }, - "revision": "20241103", + "revision": "20241113", "rootUrl": "https://accesscontextmanager.googleapis.com/", "schemas": { "AccessContextManagerOperationMetadata": { @@ -2379,7 +2379,7 @@ "type": "string" }, "etag": { - "description": "Optional. An opaque identifier for the current version of the `ServicePerimeter`. Clients should not expect this to be in any specific format. If etag is not provided, the operation will be performed as if a valid etag is provided.", + "description": "Optional. An opaque identifier for the current version of the `ServicePerimeter`. This identifier does not follow any specific format. If an etag is not provided, the operation will be performed as if a valid etag is provided.", "type": "string" }, "name": { diff --git a/accesscontextmanager/v1/accesscontextmanager-gen.go b/accesscontextmanager/v1/accesscontextmanager-gen.go index 72c5f692ec7..cdc14395b78 100644 --- a/accesscontextmanager/v1/accesscontextmanager-gen.go +++ b/accesscontextmanager/v1/accesscontextmanager-gen.go @@ -2022,9 +2022,9 @@ type ServicePerimeter struct { // affect behavior. Description string `json:"description,omitempty"` // Etag: Optional. An opaque identifier for the current version of the - // `ServicePerimeter`. Clients should not expect this to be in any specific - // format. If etag is not provided, the operation will be performed as if a - // valid etag is provided. + // `ServicePerimeter`. This identifier does not follow any specific format. If + // an etag is not provided, the operation will be performed as if a valid etag + // is provided. Etag string `json:"etag,omitempty"` // Name: Identifier. Resource name for the `ServicePerimeter`. Format: // `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The diff --git a/analyticsdata/v1beta/analyticsdata-api.json b/analyticsdata/v1beta/analyticsdata-api.json index 95ba3a0fd97..dc25d63f1c3 100644 --- a/analyticsdata/v1beta/analyticsdata-api.json +++ b/analyticsdata/v1beta/analyticsdata-api.json @@ -440,7 +440,7 @@ } } }, - "revision": "20240825", + "revision": "20241117", "rootUrl": "https://analyticsdata.googleapis.com/", "schemas": { "ActiveMetricRestriction": { @@ -1007,6 +1007,12 @@ }, "type": "object" }, + "EmptyFilter": { + "description": "Filter for empty values.", + "id": "EmptyFilter", + "properties": {}, + "type": "object" + }, "Filter": { "description": "An expression to filter dimension or metric values.", "id": "Filter", @@ -1015,6 +1021,10 @@ "$ref": "BetweenFilter", "description": "A filter for two values." }, + "emptyFilter": { + "$ref": "EmptyFilter", + "description": "A filter for empty values such as \"(not set)\" and \"\" values." + }, "fieldName": { "description": "The dimension name or metric name. In most methods, dimensions \u0026 metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.", "type": "string" diff --git a/analyticsdata/v1beta/analyticsdata-gen.go b/analyticsdata/v1beta/analyticsdata-gen.go index b2f303419f8..18617c88d81 100644 --- a/analyticsdata/v1beta/analyticsdata-gen.go +++ b/analyticsdata/v1beta/analyticsdata-gen.go @@ -1050,10 +1050,16 @@ func (s DimensionValue) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// EmptyFilter: Filter for empty values. +type EmptyFilter struct { +} + // Filter: An expression to filter dimension or metric values. type Filter struct { // BetweenFilter: A filter for two values. BetweenFilter *BetweenFilter `json:"betweenFilter,omitempty"` + // EmptyFilter: A filter for empty values such as "(not set)" and "" values. + EmptyFilter *EmptyFilter `json:"emptyFilter,omitempty"` // FieldName: The dimension name or metric name. In most methods, dimensions & // metrics can be used for the first time in this field. However in a // RunPivotReportRequest, this field must be additionally specified by name in diff --git a/apigee/v1/apigee-api.json b/apigee/v1/apigee-api.json index c97aaeff9f3..bae72412f5a 100644 --- a/apigee/v1/apigee-api.json +++ b/apigee/v1/apigee-api.json @@ -10385,7 +10385,7 @@ } } }, - "revision": "20241017", + "revision": "20241116", "rootUrl": "https://apigee.googleapis.com/", "schemas": { "EdgeConfigstoreBundleBadBundle": { @@ -13492,6 +13492,10 @@ "description": "The location for the config blob of API Runtime Control, aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud Storage URI. This is only used by Envoy-based gateways.", "type": "string" }, + "clientIpResolutionConfig": { + "$ref": "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig", + "description": "The algorithm to resolve IP." + }, "createTime": { "description": "Time that the environment configuration was created.", "format": "google-datetime", @@ -13610,6 +13614,33 @@ }, "type": "object" }, + "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig": { + "description": "Configuration for resolving the client ip.", + "id": "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig", + "properties": { + "headerIndexAlgorithm": { + "$ref": "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm", + "description": "Resolves the client ip based on a custom header." + } + }, + "type": "object" + }, + "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm": { + "description": "Resolves the client ip based on a custom header.", + "id": "GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm", + "properties": { + "ipHeaderIndex": { + "description": "The index of the ip in the header. (By default, value is 0 if missing)", + "format": "int32", + "type": "integer" + }, + "ipHeaderName": { + "description": "The name of the header to extract the client ip from.", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudApigeeV1EnvironmentGroup": { "description": "EnvironmentGroup configuration. An environment group is used to group one or more Apigee environments under a single host name.", "id": "GoogleCloudApigeeV1EnvironmentGroup", diff --git a/apigee/v1/apigee-gen.go b/apigee/v1/apigee-gen.go index 1f6c9397786..07bae4d7d12 100644 --- a/apigee/v1/apigee-gen.go +++ b/apigee/v1/apigee-gen.go @@ -4715,6 +4715,8 @@ type GoogleCloudApigeeV1EnvironmentConfig struct { // aka Envoy Adapter, for op-based authentication as a URI, e.g. a Cloud // Storage URI. This is only used by Envoy-based gateways. ArcConfigLocation string `json:"arcConfigLocation,omitempty"` + // ClientIpResolutionConfig: The algorithm to resolve IP. + ClientIpResolutionConfig *GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig `json:"clientIpResolutionConfig,omitempty"` // CreateTime: Time that the environment configuration was created. CreateTime string `json:"createTime,omitempty"` // DataCollectors: List of data collectors used by the deployments in the @@ -4790,6 +4792,55 @@ func (s GoogleCloudApigeeV1EnvironmentConfig) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig: Configuration +// for resolving the client ip. +type GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig struct { + // HeaderIndexAlgorithm: Resolves the client ip based on a custom header. + HeaderIndexAlgorithm *GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm `json:"headerIndexAlgorithm,omitempty"` + // ForceSendFields is a list of field names (e.g. "HeaderIndexAlgorithm") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "HeaderIndexAlgorithm") to include + // in API requests with the JSON null value. By default, fields with empty + // values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgori +// thm: Resolves the client ip based on a custom header. +type GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm struct { + // IpHeaderIndex: The index of the ip in the header. (By default, value is 0 if + // missing) + IpHeaderIndex int64 `json:"ipHeaderIndex,omitempty"` + // IpHeaderName: The name of the header to extract the client ip from. + IpHeaderName string `json:"ipHeaderName,omitempty"` + // ForceSendFields is a list of field names (e.g. "IpHeaderIndex") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "IpHeaderIndex") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudApigeeV1EnvironmentConfigClientIPResolutionConfigHeaderIndexAlgorithm + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudApigeeV1EnvironmentGroup: EnvironmentGroup configuration. An // environment group is used to group one or more Apigee environments under a // single host name. diff --git a/cloudasset/v1p7beta1/cloudasset-api.json b/cloudasset/v1p7beta1/cloudasset-api.json index 02e245d73db..5680b36d72b 100644 --- a/cloudasset/v1p7beta1/cloudasset-api.json +++ b/cloudasset/v1p7beta1/cloudasset-api.json @@ -167,7 +167,7 @@ } } }, - "revision": "20240803", + "revision": "20241110", "rootUrl": "https://cloudasset.googleapis.com/", "schemas": { "AnalyzeIamPolicyLongrunningMetadata": { @@ -1148,6 +1148,10 @@ "description": "Description of the `ServicePerimeter` and its use. Does not affect behavior.", "type": "string" }, + "etag": { + "description": "Optional. An opaque identifier for the current version of the `ServicePerimeter`. Clients should not expect this to be in any specific format. If etag is not provided, the operation will be performed as if a valid etag is provided.", + "type": "string" + }, "name": { "description": "Identifier. Resource name for the `ServicePerimeter`. Format: `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The `service_perimeter` component must begin with a letter, followed by alphanumeric characters or `_`. After you create a `ServicePerimeter`, you cannot change its `name`.", "type": "string" diff --git a/cloudasset/v1p7beta1/cloudasset-gen.go b/cloudasset/v1p7beta1/cloudasset-gen.go index dd2c98dfe5d..f3815592e86 100644 --- a/cloudasset/v1p7beta1/cloudasset-gen.go +++ b/cloudasset/v1p7beta1/cloudasset-gen.go @@ -1841,6 +1841,11 @@ type GoogleIdentityAccesscontextmanagerV1ServicePerimeter struct { // Description: Description of the `ServicePerimeter` and its use. Does not // affect behavior. Description string `json:"description,omitempty"` + // Etag: Optional. An opaque identifier for the current version of the + // `ServicePerimeter`. Clients should not expect this to be in any specific + // format. If etag is not provided, the operation will be performed as if a + // valid etag is provided. + Etag string `json:"etag,omitempty"` // Name: Identifier. Resource name for the `ServicePerimeter`. Format: // `accessPolicies/{access_policy}/servicePerimeters/{service_perimeter}`. The // `service_perimeter` component must begin with a letter, followed by diff --git a/cloudchannel/v1/cloudchannel-api.json b/cloudchannel/v1/cloudchannel-api.json index 2adba27ecdc..68d08366127 100644 --- a/cloudchannel/v1/cloudchannel-api.json +++ b/cloudchannel/v1/cloudchannel-api.json @@ -2075,7 +2075,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "cloudchannel.operations.cancel", @@ -2289,7 +2289,7 @@ } } }, - "revision": "20241109", + "revision": "20241116", "rootUrl": "https://cloudchannel.googleapis.com/", "schemas": { "GoogleCloudChannelV1ActivateEntitlementRequest": { @@ -2430,7 +2430,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if populated in a request, this field isn't evaluated in the API.", "type": "string" }, "purchaseOrderId": { @@ -3109,7 +3109,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API.", "type": "string" }, "provisionedService": { @@ -5230,7 +5230,7 @@ "type": "array" }, "priceReferenceId": { - "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Yet to be implemented: this field is currently not evaluated in the API if populated in a request.", + "description": "Optional. Price reference ID for the offer. Optional field only for offers that require additional price information. Used to guarantee that the pricing is consistent between quoting the offer and placing the order. Not yet implemented: if this field is populated in a request, it isn't evaluated in the API.", "type": "string" }, "provisionedService": { diff --git a/cloudchannel/v1/cloudchannel-gen.go b/cloudchannel/v1/cloudchannel-gen.go index 4c0bca4e27f..35e60e85d65 100644 --- a/cloudchannel/v1/cloudchannel-gen.go +++ b/cloudchannel/v1/cloudchannel-gen.go @@ -563,8 +563,8 @@ type GoogleCloudChannelV1ChangeOfferRequest struct { // PriceReferenceId: Optional. Price reference ID for the offer. Optional field // only for offers that require additional price information. Used to guarantee // that the pricing is consistent between quoting the offer and placing the - // order. Yet to be implemented: this field is currently not evaluated in the - // API if populated in a request. + // order. Not yet implemented: if populated in a request, this field isn't + // evaluated in the API. PriceReferenceId string `json:"priceReferenceId,omitempty"` // PurchaseOrderId: Optional. Purchase order id provided by the reseller. PurchaseOrderId string `json:"purchaseOrderId,omitempty"` @@ -1391,8 +1391,8 @@ type GoogleCloudChannelV1Entitlement struct { // PriceReferenceId: Optional. Price reference ID for the offer. Optional field // only for offers that require additional price information. Used to guarantee // that the pricing is consistent between quoting the offer and placing the - // order. Yet to be implemented: this field is currently not evaluated in the - // API if populated in a request. + // order. Not yet implemented: if this field is populated in a request, it + // isn't evaluated in the API. PriceReferenceId string `json:"priceReferenceId,omitempty"` // ProvisionedService: Output only. Service provisioning details for the // entitlement. @@ -4212,8 +4212,8 @@ type GoogleCloudChannelV1alpha1Entitlement struct { // PriceReferenceId: Optional. Price reference ID for the offer. Optional field // only for offers that require additional price information. Used to guarantee // that the pricing is consistent between quoting the offer and placing the - // order. Yet to be implemented: this field is currently not evaluated in the - // API if populated in a request. + // order. Not yet implemented: if this field is populated in a request, it + // isn't evaluated in the API. PriceReferenceId string `json:"priceReferenceId,omitempty"` // ProvisionedService: Output only. Service provisioning details for the // entitlement. @@ -12959,7 +12959,7 @@ type OperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/datalabeling/v1beta1/datalabeling-api.json b/datalabeling/v1beta1/datalabeling-api.json index 0f1cc53620a..98eee84045d 100644 --- a/datalabeling/v1beta1/datalabeling-api.json +++ b/datalabeling/v1beta1/datalabeling-api.json @@ -1476,7 +1476,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta1/projects/{projectsId}/operations/{operationsId}:cancel", "httpMethod": "GET", "id": "datalabeling.projects.operations.cancel", @@ -1596,7 +1596,7 @@ } } }, - "revision": "20231001", + "revision": "20241117", "rootUrl": "https://datalabeling.googleapis.com/", "schemas": { "GoogleCloudDatalabelingV1alpha1CreateInstructionMetadata": { diff --git a/datalabeling/v1beta1/datalabeling-gen.go b/datalabeling/v1beta1/datalabeling-gen.go index d07b59689e1..9a40940bcd3 100644 --- a/datalabeling/v1beta1/datalabeling-gen.go +++ b/datalabeling/v1beta1/datalabeling-gen.go @@ -11363,7 +11363,7 @@ type ProjectsOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/discoveryengine/v1/discoveryengine-api.json b/discoveryengine/v1/discoveryengine-api.json index ef388c2a9be..e1b96e23415 100644 --- a/discoveryengine/v1/discoveryengine-api.json +++ b/discoveryengine/v1/discoveryengine-api.json @@ -779,7 +779,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel", @@ -4145,7 +4145,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", @@ -6042,7 +6042,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.operations.cancel", @@ -6140,7 +6140,7 @@ } } }, - "revision": "20241110", + "revision": "20241118", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -10495,7 +10495,7 @@ "id": "GoogleCloudDiscoveryengineV1PurgeUserEventsRequest", "properties": { "filter": { - "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", "type": "string" }, "force": { @@ -10601,7 +10601,7 @@ "id": "GoogleCloudDiscoveryengineV1RecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { @@ -10778,7 +10778,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec" }, @@ -15232,7 +15232,7 @@ "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -18084,7 +18084,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, diff --git a/discoveryengine/v1/discoveryengine-gen.go b/discoveryengine/v1/discoveryengine-gen.go index 6ebbc8a0b99..6fc234b71ab 100644 --- a/discoveryengine/v1/discoveryengine-gen.go +++ b/discoveryengine/v1/discoveryengine-gen.go @@ -7058,12 +7058,16 @@ type GoogleCloudDiscoveryengineV1PurgeUserEventsRequest struct { // ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying // this will delete all events associated with a visitor. * `userId`: Double // quoted string. Specifying this will delete all events associated with a - // user. Examples: * Deleting all events in a time range: `eventTime > + // user. Note: This API only supports purging a max range of 30 days. Examples: + // * Deleting all events in a time range: `eventTime > // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * - // Deleting specific eventType: `eventType = "search" * Deleting all events - // for a specific visitor: `userPseudoId = "visitor1024" * Deleting all events - // inside a DataStore: `*` The filtering fields are assumed to have an implicit - // AND. + // Deleting specific eventType in a time range: `eventTime > + // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType + // = "search" * Deleting all events for a specific visitor in a time range: + // `eventTime > "2012-04-23T18:25:43.511Z" eventTime < + // "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024" * Deleting the past + // 30 days of events inside a DataStore: `*` The filtering fields are assumed + // to have an implicit AND. Filter string `json:"filter,omitempty"` // Force: The `force` field is currently not supported. Purge user event // requests will permanently delete all purgeable events. Once the development @@ -7245,9 +7249,9 @@ type GoogleCloudDiscoveryengineV1RecommendRequest struct { // filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND // NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to // true under the `params` field, then attribute-based expressions are expected - // instead of the above described tag-based syntax. Examples: * (launguage: + // instead of the above described tag-based syntax. Examples: * (language: // ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND - // (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter + // (language: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter // blocks all results, the API returns generic (unfiltered) popular Documents. // If you only want results strictly matching the filters, set // `strictFiltering` to `true` in RecommendRequest.params to receive empty @@ -7537,10 +7541,10 @@ type GoogleCloudDiscoveryengineV1SearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // FacetSpecs: Facet specifications for faceted search. If empty, no facets are // returned. A maximum of 100 values are allowed. Otherwise, an @@ -13706,10 +13710,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -17712,10 +17716,10 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -21963,7 +21967,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. @@ -34383,7 +34387,7 @@ type ProjectsLocationsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. @@ -41297,7 +41301,7 @@ type ProjectsOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/discoveryengine/v1alpha/discoveryengine-api.json b/discoveryengine/v1alpha/discoveryengine-api.json index 64ff1c327f6..43093468e9c 100644 --- a/discoveryengine/v1alpha/discoveryengine-api.json +++ b/discoveryengine/v1alpha/discoveryengine-api.json @@ -1241,7 +1241,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel", @@ -5236,7 +5236,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", @@ -8057,7 +8057,7 @@ } } }, - "revision": "20241110", + "revision": "20241118", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -11712,7 +11712,7 @@ "type": "string" }, "resources": { - "description": "The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id` * `branch`_`id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project`_`number` * `location`_`id` * `collection`_`id` * `datastore`_`id`", + "description": "The resources to be checked for this requirement. The type needed for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id` * `branch_id` * `discoveryengine.googleapis.com/DataStore` * The labels needed for this resource: * `project_number` * `location_id` * `collection_id` * `datastore_id`", "items": { "$ref": "GoogleApiMonitoredResource" }, @@ -11733,7 +11733,7 @@ "type": "array" }, "oldestMetricTimestamp": { - "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `requirement_result` may not accurately reflect any Event and Product Catalog updates performed after this time.", + "description": "Timestamp of the oldest calculated metric (i.e. the most stale metric). Indicates that the `result` may not accurately reflect any Event and Product Catalog updates performed after this time.", "format": "google-datetime", "type": "string" }, @@ -15477,7 +15477,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest", "properties": { "filter": { - "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", "type": "string" }, "force": { @@ -15649,7 +15649,7 @@ "id": "GoogleCloudDiscoveryengineV1alphaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { @@ -16258,7 +16258,7 @@ "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -20221,7 +20221,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, diff --git a/discoveryengine/v1alpha/discoveryengine-gen.go b/discoveryengine/v1alpha/discoveryengine-gen.go index bb3a7fd549b..541132ffb38 100644 --- a/discoveryengine/v1alpha/discoveryengine-gen.go +++ b/discoveryengine/v1alpha/discoveryengine-gen.go @@ -6167,13 +6167,13 @@ type GoogleCloudDiscoveryengineV1alphaCheckRequirementRequest struct { // `discoveryengine.googleapis.com/media_recs/rfy/wdps/warning` * // `discoveryengine.googleapis.com/media_recs/mlt/wdps/warning` RequirementType string `json:"requirementType,omitempty"` - // Resources: The type needed for the monitored resources: * - // `discoveryengine.googleapis.com/Branch`. * The labels needed for this - // resource: * `project`_`number` * `location`_`id` * `collection`_`id` * - // `datastore`_`id` * `branch`_`id` * + // Resources: The resources to be checked for this requirement. The type needed + // for the monitored resources: * `discoveryengine.googleapis.com/Branch`. * + // The labels needed for this resource: * `project_number` * `location_id` * + // `collection_id` * `datastore_id` * `branch_id` * // `discoveryengine.googleapis.com/DataStore` * The labels needed for this - // resource: * `project`_`number` * `location`_`id` * `collection`_`id` * - // `datastore`_`id` + // resource: * `project_number` * `location_id` * `collection_id` * + // `datastore_id` Resources []*GoogleApiMonitoredResource `json:"resources,omitempty"` // ForceSendFields is a list of field names (e.g. "RequirementType") to // unconditionally include in API requests. By default, fields with empty or @@ -6199,9 +6199,8 @@ type GoogleCloudDiscoveryengineV1alphaCheckRequirementResponse struct { // MetricResults: Metric results. MetricResults []*GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult `json:"metricResults,omitempty"` // OldestMetricTimestamp: Timestamp of the oldest calculated metric (i.e. the - // most stale metric). Indicates that the `requirement_result` may not - // accurately reflect any Event and Product Catalog updates performed after - // this time. + // most stale metric). Indicates that the `result` may not accurately reflect + // any Event and Product Catalog updates performed after this time. OldestMetricTimestamp string `json:"oldestMetricTimestamp,omitempty"` // Requirement: Requirement definition. Requirement *GoogleCloudDiscoveryengineV1alphaRequirement `json:"requirement,omitempty"` @@ -11498,12 +11497,16 @@ type GoogleCloudDiscoveryengineV1alphaPurgeUserEventsRequest struct { // ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying // this will delete all events associated with a visitor. * `userId`: Double // quoted string. Specifying this will delete all events associated with a - // user. Examples: * Deleting all events in a time range: `eventTime > + // user. Note: This API only supports purging a max range of 30 days. Examples: + // * Deleting all events in a time range: `eventTime > // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * - // Deleting specific eventType: `eventType = "search" * Deleting all events - // for a specific visitor: `userPseudoId = "visitor1024" * Deleting all events - // inside a DataStore: `*` The filtering fields are assumed to have an implicit - // AND. + // Deleting specific eventType in a time range: `eventTime > + // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType + // = "search" * Deleting all events for a specific visitor in a time range: + // `eventTime > "2012-04-23T18:25:43.511Z" eventTime < + // "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024" * Deleting the past + // 30 days of events inside a DataStore: `*` The filtering fields are assumed + // to have an implicit AND. Filter string `json:"filter,omitempty"` // Force: The `force` field is currently not supported. Purge user event // requests will permanently delete all purgeable events. Once the development @@ -11813,9 +11816,9 @@ type GoogleCloudDiscoveryengineV1alphaRecommendRequest struct { // filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND // NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to // true under the `params` field, then attribute-based expressions are expected - // instead of the above described tag-based syntax. Examples: * (launguage: + // instead of the above described tag-based syntax. Examples: * (language: // ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND - // (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter + // (language: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter // blocks all results, the API returns generic (unfiltered) popular Documents. // If you only want results strictly matching the filters, set // `strictFiltering` to `true` in RecommendRequest.params to receive empty @@ -12646,10 +12649,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -18223,10 +18226,10 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -24265,7 +24268,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. @@ -39018,7 +39021,7 @@ type ProjectsLocationsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/discoveryengine/v1beta/discoveryengine-api.json b/discoveryengine/v1beta/discoveryengine-api.json index ee4a345ab27..3b2f9731475 100644 --- a/discoveryengine/v1beta/discoveryengine-api.json +++ b/discoveryengine/v1beta/discoveryengine-api.json @@ -779,7 +779,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.collections.dataStores.branches.operations.cancel", @@ -4540,7 +4540,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "discoveryengine.projects.locations.dataStores.branches.operations.cancel", @@ -7255,7 +7255,7 @@ } } }, - "revision": "20241110", + "revision": "20241118", "rootUrl": "https://discoveryengine.googleapis.com/", "schemas": { "GoogleApiDistribution": { @@ -12194,7 +12194,7 @@ "description": "Custom fine tuning configs. If set, it has higher priority than the configs set in ServingConfig.custom_fine_tuning_spec." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec" }, @@ -17913,7 +17913,7 @@ "id": "GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest", "properties": { "filter": { - "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType: `eventType = \"search\"` * Deleting all events for a specific visitor: `userPseudoId = \"visitor1024\"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", + "description": "Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 \"zulu\" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Note: This API only supports purging a max range of 30 days. Examples: * Deleting all events in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\"` * Deleting specific eventType in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" eventType = \"search\"` * Deleting all events for a specific visitor in a time range: `eventTime \u003e \"2012-04-23T18:25:43.511Z\" eventTime \u003c \"2012-04-23T18:30:43.511Z\" userPseudoId = \"visitor1024\"` * Deleting the past 30 days of events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND.", "type": "string" }, "force": { @@ -18073,7 +18073,7 @@ "id": "GoogleCloudDiscoveryengineV1betaRecommendRequest", "properties": { "filter": { - "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (launguage: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", + "description": "Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY(\"Red\", \"Blue\") OR filter_tags: ANY(\"Hot\", \"Cold\"))` * `(filter_tags: ANY(\"Red\", \"Blue\")) AND NOT (filter_tags: ANY(\"Green\"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (language: ANY(\"en\", \"es\")) AND NOT (categories: ANY(\"Movie\")) * (available: true) AND (language: ANY(\"en\", \"es\")) OR (categories: ANY(\"Movie\")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.", "type": "string" }, "pageSize": { @@ -18383,7 +18383,7 @@ "description": "A specification for configuring the behavior of content search." }, "dataStoreSpecs": { - "description": "Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level.", + "description": "Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. For engines with a single data store, the specs directly under SearchRequest should be used.", "items": { "$ref": "GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec" }, diff --git a/discoveryengine/v1beta/discoveryengine-gen.go b/discoveryengine/v1beta/discoveryengine-gen.go index 99911ca237e..f6fbcf6cb73 100644 --- a/discoveryengine/v1beta/discoveryengine-gen.go +++ b/discoveryengine/v1beta/discoveryengine-gen.go @@ -7665,10 +7665,10 @@ type GoogleCloudDiscoveryengineV1alphaSearchRequest struct { // CustomFineTuningSpec: Custom fine tuning configs. If set, it has higher // priority than the configs set in ServingConfig.custom_fine_tuning_spec. CustomFineTuningSpec *GoogleCloudDiscoveryengineV1alphaCustomFineTuningSpec `json:"customFineTuningSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1alphaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -15771,12 +15771,16 @@ type GoogleCloudDiscoveryengineV1betaPurgeUserEventsRequest struct { // ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying // this will delete all events associated with a visitor. * `userId`: Double // quoted string. Specifying this will delete all events associated with a - // user. Examples: * Deleting all events in a time range: `eventTime > + // user. Note: This API only supports purging a max range of 30 days. Examples: + // * Deleting all events in a time range: `eventTime > // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" * - // Deleting specific eventType: `eventType = "search" * Deleting all events - // for a specific visitor: `userPseudoId = "visitor1024" * Deleting all events - // inside a DataStore: `*` The filtering fields are assumed to have an implicit - // AND. + // Deleting specific eventType in a time range: `eventTime > + // "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z" eventType + // = "search" * Deleting all events for a specific visitor in a time range: + // `eventTime > "2012-04-23T18:25:43.511Z" eventTime < + // "2012-04-23T18:30:43.511Z" userPseudoId = "visitor1024" * Deleting the past + // 30 days of events inside a DataStore: `*` The filtering fields are assumed + // to have an implicit AND. Filter string `json:"filter,omitempty"` // Force: The `force` field is currently not supported. Purge user event // requests will permanently delete all purgeable events. Once the development @@ -16061,9 +16065,9 @@ type GoogleCloudDiscoveryengineV1betaRecommendRequest struct { // filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND // NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to // true under the `params` field, then attribute-based expressions are expected - // instead of the above described tag-based syntax. Examples: * (launguage: + // instead of the above described tag-based syntax. Examples: * (language: // ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND - // (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter + // (language: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter // blocks all results, the API returns generic (unfiltered) popular Documents. // If you only want results strictly matching the filters, set // `strictFiltering` to `true` in RecommendRequest.params to receive empty @@ -16531,10 +16535,10 @@ type GoogleCloudDiscoveryengineV1betaSearchRequest struct { // ContentSearchSpec: A specification for configuring the behavior of content // search. ContentSearchSpec *GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpec `json:"contentSearchSpec,omitempty"` - // DataStoreSpecs: Specs defining dataStores to filter on in a search call and - // configurations for those dataStores. This is only considered for engines - // with multiple dataStores use case. For single dataStore within an engine, - // they should use the specs at the top level. + // DataStoreSpecs: Specs defining DataStores to filter on in a search call and + // configurations for those data stores. This is only considered for Engines + // with multiple data stores. For engines with a single data store, the specs + // directly under SearchRequest should be used. DataStoreSpecs []*GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec `json:"dataStoreSpecs,omitempty"` // EmbeddingSpec: Uses the provided embedding to do additional semantic // document retrieval. The retrieval is based on the dot product of @@ -22383,7 +22387,7 @@ type ProjectsLocationsCollectionsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. @@ -36280,7 +36284,7 @@ type ProjectsLocationsDataStoresBranchesOperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/firebaseml/v1/firebaseml-api.json b/firebaseml/v1/firebaseml-api.json index 38bfe688dc5..9f8e1375449 100644 --- a/firebaseml/v1/firebaseml-api.json +++ b/firebaseml/v1/firebaseml-api.json @@ -108,7 +108,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "firebaseml.operations.cancel", @@ -204,7 +204,7 @@ } } }, - "revision": "20230802", + "revision": "20241117", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "CancelOperationRequest": { diff --git a/firebaseml/v1/firebaseml-gen.go b/firebaseml/v1/firebaseml-gen.go index b8839ab2857..729e8a74eb5 100644 --- a/firebaseml/v1/firebaseml-gen.go +++ b/firebaseml/v1/firebaseml-gen.go @@ -327,7 +327,7 @@ type OperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/firebaseml/v2beta/firebaseml-api.json b/firebaseml/v2beta/firebaseml-api.json index 53782e04b50..54d8246b436 100644 --- a/firebaseml/v2beta/firebaseml-api.json +++ b/firebaseml/v2beta/firebaseml-api.json @@ -206,7 +206,7 @@ } } }, - "revision": "20241101", + "revision": "20241117", "rootUrl": "https://firebaseml.googleapis.com/", "schemas": { "Date": { @@ -1138,6 +1138,100 @@ }, "type": "object" }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfig": { + "description": "Specifies the context retrieval config.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfig", + "properties": { + "filter": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter", + "description": "Optional. Config for filters." + }, + "hybridSearch": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch", + "description": "Optional. Config for Hybrid Search." + }, + "ranking": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking", + "description": "Optional. Config for ranking and reranking." + }, + "topK": { + "description": "Optional. The number of contexts to retrieve.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter": { + "description": "Config for filters.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter", + "properties": { + "metadataFilter": { + "description": "Optional. String for metadata filtering.", + "type": "string" + }, + "vectorDistanceThreshold": { + "description": "Optional. Only returns contexts with vector distance smaller than the threshold.", + "format": "double", + "type": "number" + }, + "vectorSimilarityThreshold": { + "description": "Optional. Only returns contexts with vector similarity larger than the threshold.", + "format": "double", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch": { + "description": "Config for Hybrid Search.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch", + "properties": { + "alpha": { + "description": "Optional. Alpha value controls the weight between dense and sparse vector search results. The range is [0, 1], while 0 means sparse vector search only and 1 means dense vector search only. The default value is 0.5 which balances sparse and dense vector search equally.", + "format": "float", + "type": "number" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking": { + "description": "Config for ranking and reranking.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking", + "properties": { + "llmRanker": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker", + "description": "Optional. Config for LlmRanker." + }, + "rankService": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService", + "description": "Optional. Config for Rank Service." + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker": { + "description": "Config for LlmRanker.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker", + "properties": { + "modelName": { + "description": "Optional. The model name used for ranking. Format: `gemini-1.5-pro`", + "type": "string" + } + }, + "type": "object" + }, + "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService": { + "description": "Config for Rank Service.", + "id": "GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService", + "properties": { + "modelName": { + "description": "Optional. The model name of the rank service. Format: `semantic-ranker-512@latest`", + "type": "string" + } + }, + "type": "object" + }, "GoogleCloudAiplatformV1beta1Retrieval": { "description": "Defines a retrieval tool that model can call to access external knowledge.", "id": "GoogleCloudAiplatformV1beta1Retrieval", @@ -1569,6 +1663,10 @@ }, "type": "array" }, + "ragRetrievalConfig": { + "$ref": "GoogleCloudAiplatformV1beta1RagRetrievalConfig", + "description": "Optional. The retrieval config for the Rag query." + }, "similarityTopK": { "deprecated": true, "description": "Optional. Number of top k results to return from the selected corpora.", diff --git a/firebaseml/v2beta/firebaseml-gen.go b/firebaseml/v2beta/firebaseml-gen.go index ce7f1abfe5a..83ecc732a2a 100644 --- a/firebaseml/v2beta/firebaseml-gen.go +++ b/firebaseml/v2beta/firebaseml-gen.go @@ -1419,6 +1419,192 @@ func (s GoogleCloudAiplatformV1beta1Part) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// GoogleCloudAiplatformV1beta1RagRetrievalConfig: Specifies the context +// retrieval config. +type GoogleCloudAiplatformV1beta1RagRetrievalConfig struct { + // Filter: Optional. Config for filters. + Filter *GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter `json:"filter,omitempty"` + // HybridSearch: Optional. Config for Hybrid Search. + HybridSearch *GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch `json:"hybridSearch,omitempty"` + // Ranking: Optional. Config for ranking and reranking. + Ranking *GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking `json:"ranking,omitempty"` + // TopK: Optional. The number of contexts to retrieve. + TopK int64 `json:"topK,omitempty"` + // ForceSendFields is a list of field names (e.g. "Filter") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Filter") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfig) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfig + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter: Config for filters. +type GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter struct { + // MetadataFilter: Optional. String for metadata filtering. + MetadataFilter string `json:"metadataFilter,omitempty"` + // VectorDistanceThreshold: Optional. Only returns contexts with vector + // distance smaller than the threshold. + VectorDistanceThreshold float64 `json:"vectorDistanceThreshold,omitempty"` + // VectorSimilarityThreshold: Optional. Only returns contexts with vector + // similarity larger than the threshold. + VectorSimilarityThreshold float64 `json:"vectorSimilarityThreshold,omitempty"` + // ForceSendFields is a list of field names (e.g. "MetadataFilter") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "MetadataFilter") to include in + // API requests with the JSON null value. By default, fields with empty values + // are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigFilter + var s1 struct { + VectorDistanceThreshold gensupport.JSONFloat64 `json:"vectorDistanceThreshold"` + VectorSimilarityThreshold gensupport.JSONFloat64 `json:"vectorSimilarityThreshold"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.VectorDistanceThreshold = float64(s1.VectorDistanceThreshold) + s.VectorSimilarityThreshold = float64(s1.VectorSimilarityThreshold) + return nil +} + +// GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch: Config for +// Hybrid Search. +type GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch struct { + // Alpha: Optional. Alpha value controls the weight between dense and sparse + // vector search results. The range is [0, 1], while 0 means sparse vector + // search only and 1 means dense vector search only. The default value is 0.5 + // which balances sparse and dense vector search equally. + Alpha float64 `json:"alpha,omitempty"` + // ForceSendFields is a list of field names (e.g. "Alpha") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Alpha") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +func (s *GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch) UnmarshalJSON(data []byte) error { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigHybridSearch + var s1 struct { + Alpha gensupport.JSONFloat64 `json:"alpha"` + *NoMethod + } + s1.NoMethod = (*NoMethod)(s) + if err := json.Unmarshal(data, &s1); err != nil { + return err + } + s.Alpha = float64(s1.Alpha) + return nil +} + +// GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking: Config for ranking +// and reranking. +type GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking struct { + // LlmRanker: Optional. Config for LlmRanker. + LlmRanker *GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker `json:"llmRanker,omitempty"` + // RankService: Optional. Config for Rank Service. + RankService *GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService `json:"rankService,omitempty"` + // ForceSendFields is a list of field names (e.g. "LlmRanker") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "LlmRanker") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigRanking + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker: Config for +// LlmRanker. +type GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker struct { + // ModelName: Optional. The model name used for ranking. Format: + // `gemini-1.5-pro` + ModelName string `json:"modelName,omitempty"` + // ForceSendFields is a list of field names (e.g. "ModelName") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ModelName") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingLlmRanker + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + +// GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService: Config for +// Rank Service. +type GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService struct { + // ModelName: Optional. The model name of the rank service. Format: + // `semantic-ranker-512@latest` + ModelName string `json:"modelName,omitempty"` + // ForceSendFields is a list of field names (e.g. "ModelName") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "ModelName") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService) MarshalJSON() ([]byte, error) { + type NoMethod GoogleCloudAiplatformV1beta1RagRetrievalConfigRankingRankService + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // GoogleCloudAiplatformV1beta1Retrieval: Defines a retrieval tool that model // can call to access external knowledge. type GoogleCloudAiplatformV1beta1Retrieval struct { @@ -1889,6 +2075,8 @@ type GoogleCloudAiplatformV1beta1VertexRagStore struct { // multiple files from one corpus. In the future we may open up multiple // corpora support. RagResources []*GoogleCloudAiplatformV1beta1VertexRagStoreRagResource `json:"ragResources,omitempty"` + // RagRetrievalConfig: Optional. The retrieval config for the Rag query. + RagRetrievalConfig *GoogleCloudAiplatformV1beta1RagRetrievalConfig `json:"ragRetrievalConfig,omitempty"` // SimilarityTopK: Optional. Number of top k results to return from the // selected corpora. SimilarityTopK int64 `json:"similarityTopK,omitempty"` diff --git a/forms/v1/forms-api.json b/forms/v1/forms-api.json index cdb6eb3fdda..916890256a4 100644 --- a/forms/v1/forms-api.json +++ b/forms/v1/forms-api.json @@ -423,7 +423,7 @@ } } }, - "revision": "20220908", + "revision": "20241112", "rootUrl": "https://forms.googleapis.com/", "schemas": { "Answer": { @@ -1190,6 +1190,10 @@ "description": "Read only. The question ID. On creation, it can be provided but the ID must not be already used in the form. If not provided, a new ID is assigned.", "type": "string" }, + "ratingQuestion": { + "$ref": "RatingQuestion", + "description": "A respondent can choose a rating from a pre-defined set of icons." + }, "required": { "description": "Whether the question must be answered in order for a respondent to submit their response.", "type": "boolean" @@ -1261,6 +1265,34 @@ }, "type": "object" }, + "RatingQuestion": { + "description": "A rating question. The user has a range of icons to choose from.", + "id": "RatingQuestion", + "properties": { + "iconType": { + "description": "Required. The icon type to use for the rating.", + "enum": [ + "RATING_ICON_TYPE_UNSPECIFIED", + "STAR", + "HEART", + "THUMB_UP" + ], + "enumDescriptions": [ + "Default value. Unused.", + "A star icon.", + "A heart icon.", + "A thumbs down icon." + ], + "type": "string" + }, + "ratingScaleLevel": { + "description": "Required. The rating scale level of the rating question.", + "format": "int32", + "type": "integer" + } + }, + "type": "object" + }, "RenewWatchRequest": { "description": "Renew an existing Watch for seven days.", "id": "RenewWatchRequest", diff --git a/forms/v1/forms-gen.go b/forms/v1/forms-gen.go index a51de11cc03..c788df4e043 100644 --- a/forms/v1/forms-gen.go +++ b/forms/v1/forms-gen.go @@ -1252,6 +1252,9 @@ type Question struct { // the ID must not be already used in the form. If not provided, a new ID is // assigned. QuestionId string `json:"questionId,omitempty"` + // RatingQuestion: A respondent can choose a rating from a pre-defined set of + // icons. + RatingQuestion *RatingQuestion `json:"ratingQuestion,omitempty"` // Required: Whether the question must be answered in order for a respondent to // submit their response. Required bool `json:"required,omitempty"` @@ -1362,6 +1365,37 @@ func (s QuizSettings) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// RatingQuestion: A rating question. The user has a range of icons to choose +// from. +type RatingQuestion struct { + // IconType: Required. The icon type to use for the rating. + // + // Possible values: + // "RATING_ICON_TYPE_UNSPECIFIED" - Default value. Unused. + // "STAR" - A star icon. + // "HEART" - A heart icon. + // "THUMB_UP" - A thumbs down icon. + IconType string `json:"iconType,omitempty"` + // RatingScaleLevel: Required. The rating scale level of the rating question. + RatingScaleLevel int64 `json:"ratingScaleLevel,omitempty"` + // ForceSendFields is a list of field names (e.g. "IconType") to + // unconditionally include in API requests. By default, fields with empty or + // default values are omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "IconType") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s RatingQuestion) MarshalJSON() ([]byte, error) { + type NoMethod RatingQuestion + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // RenewWatchRequest: Renew an existing Watch for seven days. type RenewWatchRequest struct { } diff --git a/iam/v2beta/iam-api.json b/iam/v2beta/iam-api.json index 1e7322619d5..63df8154df1 100644 --- a/iam/v2beta/iam-api.json +++ b/iam/v2beta/iam-api.json @@ -293,7 +293,7 @@ } } }, - "revision": "20240530", + "revision": "20241114", "rootUrl": "https://iam.googleapis.com/", "schemas": { "CloudControl2SharedOperationsReconciliationOperationMetadata": { @@ -337,7 +337,7 @@ "type": "string" }, "cancelRequested": { - "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have google.longrunning.Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "readOnly": true, "type": "boolean" }, diff --git a/iam/v2beta/iam-gen.go b/iam/v2beta/iam-gen.go index 3c808a0a9a8..81b8f767d92 100644 --- a/iam/v2beta/iam-gen.go +++ b/iam/v2beta/iam-gen.go @@ -217,8 +217,8 @@ type GoogleCloudCommonOperationMetadata struct { ApiVersion string `json:"apiVersion,omitempty"` // CancelRequested: Output only. Identifies whether the user has requested // cancellation of the operation. Operations that have been cancelled - // successfully have Operation.error value with a google.rpc.Status.code of 1, - // corresponding to `Code.CANCELLED`. + // successfully have google.longrunning.Operation.error value with a + // google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`. CancelRequested bool `json:"cancelRequested,omitempty"` // CreateTime: Output only. The time the operation was created. CreateTime string `json:"createTime,omitempty"` diff --git a/places/v1/places-api.json b/places/v1/places-api.json index 56216204465..587f5fbbc84 100644 --- a/places/v1/places-api.json +++ b/places/v1/places-api.json @@ -280,7 +280,7 @@ } } }, - "revision": "20241106", + "revision": "20241117", "rootUrl": "https://places.googleapis.com/", "schemas": { "GoogleGeoTypeViewport": { @@ -1231,7 +1231,7 @@ }, "regularOpeningHours": { "$ref": "GoogleMapsPlacesV1PlaceOpeningHours", - "description": "The regular hours of operation." + "description": "The regular hours of operation. Note that if a place is always open (24 hours), the `close` field will not be set. Clients can rely on always open (24 hours) being represented as an `open` period containing day with value `0`, hour with value `0`, and minute with value `0`." }, "regularSecondaryOpeningHours": { "description": "Contains an array of entries for information about regular secondary hours of a business. Secondary hours are different from a business's main hours. For example, a restaurant can specify drive through hours or delivery hours as its secondary hours. This field populates the type subfield, which draws from a predefined list of opening hours types (such as DRIVE_THROUGH, PICKUP, or TAKEOUT) based on the types of the place.", @@ -1596,12 +1596,12 @@ "type": "integer" }, "hour": { - "description": "The hour in 2 digits. Ranges from 00 to 23.", + "description": "The hour in 24 hour format. Ranges from 0 to 23.", "format": "int32", "type": "integer" }, "minute": { - "description": "The minute in 2 digits. Ranges from 00 to 59.", + "description": "The minute. Ranges from 0 to 59.", "format": "int32", "type": "integer" }, diff --git a/places/v1/places-gen.go b/places/v1/places-gen.go index d3003303623..360eeb5e71a 100644 --- a/places/v1/places-gen.go +++ b/places/v1/places-gen.go @@ -1449,7 +1449,10 @@ type GoogleMapsPlacesV1Place struct { PureServiceAreaBusiness bool `json:"pureServiceAreaBusiness,omitempty"` // Rating: A rating between 1.0 and 5.0, based on user reviews of this place. Rating float64 `json:"rating,omitempty"` - // RegularOpeningHours: The regular hours of operation. + // RegularOpeningHours: The regular hours of operation. Note that if a place is + // always open (24 hours), the `close` field will not be set. Clients can rely + // on always open (24 hours) being represented as an `open` period containing + // day with value `0`, hour with value `0`, and minute with value `0`. RegularOpeningHours *GoogleMapsPlacesV1PlaceOpeningHours `json:"regularOpeningHours,omitempty"` // RegularSecondaryOpeningHours: Contains an array of entries for information // about regular secondary hours of a business. Secondary hours are different @@ -1861,9 +1864,9 @@ type GoogleMapsPlacesV1PlaceOpeningHoursPeriodPoint struct { // Day: A day of the week, as an integer in the range 0-6. 0 is Sunday, 1 is // Monday, etc. Day int64 `json:"day,omitempty"` - // Hour: The hour in 2 digits. Ranges from 00 to 23. + // Hour: The hour in 24 hour format. Ranges from 0 to 23. Hour int64 `json:"hour,omitempty"` - // Minute: The minute in 2 digits. Ranges from 00 to 59. + // Minute: The minute. Ranges from 0 to 59. Minute int64 `json:"minute,omitempty"` // Truncated: Whether or not this endpoint was truncated. Truncation occurs // when the real hours are outside the times we are willing to return hours diff --git a/retail/v2/retail-api.json b/retail/v2/retail-api.json index fe45a308046..967c695ad83 100644 --- a/retail/v2/retail-api.json +++ b/retail/v2/retail-api.json @@ -2246,7 +2246,7 @@ } } }, - "revision": "20241024", + "revision": "20241114", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -2514,7 +2514,7 @@ "enumDescriptions": [ "Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG.", "At this level, we honor the attribute configurations set in Product.attributes.", - "At this level, we honor the attribute configurations set in CatalogConfig.attribute_configs." + "At this level, we honor the attribute configurations set in `CatalogConfig.attribute_configs`." ], "readOnly": true, "type": "string" @@ -2615,7 +2615,7 @@ }, "partitionDate": { "$ref": "GoogleTypeDate", - "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest." + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", @@ -2684,7 +2684,7 @@ "description": "Contains facet options." }, "inUse": { - "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", + "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", "readOnly": true, "type": "boolean" }, @@ -3211,7 +3211,7 @@ "type": "object" }, "GoogleCloudRetailV2ExperimentInfo": { - "description": "Metadata for active A/B testing Experiment.", + "description": "Metadata for active A/B testing experiment.", "id": "GoogleCloudRetailV2ExperimentInfo", "properties": { "experiment": { @@ -3230,7 +3230,7 @@ "id": "GoogleCloudRetailV2ExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { @@ -3768,23 +3768,41 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2CustomAttribute" }, - "description": "Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", + "description": "Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, + "availability": { + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default product availability. Default to Availability.IN_STOCK if unset.", + "Product in stock.", + "Product out of stock.", + "Product that is in pre-order state.", + "Product that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + }, "fulfillmentTypes": { - "description": "Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { "type": "string" }, "type": "array" }, "placeId": { - "description": "The place ID for the current set of inventory information.", + "description": "Required. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { "$ref": "GoogleCloudRetailV2PriceInfo", - "description": "Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." + "description": "Optional. Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." } }, "type": "object" @@ -5515,7 +5533,7 @@ "type": "string" }, "experimentInfo": { - "description": "Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.", + "description": "Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.", "items": { "$ref": "GoogleCloudRetailV2ExperimentInfo" }, @@ -6173,7 +6191,7 @@ "type": "string" }, "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", "type": "string" }, "userId": { diff --git a/retail/v2/retail-gen.go b/retail/v2/retail-gen.go index ec799eee214..e06de2f9491 100644 --- a/retail/v2/retail-gen.go +++ b/retail/v2/retail-gen.go @@ -772,7 +772,7 @@ type GoogleCloudRetailV2AttributesConfig struct { // "PRODUCT_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute // configurations set in Product.attributes. // "CATALOG_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute - // configurations set in CatalogConfig.attribute_configs. + // configurations set in `CatalogConfig.attribute_configs`. AttributeConfigLevel string `json:"attributeConfigLevel,omitempty"` // CatalogAttributes: Enable attribute(s) config at catalog level. For example, // indexable, dynamic_facetable, or searchable for each attribute. The key is @@ -942,7 +942,7 @@ type GoogleCloudRetailV2BigQuerySource struct { // the BigQuery export to a specific Cloud Storage directory. GcsStagingDir string `json:"gcsStagingDir,omitempty"` // PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in - // YYYY-MM-DD format. Only supported in ImportProductsRequest. + // YYYY-MM-DD format. PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"` // ProjectId: The project ID (can be project # or ID) that the BigQuery source // is in with a length limit of 128 characters. If not specified, inherits the @@ -1034,8 +1034,7 @@ type GoogleCloudRetailV2CatalogAttribute struct { // InUse: Output only. Indicates whether this attribute has been used by any // products. `True` if at least one Product is using this attribute in // Product.attributes. Otherwise, this field is `False`. CatalogAttribute can - // be pre-loaded by using CatalogService.AddCatalogAttribute, - // CatalogService.ImportCatalogAttributes, or + // be pre-loaded by using CatalogService.AddCatalogAttribute or // CatalogService.UpdateAttributesConfig APIs. This field is `False` for // pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are // neither in use by products nor predefined can be deleted. Catalog attributes @@ -1828,7 +1827,7 @@ func (s *GoogleCloudRetailV2CustomAttribute) UnmarshalJSON(data []byte) error { } // GoogleCloudRetailV2ExperimentInfo: Metadata for active A/B testing -// Experiment. +// experiment. type GoogleCloudRetailV2ExperimentInfo struct { // Experiment: The fully qualified resource name of the experiment that // provides the serving config under test, should an active experiment exist. @@ -1861,7 +1860,7 @@ func (s GoogleCloudRetailV2ExperimentInfo) MarshalJSON() ([]byte, error) { // active serving config A/B tests. type GoogleCloudRetailV2ExperimentInfoServingConfigExperiment struct { // ExperimentServingConfig: The fully qualified resource name of the serving - // config Experiment.VariantArm.serving_config_id responsible for generating + // config `Experiment.VariantArm.serving_config_id` responsible for generating // the search response. For example: // `projects/*/locations/*/catalogs/*/servingConfigs/*`. ExperimentServingConfig string `json:"experimentServingConfig,omitempty"` @@ -2730,19 +2729,38 @@ func (s GoogleCloudRetailV2ListServingConfigsResponse) MarshalJSON() ([]byte, er // GoogleCloudRetailV2LocalInventory: The inventory information at a place // (e.g. a store) identified by a place ID. type GoogleCloudRetailV2LocalInventory struct { - // Attributes: Additional local inventory attributes, for example, store name, - // promotion tags, etc. This field needs to pass all below criteria, otherwise - // an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. - // * The key must be a UTF-8 encoded string with a length limit of 32 - // characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, - // key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same - // type (text or number). * Only 1 value is allowed for each attribute. * For - // text values, the length limit is 256 UTF-8 characters. * The attribute does - // not support search. The `searchable` field should be unset or set to false. - // * The max summed total bytes of custom attribute keys and values per product - // is 5MiB. + // Attributes: Optional. Additional local inventory attributes, for example, + // store name, promotion tags, etc. This field needs to pass all below + // criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 + // attributes are allowed. * The key must be a UTF-8 encoded string with a + // length limit of 32 characters. * The key must match the pattern: + // `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute + // values must be of the same type (text or number). * Only 1 value is allowed + // for each attribute. * For text values, the length limit is 256 UTF-8 + // characters. * The attribute does not support search. The `searchable` field + // should be unset or set to false. * The max summed total bytes of custom + // attribute keys and values per product is 5MiB. Attributes map[string]GoogleCloudRetailV2CustomAttribute `json:"attributes,omitempty"` - // FulfillmentTypes: Input only. Supported fulfillment types. Valid fulfillment + // Availability: Optional. The availability of the Product at this place_id. + // Default to Availability.IN_STOCK. For primary products with variants set the + // availability of the primary as Availability.OUT_OF_STOCK and set the true + // availability at the variant level. This way the primary product will be + // considered "in stock" as long as it has at least one variant in stock. For + // primary products with no variants set the true availability at the primary + // level. Corresponding properties: Google Merchant Center property + // availability (https://support.google.com/merchants/answer/6324448). + // Schema.org property Offer.availability (https://schema.org/availability). + // + // Possible values: + // "AVAILABILITY_UNSPECIFIED" - Default product availability. Default to + // Availability.IN_STOCK if unset. + // "IN_STOCK" - Product in stock. + // "OUT_OF_STOCK" - Product out of stock. + // "PREORDER" - Product that is in pre-order state. + // "BACKORDER" - Product that is back-ordered (i.e. temporarily out of + // stock). + Availability string `json:"availability,omitempty"` + // FulfillmentTypes: Optional. Supported fulfillment types. Valid fulfillment // type values include commonly used types (such as pickup in store and same // day delivery), and custom types. Customers have to map custom types to their // display names before rendering UI. Supported values: * "pickup-in-store" * @@ -2752,10 +2770,11 @@ type GoogleCloudRetailV2LocalInventory struct { // an INVALID_ARGUMENT error is returned. All the elements must be distinct. // Otherwise, an INVALID_ARGUMENT error is returned. FulfillmentTypes []string `json:"fulfillmentTypes,omitempty"` - // PlaceId: The place ID for the current set of inventory information. + // PlaceId: Required. The place ID for the current set of inventory + // information. PlaceId string `json:"placeId,omitempty"` - // PriceInfo: Product price and cost information. Google Merchant Center - // property price (https://support.google.com/merchants/answer/6324371). + // PriceInfo: Optional. Product price and cost information. Google Merchant + // Center property price (https://support.google.com/merchants/answer/6324371). PriceInfo *GoogleCloudRetailV2PriceInfo `json:"priceInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "Attributes") to // unconditionally include in API requests. By default, fields with empty or @@ -5567,7 +5586,7 @@ type GoogleCloudRetailV2SearchResponse struct { // correction type is AUTOMATIC, then the search results are based on // corrected_query. Otherwise the original query is used for search. CorrectedQuery string `json:"correctedQuery,omitempty"` - // ExperimentInfo: Metadata related to A/B testing Experiment associated with + // ExperimentInfo: Metadata related to A/B testing experiment associated with // this response. Only exists when an experiment is triggered. ExperimentInfo []*GoogleCloudRetailV2ExperimentInfo `json:"experimentInfo,omitempty"` // Facets: Results of facets requested by user. @@ -6533,12 +6552,11 @@ type GoogleCloudRetailV2UserInfo struct { // SearchRequest.user_info. * using the JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. IpAddress string `json:"ipAddress,omitempty"` - // UserAgent: User agent as included in the HTTP header. Required for getting - // SearchResponse.sponsored_results. The field must be a UTF-8 encoded string - // with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT - // error is returned. This should not be set when using the client side event - // reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or - // if direct_user_request is set. + // UserAgent: User agent as included in the HTTP header. The field must be a + // UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an + // INVALID_ARGUMENT error is returned. This should not be set when using the + // client side event reporting with GTM or JavaScript tag in + // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for // logged-in user, such as a user name. Don't set for anonymous users. Always diff --git a/retail/v2alpha/retail-api.json b/retail/v2alpha/retail-api.json index a62c79bb039..05cef87ea9b 100644 --- a/retail/v2alpha/retail-api.json +++ b/retail/v2alpha/retail-api.json @@ -2767,7 +2767,7 @@ } } }, - "revision": "20241024", + "revision": "20241114", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -3667,7 +3667,7 @@ "enumDescriptions": [ "Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG.", "At this level, we honor the attribute configurations set in Product.attributes.", - "At this level, we honor the attribute configurations set in CatalogConfig.attribute_configs." + "At this level, we honor the attribute configurations set in `CatalogConfig.attribute_configs`." ], "readOnly": true, "type": "string" @@ -3803,7 +3803,7 @@ }, "partitionDate": { "$ref": "GoogleTypeDate", - "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest." + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", @@ -3981,7 +3981,7 @@ "description": "Contains facet options." }, "inUse": { - "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", + "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", "readOnly": true, "type": "boolean" }, @@ -4604,7 +4604,7 @@ "type": "object" }, "GoogleCloudRetailV2alphaExperimentInfo": { - "description": "Metadata for active A/B testing Experiment.", + "description": "Metadata for active A/B testing experiment.", "id": "GoogleCloudRetailV2alphaExperimentInfo", "properties": { "experiment": { @@ -4623,7 +4623,7 @@ "id": "GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { @@ -5300,23 +5300,41 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2alphaCustomAttribute" }, - "description": "Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", + "description": "Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, + "availability": { + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default product availability. Default to Availability.IN_STOCK if unset.", + "Product in stock.", + "Product out of stock.", + "Product that is in pre-order state.", + "Product that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + }, "fulfillmentTypes": { - "description": "Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { "type": "string" }, "type": "array" }, "placeId": { - "description": "The place ID for the current set of inventory information.", + "description": "Required. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { "$ref": "GoogleCloudRetailV2alphaPriceInfo", - "description": "Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." + "description": "Optional. Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." } }, "type": "object" @@ -7386,7 +7404,7 @@ "type": "string" }, "experimentInfo": { - "description": "Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.", + "description": "Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.", "items": { "$ref": "GoogleCloudRetailV2alphaExperimentInfo" }, @@ -8061,7 +8079,7 @@ "type": "string" }, "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", "type": "string" }, "userId": { diff --git a/retail/v2alpha/retail-gen.go b/retail/v2alpha/retail-gen.go index fd617735b86..15c10ac82c4 100644 --- a/retail/v2alpha/retail-gen.go +++ b/retail/v2alpha/retail-gen.go @@ -1701,7 +1701,7 @@ type GoogleCloudRetailV2alphaAttributesConfig struct { // "PRODUCT_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute // configurations set in Product.attributes. // "CATALOG_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute - // configurations set in CatalogConfig.attribute_configs. + // configurations set in `CatalogConfig.attribute_configs`. AttributeConfigLevel string `json:"attributeConfigLevel,omitempty"` // CatalogAttributes: Enable attribute(s) config at catalog level. For example, // indexable, dynamic_facetable, or searchable for each attribute. The key is @@ -1928,7 +1928,7 @@ type GoogleCloudRetailV2alphaBigQuerySource struct { // the BigQuery export to a specific Cloud Storage directory. GcsStagingDir string `json:"gcsStagingDir,omitempty"` // PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in - // YYYY-MM-DD format. Only supported in ImportProductsRequest. + // YYYY-MM-DD format. PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"` // ProjectId: The project ID (can be project # or ID) that the BigQuery source // is in with a length limit of 128 characters. If not specified, inherits the @@ -2189,8 +2189,7 @@ type GoogleCloudRetailV2alphaCatalogAttribute struct { // InUse: Output only. Indicates whether this attribute has been used by any // products. `True` if at least one Product is using this attribute in // Product.attributes. Otherwise, this field is `False`. CatalogAttribute can - // be pre-loaded by using CatalogService.AddCatalogAttribute, - // CatalogService.ImportCatalogAttributes, or + // be pre-loaded by using CatalogService.AddCatalogAttribute or // CatalogService.UpdateAttributesConfig APIs. This field is `False` for // pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are // neither in use by products nor predefined can be deleted. Catalog attributes @@ -3099,7 +3098,7 @@ func (s GoogleCloudRetailV2alphaEnrollSolutionResponse) MarshalJSON() ([]byte, e } // GoogleCloudRetailV2alphaExperimentInfo: Metadata for active A/B testing -// Experiment. +// experiment. type GoogleCloudRetailV2alphaExperimentInfo struct { // Experiment: The fully qualified resource name of the experiment that // provides the serving config under test, should an active experiment exist. @@ -3132,7 +3131,7 @@ func (s GoogleCloudRetailV2alphaExperimentInfo) MarshalJSON() ([]byte, error) { // active serving config A/B tests. type GoogleCloudRetailV2alphaExperimentInfoServingConfigExperiment struct { // ExperimentServingConfig: The fully qualified resource name of the serving - // config Experiment.VariantArm.serving_config_id responsible for generating + // config `Experiment.VariantArm.serving_config_id` responsible for generating // the search response. For example: // `projects/*/locations/*/catalogs/*/servingConfigs/*`. ExperimentServingConfig string `json:"experimentServingConfig,omitempty"` @@ -4256,19 +4255,38 @@ func (s GoogleCloudRetailV2alphaListServingConfigsResponse) MarshalJSON() ([]byt // GoogleCloudRetailV2alphaLocalInventory: The inventory information at a place // (e.g. a store) identified by a place ID. type GoogleCloudRetailV2alphaLocalInventory struct { - // Attributes: Additional local inventory attributes, for example, store name, - // promotion tags, etc. This field needs to pass all below criteria, otherwise - // an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. - // * The key must be a UTF-8 encoded string with a length limit of 32 - // characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, - // key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same - // type (text or number). * Only 1 value is allowed for each attribute. * For - // text values, the length limit is 256 UTF-8 characters. * The attribute does - // not support search. The `searchable` field should be unset or set to false. - // * The max summed total bytes of custom attribute keys and values per product - // is 5MiB. + // Attributes: Optional. Additional local inventory attributes, for example, + // store name, promotion tags, etc. This field needs to pass all below + // criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 + // attributes are allowed. * The key must be a UTF-8 encoded string with a + // length limit of 32 characters. * The key must match the pattern: + // `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute + // values must be of the same type (text or number). * Only 1 value is allowed + // for each attribute. * For text values, the length limit is 256 UTF-8 + // characters. * The attribute does not support search. The `searchable` field + // should be unset or set to false. * The max summed total bytes of custom + // attribute keys and values per product is 5MiB. Attributes map[string]GoogleCloudRetailV2alphaCustomAttribute `json:"attributes,omitempty"` - // FulfillmentTypes: Input only. Supported fulfillment types. Valid fulfillment + // Availability: Optional. The availability of the Product at this place_id. + // Default to Availability.IN_STOCK. For primary products with variants set the + // availability of the primary as Availability.OUT_OF_STOCK and set the true + // availability at the variant level. This way the primary product will be + // considered "in stock" as long as it has at least one variant in stock. For + // primary products with no variants set the true availability at the primary + // level. Corresponding properties: Google Merchant Center property + // availability (https://support.google.com/merchants/answer/6324448). + // Schema.org property Offer.availability (https://schema.org/availability). + // + // Possible values: + // "AVAILABILITY_UNSPECIFIED" - Default product availability. Default to + // Availability.IN_STOCK if unset. + // "IN_STOCK" - Product in stock. + // "OUT_OF_STOCK" - Product out of stock. + // "PREORDER" - Product that is in pre-order state. + // "BACKORDER" - Product that is back-ordered (i.e. temporarily out of + // stock). + Availability string `json:"availability,omitempty"` + // FulfillmentTypes: Optional. Supported fulfillment types. Valid fulfillment // type values include commonly used types (such as pickup in store and same // day delivery), and custom types. Customers have to map custom types to their // display names before rendering UI. Supported values: * "pickup-in-store" * @@ -4278,10 +4296,11 @@ type GoogleCloudRetailV2alphaLocalInventory struct { // an INVALID_ARGUMENT error is returned. All the elements must be distinct. // Otherwise, an INVALID_ARGUMENT error is returned. FulfillmentTypes []string `json:"fulfillmentTypes,omitempty"` - // PlaceId: The place ID for the current set of inventory information. + // PlaceId: Required. The place ID for the current set of inventory + // information. PlaceId string `json:"placeId,omitempty"` - // PriceInfo: Product price and cost information. Google Merchant Center - // property price (https://support.google.com/merchants/answer/6324371). + // PriceInfo: Optional. Product price and cost information. Google Merchant + // Center property price (https://support.google.com/merchants/answer/6324371). PriceInfo *GoogleCloudRetailV2alphaPriceInfo `json:"priceInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "Attributes") to // unconditionally include in API requests. By default, fields with empty or @@ -7616,7 +7635,7 @@ type GoogleCloudRetailV2alphaSearchResponse struct { // correction type is AUTOMATIC, then the search results are based on // corrected_query. Otherwise the original query is used for search. CorrectedQuery string `json:"correctedQuery,omitempty"` - // ExperimentInfo: Metadata related to A/B testing Experiment associated with + // ExperimentInfo: Metadata related to A/B testing experiment associated with // this response. Only exists when an experiment is triggered. ExperimentInfo []*GoogleCloudRetailV2alphaExperimentInfo `json:"experimentInfo,omitempty"` // Facets: Results of facets requested by user. @@ -8610,12 +8629,11 @@ type GoogleCloudRetailV2alphaUserInfo struct { // SearchRequest.user_info. * using the JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. IpAddress string `json:"ipAddress,omitempty"` - // UserAgent: User agent as included in the HTTP header. Required for getting - // SearchResponse.sponsored_results. The field must be a UTF-8 encoded string - // with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT - // error is returned. This should not be set when using the client side event - // reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or - // if direct_user_request is set. + // UserAgent: User agent as included in the HTTP header. The field must be a + // UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an + // INVALID_ARGUMENT error is returned. This should not be set when using the + // client side event reporting with GTM or JavaScript tag in + // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for // logged-in user, such as a user name. Don't set for anonymous users. Always diff --git a/retail/v2beta/retail-api.json b/retail/v2beta/retail-api.json index 6cb38ff3c50..3f3a67a1112 100644 --- a/retail/v2beta/retail-api.json +++ b/retail/v2beta/retail-api.json @@ -2391,7 +2391,7 @@ } } }, - "revision": "20241024", + "revision": "20241114", "rootUrl": "https://retail.googleapis.com/", "schemas": { "GoogleApiHttpBody": { @@ -4115,7 +4115,7 @@ "enumDescriptions": [ "Value used when unset. In this case, server behavior defaults to CATALOG_LEVEL_ATTRIBUTE_CONFIG.", "At this level, we honor the attribute configurations set in Product.attributes.", - "At this level, we honor the attribute configurations set in CatalogConfig.attribute_configs." + "At this level, we honor the attribute configurations set in `CatalogConfig.attribute_configs`." ], "readOnly": true, "type": "string" @@ -4251,7 +4251,7 @@ }, "partitionDate": { "$ref": "GoogleTypeDate", - "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format. Only supported in ImportProductsRequest." + "description": "BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format." }, "projectId": { "description": "The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.", @@ -4324,7 +4324,7 @@ "description": "Contains facet options." }, "inUse": { - "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", + "description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.", "readOnly": true, "type": "boolean" }, @@ -4870,7 +4870,7 @@ "type": "object" }, "GoogleCloudRetailV2betaExperimentInfo": { - "description": "Metadata for active A/B testing Experiment.", + "description": "Metadata for active A/B testing experiment.", "id": "GoogleCloudRetailV2betaExperimentInfo", "properties": { "experiment": { @@ -4889,7 +4889,7 @@ "id": "GoogleCloudRetailV2betaExperimentInfoServingConfigExperiment", "properties": { "experimentServingConfig": { - "description": "The fully qualified resource name of the serving config Experiment.VariantArm.serving_config_id responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", + "description": "The fully qualified resource name of the serving config `Experiment.VariantArm.serving_config_id` responsible for generating the search response. For example: `projects/*/locations/*/catalogs/*/servingConfigs/*`.", "type": "string" }, "originalServingConfig": { @@ -5501,23 +5501,41 @@ "additionalProperties": { "$ref": "GoogleCloudRetailV2betaCustomAttribute" }, - "description": "Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", + "description": "Optional. Additional local inventory attributes, for example, store name, promotion tags, etc. This field needs to pass all below criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. * The key must be a UTF-8 encoded string with a length limit of 32 characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same type (text or number). * Only 1 value is allowed for each attribute. * For text values, the length limit is 256 UTF-8 characters. * The attribute does not support search. The `searchable` field should be unset or set to false. * The max summed total bytes of custom attribute keys and values per product is 5MiB.", "type": "object" }, + "availability": { + "description": "Optional. The availability of the Product at this place_id. Default to Availability.IN_STOCK. For primary products with variants set the availability of the primary as Availability.OUT_OF_STOCK and set the true availability at the variant level. This way the primary product will be considered \"in stock\" as long as it has at least one variant in stock. For primary products with no variants set the true availability at the primary level. Corresponding properties: Google Merchant Center property [availability](https://support.google.com/merchants/answer/6324448). Schema.org property [Offer.availability](https://schema.org/availability).", + "enum": [ + "AVAILABILITY_UNSPECIFIED", + "IN_STOCK", + "OUT_OF_STOCK", + "PREORDER", + "BACKORDER" + ], + "enumDescriptions": [ + "Default product availability. Default to Availability.IN_STOCK if unset.", + "Product in stock.", + "Product out of stock.", + "Product that is in pre-order state.", + "Product that is back-ordered (i.e. temporarily out of stock)." + ], + "type": "string" + }, "fulfillmentTypes": { - "description": "Input only. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", + "description": "Optional. Supported fulfillment types. Valid fulfillment type values include commonly used types (such as pickup in store and same day delivery), and custom types. Customers have to map custom types to their display names before rendering UI. Supported values: * \"pickup-in-store\" * \"ship-to-store\" * \"same-day-delivery\" * \"next-day-delivery\" * \"custom-type-1\" * \"custom-type-2\" * \"custom-type-3\" * \"custom-type-4\" * \"custom-type-5\" If this field is set to an invalid value other than these, an INVALID_ARGUMENT error is returned. All the elements must be distinct. Otherwise, an INVALID_ARGUMENT error is returned.", "items": { "type": "string" }, "type": "array" }, "placeId": { - "description": "The place ID for the current set of inventory information.", + "description": "Required. The place ID for the current set of inventory information.", "type": "string" }, "priceInfo": { "$ref": "GoogleCloudRetailV2betaPriceInfo", - "description": "Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." + "description": "Optional. Product price and cost information. Google Merchant Center property [price](https://support.google.com/merchants/answer/6324371)." } }, "type": "object" @@ -7316,7 +7334,7 @@ "type": "string" }, "experimentInfo": { - "description": "Metadata related to A/B testing Experiment associated with this response. Only exists when an experiment is triggered.", + "description": "Metadata related to A/B testing experiment associated with this response. Only exists when an experiment is triggered.", "items": { "$ref": "GoogleCloudRetailV2betaExperimentInfo" }, @@ -7974,7 +7992,7 @@ "type": "string" }, "userAgent": { - "description": "User agent as included in the HTTP header. Required for getting SearchResponse.sponsored_results. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", + "description": "User agent as included in the HTTP header. The field must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned. This should not be set when using the client side event reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or if direct_user_request is set.", "type": "string" }, "userId": { diff --git a/retail/v2beta/retail-gen.go b/retail/v2beta/retail-gen.go index eec3befe218..3cd5ae3b878 100644 --- a/retail/v2beta/retail-gen.go +++ b/retail/v2beta/retail-gen.go @@ -2834,7 +2834,7 @@ type GoogleCloudRetailV2betaAttributesConfig struct { // "PRODUCT_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute // configurations set in Product.attributes. // "CATALOG_LEVEL_ATTRIBUTE_CONFIG" - At this level, we honor the attribute - // configurations set in CatalogConfig.attribute_configs. + // configurations set in `CatalogConfig.attribute_configs`. AttributeConfigLevel string `json:"attributeConfigLevel,omitempty"` // CatalogAttributes: Enable attribute(s) config at catalog level. For example, // indexable, dynamic_facetable, or searchable for each attribute. The key is @@ -3061,7 +3061,7 @@ type GoogleCloudRetailV2betaBigQuerySource struct { // the BigQuery export to a specific Cloud Storage directory. GcsStagingDir string `json:"gcsStagingDir,omitempty"` // PartitionDate: BigQuery time partitioned table's _PARTITIONDATE in - // YYYY-MM-DD format. Only supported in ImportProductsRequest. + // YYYY-MM-DD format. PartitionDate *GoogleTypeDate `json:"partitionDate,omitempty"` // ProjectId: The project ID (can be project # or ID) that the BigQuery source // is in with a length limit of 128 characters. If not specified, inherits the @@ -3158,8 +3158,7 @@ type GoogleCloudRetailV2betaCatalogAttribute struct { // InUse: Output only. Indicates whether this attribute has been used by any // products. `True` if at least one Product is using this attribute in // Product.attributes. Otherwise, this field is `False`. CatalogAttribute can - // be pre-loaded by using CatalogService.AddCatalogAttribute, - // CatalogService.ImportCatalogAttributes, or + // be pre-loaded by using CatalogService.AddCatalogAttribute or // CatalogService.UpdateAttributesConfig APIs. This field is `False` for // pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are // neither in use by products nor predefined can be deleted. Catalog attributes @@ -3970,7 +3969,7 @@ func (s *GoogleCloudRetailV2betaCustomAttribute) UnmarshalJSON(data []byte) erro } // GoogleCloudRetailV2betaExperimentInfo: Metadata for active A/B testing -// Experiment. +// experiment. type GoogleCloudRetailV2betaExperimentInfo struct { // Experiment: The fully qualified resource name of the experiment that // provides the serving config under test, should an active experiment exist. @@ -4003,7 +4002,7 @@ func (s GoogleCloudRetailV2betaExperimentInfo) MarshalJSON() ([]byte, error) { // active serving config A/B tests. type GoogleCloudRetailV2betaExperimentInfoServingConfigExperiment struct { // ExperimentServingConfig: The fully qualified resource name of the serving - // config Experiment.VariantArm.serving_config_id responsible for generating + // config `Experiment.VariantArm.serving_config_id` responsible for generating // the search response. For example: // `projects/*/locations/*/catalogs/*/servingConfigs/*`. ExperimentServingConfig string `json:"experimentServingConfig,omitempty"` @@ -5029,19 +5028,38 @@ func (s GoogleCloudRetailV2betaListServingConfigsResponse) MarshalJSON() ([]byte // GoogleCloudRetailV2betaLocalInventory: The inventory information at a place // (e.g. a store) identified by a place ID. type GoogleCloudRetailV2betaLocalInventory struct { - // Attributes: Additional local inventory attributes, for example, store name, - // promotion tags, etc. This field needs to pass all below criteria, otherwise - // an INVALID_ARGUMENT error is returned: * At most 30 attributes are allowed. - // * The key must be a UTF-8 encoded string with a length limit of 32 - // characters. * The key must match the pattern: `a-zA-Z0-9*`. For example, - // key0LikeThis or KEY_1_LIKE_THIS. * The attribute values must be of the same - // type (text or number). * Only 1 value is allowed for each attribute. * For - // text values, the length limit is 256 UTF-8 characters. * The attribute does - // not support search. The `searchable` field should be unset or set to false. - // * The max summed total bytes of custom attribute keys and values per product - // is 5MiB. + // Attributes: Optional. Additional local inventory attributes, for example, + // store name, promotion tags, etc. This field needs to pass all below + // criteria, otherwise an INVALID_ARGUMENT error is returned: * At most 30 + // attributes are allowed. * The key must be a UTF-8 encoded string with a + // length limit of 32 characters. * The key must match the pattern: + // `a-zA-Z0-9*`. For example, key0LikeThis or KEY_1_LIKE_THIS. * The attribute + // values must be of the same type (text or number). * Only 1 value is allowed + // for each attribute. * For text values, the length limit is 256 UTF-8 + // characters. * The attribute does not support search. The `searchable` field + // should be unset or set to false. * The max summed total bytes of custom + // attribute keys and values per product is 5MiB. Attributes map[string]GoogleCloudRetailV2betaCustomAttribute `json:"attributes,omitempty"` - // FulfillmentTypes: Input only. Supported fulfillment types. Valid fulfillment + // Availability: Optional. The availability of the Product at this place_id. + // Default to Availability.IN_STOCK. For primary products with variants set the + // availability of the primary as Availability.OUT_OF_STOCK and set the true + // availability at the variant level. This way the primary product will be + // considered "in stock" as long as it has at least one variant in stock. For + // primary products with no variants set the true availability at the primary + // level. Corresponding properties: Google Merchant Center property + // availability (https://support.google.com/merchants/answer/6324448). + // Schema.org property Offer.availability (https://schema.org/availability). + // + // Possible values: + // "AVAILABILITY_UNSPECIFIED" - Default product availability. Default to + // Availability.IN_STOCK if unset. + // "IN_STOCK" - Product in stock. + // "OUT_OF_STOCK" - Product out of stock. + // "PREORDER" - Product that is in pre-order state. + // "BACKORDER" - Product that is back-ordered (i.e. temporarily out of + // stock). + Availability string `json:"availability,omitempty"` + // FulfillmentTypes: Optional. Supported fulfillment types. Valid fulfillment // type values include commonly used types (such as pickup in store and same // day delivery), and custom types. Customers have to map custom types to their // display names before rendering UI. Supported values: * "pickup-in-store" * @@ -5051,10 +5069,11 @@ type GoogleCloudRetailV2betaLocalInventory struct { // an INVALID_ARGUMENT error is returned. All the elements must be distinct. // Otherwise, an INVALID_ARGUMENT error is returned. FulfillmentTypes []string `json:"fulfillmentTypes,omitempty"` - // PlaceId: The place ID for the current set of inventory information. + // PlaceId: Required. The place ID for the current set of inventory + // information. PlaceId string `json:"placeId,omitempty"` - // PriceInfo: Product price and cost information. Google Merchant Center - // property price (https://support.google.com/merchants/answer/6324371). + // PriceInfo: Optional. Product price and cost information. Google Merchant + // Center property price (https://support.google.com/merchants/answer/6324371). PriceInfo *GoogleCloudRetailV2betaPriceInfo `json:"priceInfo,omitempty"` // ForceSendFields is a list of field names (e.g. "Attributes") to // unconditionally include in API requests. By default, fields with empty or @@ -7973,7 +7992,7 @@ type GoogleCloudRetailV2betaSearchResponse struct { // correction type is AUTOMATIC, then the search results are based on // corrected_query. Otherwise the original query is used for search. CorrectedQuery string `json:"correctedQuery,omitempty"` - // ExperimentInfo: Metadata related to A/B testing Experiment associated with + // ExperimentInfo: Metadata related to A/B testing experiment associated with // this response. Only exists when an experiment is triggered. ExperimentInfo []*GoogleCloudRetailV2betaExperimentInfo `json:"experimentInfo,omitempty"` // Facets: Results of facets requested by user. @@ -8939,12 +8958,11 @@ type GoogleCloudRetailV2betaUserInfo struct { // SearchRequest.user_info. * using the JavaScript tag in // UserEventService.CollectUserEvent or if direct_user_request is set. IpAddress string `json:"ipAddress,omitempty"` - // UserAgent: User agent as included in the HTTP header. Required for getting - // SearchResponse.sponsored_results. The field must be a UTF-8 encoded string - // with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT - // error is returned. This should not be set when using the client side event - // reporting with GTM or JavaScript tag in UserEventService.CollectUserEvent or - // if direct_user_request is set. + // UserAgent: User agent as included in the HTTP header. The field must be a + // UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an + // INVALID_ARGUMENT error is returned. This should not be set when using the + // client side event reporting with GTM or JavaScript tag in + // UserEventService.CollectUserEvent or if direct_user_request is set. UserAgent string `json:"userAgent,omitempty"` // UserId: Highly recommended for logged-in users. Unique identifier for // logged-in user, such as a user name. Don't set for anonymous users. Always diff --git a/servicenetworking/v1/servicenetworking-api.json b/servicenetworking/v1/servicenetworking-api.json index fa4cc7cf9cd..68766c4cca3 100644 --- a/servicenetworking/v1/servicenetworking-api.json +++ b/servicenetworking/v1/servicenetworking-api.json @@ -111,7 +111,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "servicenetworking.operations.cancel", @@ -1029,7 +1029,7 @@ } } }, - "revision": "20241113", + "revision": "20241117", "rootUrl": "https://servicenetworking.googleapis.com/", "schemas": { "AddDnsRecordSetMetadata": { diff --git a/servicenetworking/v1/servicenetworking-gen.go b/servicenetworking/v1/servicenetworking-gen.go index c9abef27816..ba0f9a2c528 100644 --- a/servicenetworking/v1/servicenetworking-gen.go +++ b/servicenetworking/v1/servicenetworking-gen.go @@ -4942,7 +4942,7 @@ type OperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/verifiedaccess/v2/verifiedaccess-api.json b/verifiedaccess/v2/verifiedaccess-api.json index c7c3815d55a..5637a6fa092 100644 --- a/verifiedaccess/v2/verifiedaccess-api.json +++ b/verifiedaccess/v2/verifiedaccess-api.json @@ -146,7 +146,7 @@ } } }, - "revision": "20241001", + "revision": "20241112", "rootUrl": "https://verifiedaccess.googleapis.com/", "schemas": { "Challenge": { @@ -285,7 +285,7 @@ "type": "string" }, "osFirewall": { - "description": "The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. The signal is currently not available on MacOS 15 (Sequoia) and later.", + "description": "The state of the OS level firewall. On ChromeOS, the value will always be ENABLED on regular devices and UNKNOWN on devices in developer mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome M131.", "enum": [ "OS_FIREWALL_UNSPECIFIED", "OS_FIREWALL_UNKNOWN", diff --git a/verifiedaccess/v2/verifiedaccess-gen.go b/verifiedaccess/v2/verifiedaccess-gen.go index fd6117f0130..2ff314ae8c8 100644 --- a/verifiedaccess/v2/verifiedaccess-gen.go +++ b/verifiedaccess/v2/verifiedaccess-gen.go @@ -281,7 +281,8 @@ type DeviceSignals struct { OperatingSystem string `json:"operatingSystem,omitempty"` // OsFirewall: The state of the OS level firewall. On ChromeOS, the value will // always be ENABLED on regular devices and UNKNOWN on devices in developer - // mode. The signal is currently not available on MacOS 15 (Sequoia) and later. + // mode. Support for MacOS 15 (Sequoia) and later has been introduced in Chrome + // M131. // // Possible values: // "OS_FIREWALL_UNSPECIFIED" - Unspecified. diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json index 095c9726f9f..b9e5f1afd1f 100644 --- a/vision/v1/vision-api.json +++ b/vision/v1/vision-api.json @@ -229,7 +229,7 @@ "operations": { "methods": { "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "flatPath": "v1/operations/{operationsId}:cancel", "httpMethod": "POST", "id": "vision.operations.cancel", @@ -1282,7 +1282,7 @@ } } }, - "revision": "20240823", + "revision": "20241115", "rootUrl": "https://vision.googleapis.com/", "schemas": { "AddProductToProductSetRequest": { diff --git a/vision/v1/vision-gen.go b/vision/v1/vision-gen.go index bd095933334..60a9528bbaa 100644 --- a/vision/v1/vision-gen.go +++ b/vision/v1/vision-gen.go @@ -11982,7 +11982,7 @@ type OperationsCancelCall struct { // other methods to check whether the cancellation succeeded or whether the // operation completed despite cancellation. On successful cancellation, the // operation is not deleted; instead, it becomes an operation with an -// Operation.error value with a google.rpc.Status.code of 1, corresponding to +// Operation.error value with a google.rpc.Status.code of `1`, corresponding to // `Code.CANCELLED`. // // - name: The name of the operation resource to be cancelled. diff --git a/youtube/v3/youtube-api.json b/youtube/v3/youtube-api.json index 7b5d1a69a65..235409ff247 100644 --- a/youtube/v3/youtube-api.json +++ b/youtube/v3/youtube-api.json @@ -4133,7 +4133,7 @@ } } }, - "revision": "20241105", + "revision": "20241117", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -5612,6 +5612,10 @@ "$ref": "ChannelToStoreLinkDetailsBillingDetails", "description": "Information specific to billing (read-only)." }, + "merchantAffiliateProgramDetails": { + "$ref": "ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails", + "description": "Information specific to merchant affiliate program (read-only)." + }, "merchantId": { "description": "Google Merchant Center id of the store.", "format": "uint64", @@ -5651,6 +5655,29 @@ }, "type": "object" }, + "ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails": { + "description": "Information specific to merchant affiliate program.", + "id": "ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails", + "properties": { + "status": { + "description": "The current merchant affiliate program status.", + "enum": [ + "merchantAffiliateProgramStatusUnspecified", + "merchantAffiliateProgramStatusEligible", + "merchantAffiliateProgramStatusActive", + "merchantAffiliateProgramStatusPaused" + ], + "enumDescriptions": [ + "Unspecified status.", + "Merchant is eligible for the merchant affiliate program.", + "Merchant affiliate program is active.", + "Merchant affiliate program is paused." + ], + "type": "string" + } + }, + "type": "object" + }, "ChannelTopicDetails": { "description": "Freebase topic information related to the channel.", "id": "ChannelTopicDetails", diff --git a/youtube/v3/youtube-gen.go b/youtube/v3/youtube-gen.go index c71fac3755f..69b32b97571 100644 --- a/youtube/v3/youtube-gen.go +++ b/youtube/v3/youtube-gen.go @@ -2160,6 +2160,9 @@ func (s ChannelStatus) MarshalJSON() ([]byte, error) { type ChannelToStoreLinkDetails struct { // BillingDetails: Information specific to billing (read-only). BillingDetails *ChannelToStoreLinkDetailsBillingDetails `json:"billingDetails,omitempty"` + // MerchantAffiliateProgramDetails: Information specific to merchant affiliate + // program (read-only). + MerchantAffiliateProgramDetails *ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails `json:"merchantAffiliateProgramDetails,omitempty"` // MerchantId: Google Merchant Center id of the store. MerchantId uint64 `json:"merchantId,omitempty,string"` // StoreName: Name of the store. @@ -2212,6 +2215,38 @@ func (s ChannelToStoreLinkDetailsBillingDetails) MarshalJSON() ([]byte, error) { return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) } +// ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails: Information +// specific to merchant affiliate program. +type ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails struct { + // Status: The current merchant affiliate program status. + // + // Possible values: + // "merchantAffiliateProgramStatusUnspecified" - Unspecified status. + // "merchantAffiliateProgramStatusEligible" - Merchant is eligible for the + // merchant affiliate program. + // "merchantAffiliateProgramStatusActive" - Merchant affiliate program is + // active. + // "merchantAffiliateProgramStatusPaused" - Merchant affiliate program is + // paused. + Status string `json:"status,omitempty"` + // ForceSendFields is a list of field names (e.g. "Status") to unconditionally + // include in API requests. By default, fields with empty or default values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more + // details. + ForceSendFields []string `json:"-"` + // NullFields is a list of field names (e.g. "Status") to include in API + // requests with the JSON null value. By default, fields with empty values are + // omitted from API requests. See + // https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details. + NullFields []string `json:"-"` +} + +func (s ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails) MarshalJSON() ([]byte, error) { + type NoMethod ChannelToStoreLinkDetailsMerchantAffiliateProgramDetails + return gensupport.MarshalJSON(NoMethod(s), s.ForceSendFields, s.NullFields) +} + // ChannelTopicDetails: Freebase topic information related to the channel. type ChannelTopicDetails struct { // TopicCategories: A list of Wikipedia URLs that describe the channel's