+ invoke()
+
Returns the invoke Resource.
+Close httplib2 connections.
@@ -179,6 +184,7 @@
+ close()
Close httplib2 connections.
+
+ invoke(endpoint, invokeId, body=None, x__xgafv=None)
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+close()
+ Close httplib2 connections.+
invoke(endpoint, invokeId, body=None, x__xgafv=None)
+ Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+ endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ invokeId: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+ "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+
+ invoke()
+
Returns the invoke Resource.
+Close httplib2 connections.
@@ -193,6 +198,7 @@
+ close()
Close httplib2 connections.
+
+ invoke(endpoint, invokeId, body=None, x__xgafv=None)
Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+close()
+ Close httplib2 connections.+
invoke(endpoint, invokeId, body=None, x__xgafv=None)
+ Forwards arbitrary HTTP requests for both streaming and non-streaming cases. To use this method, invoke_route_prefix must be set to allow the paths that will be specified in the request.
+
+Args:
+ endpoint: string, Required. The name of the Endpoint requested to serve the prediction. Format: `projects/{project}/locations/{location}/endpoints/{endpoint}` (required)
+ invokeId: string, A parameter (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for PredictionService.Invoke.
+ "deployedModelId": "A String", # ID of the DeployedModel that serves the invoke request.
+ "httpBody": { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged. # The invoke method input. Supports HTTP headers and arbitrary data payload.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+ "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+ "data": "A String", # The HTTP request/response body as raw binary.
+ "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+}
+Returns the operations Resource.
+
+ ragDataSchemas()
+
Returns the ragDataSchemas Resource.
+ @@ -531,7 +536,7 @@
+ batchCreate(parent, body=None, x__xgafv=None)
Batch Create one or more RagDataSchemas
+
+ batchDelete(parent, body=None, x__xgafv=None)
Batch Deletes one or more RagDataSchemas
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, ragDataSchemaId=None, x__xgafv=None)
Creates a RagDataSchema.
+ +Deletes a RagDataSchema.
+ +Gets a RagDataSchema.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists RagDataSchemas in a Location.
+ +Retrieves the next page of results.
+batchCreate(parent, body=None, x__xgafv=None)
+ Batch Create one or more RagDataSchemas
+
+Args:
+ parent: string, Required. The resource name of the RagCorpus to create the RagDataSchemas in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for VertexRagDataService.BatchCreateRagDataSchemas.
+ "requests": [ # Required. The request messages for VertexRagDataService.CreateRagDataSchema. A maximum of 500 schemas can be created in a batch.
+ { # Request message for VertexRagDataService.CreateRagDataSchema.
+ "parent": "A String", # Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+ "ragDataSchema": { # The schema of the user specified metadata. # Required. The RagDataSchema to create.
+ "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
+ "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
+ "granularity": "A String", # The granularity associated with this RagMetadataSchema.
+ "listConfig": { # Config for List data type. # Config for List data type.
+ "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
+ },
+ "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
+ "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
+ },
+ "type": "A String", # Type of the metadata.
+ },
+ },
+ "ragDataSchemaId": "A String", # Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+batchDelete(parent, body=None, x__xgafv=None)
+ Batch Deletes one or more RagDataSchemas
+
+Args:
+ parent: string, Required. The resource name of the RagCorpus from which to delete the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for VertexRagDataService.BatchDeleteRagDataSchemas.
+ "names": [ # Required. The RagDataSchemas to delete. A maximum of 500 schemas can be deleted in a batch. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}`
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, ragDataSchemaId=None, x__xgafv=None)
+ Creates a RagDataSchema.
+
+Args:
+ parent: string, Required. The resource name of the RagCorpus to create the RagDataSchema in. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The schema of the user specified metadata.
+ "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
+ "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
+ "granularity": "A String", # The granularity associated with this RagMetadataSchema.
+ "listConfig": { # Config for List data type. # Config for List data type.
+ "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
+ },
+ "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
+ "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
+ },
+ "type": "A String", # Type of the metadata.
+ },
+}
+
+ ragDataSchemaId: string, Optional. The ID to use for the RagDataSchema, which will become the final component of the RagDataSchema's resource name if the user chooses to specify. Otherwise, RagDataSchema id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The schema of the user specified metadata.
+ "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
+ "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
+ "granularity": "A String", # The granularity associated with this RagMetadataSchema.
+ "listConfig": { # Config for List data type. # Config for List data type.
+ "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
+ },
+ "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
+ "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
+ },
+ "type": "A String", # Type of the metadata.
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes a RagDataSchema.
+
+Args:
+ name: string, Required. The name of the RagDataSchema resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets a RagDataSchema.
+
+Args:
+ name: string, Required. The name of the RagDataSchema resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The schema of the user specified metadata.
+ "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
+ "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
+ "granularity": "A String", # The granularity associated with this RagMetadataSchema.
+ "listConfig": { # Config for List data type. # Config for List data type.
+ "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
+ },
+ "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
+ "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
+ },
+ "type": "A String", # Type of the metadata.
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists RagDataSchemas in a Location.
+
+Args:
+ parent: string, Required. The resource name of the RagCorpus from which to list the RagDataSchemas. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}` (required)
+ pageSize: integer, Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
+ pageToken: string, Optional. The standard list page token. Typically obtained via ListRagDataSchemasResponse.next_page_token of the previous VertexRagDataService.ListRagDataSchemas call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for VertexRagDataService.ListRagDataSchemas.
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagDataSchemasRequest.page_token to obtain that page.
+ "ragDataSchemas": [ # List of RagDataSchemas in the requested page.
+ { # The schema of the user specified metadata.
+ "key": "A String", # Required. The key of this data schema. This key should be matching the key of user specified metadata and unique inside corpus. This value can be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ "name": "A String", # Identifier. Resource name of the data schema in the form of: `projects/{project_number}/locations/{location}/ragCorpora/{rag_corpus}/ragDataSchemas/{rag_data_schema}` where the {rag_data_schema} part should be the same as the `key` field below.
+ "schemaDetails": { # Data schema details indicates the data type and the data struct corresponding to the key of user specified metadata. # The schema details mapping to the key.
+ "granularity": "A String", # The granularity associated with this RagMetadataSchema.
+ "listConfig": { # Config for List data type. # Config for List data type.
+ "valueSchema": # Object with schema name: GoogleCloudAiplatformV1beta1RagMetadataSchemaDetails # The value's data type in the list.
+ },
+ "searchStrategy": { # The search strategy for the metadata value of the `key`. # The search strategy for the metadata value of the `key`.
+ "searchStrategyType": "A String", # The search strategy type to be applied on the metadata key.
+ },
+ "type": "A String", # Type of the metadata.
+ },
+ },
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
Returns the operations Resource.
+
+ ragMetadata()
+
Returns the ragMetadata Resource.
+Close httplib2 connections.
@@ -432,7 +437,7 @@
+ batchCreate(parent, body=None, x__xgafv=None)
Batch Create one or more RagMetadatas
+
+ batchDelete(parent, body=None, x__xgafv=None)
Batch Deletes one or more RagMetadata.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, ragMetadataId=None, x__xgafv=None)
Creates a RagMetadata.
+ +Deletes a RagMetadata.
+ +Gets a RagMetadata.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists RagMetadata in a RagFile.
+ +Retrieves the next page of results.
+
+ patch(name, body=None, x__xgafv=None)
Updates a RagMetadata.
+batchCreate(parent, body=None, x__xgafv=None)
+ Batch Create one or more RagMetadatas
+
+Args:
+ parent: string, Required. The parent resource where the RagMetadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for VertexRagDataService.BatchCreateRagMetadata.
+ "requests": [ # Required. The request messages for VertexRagDataService.CreateRagMetadata. A maximum of 500 rag file metadata can be created in a batch.
+ { # Request message for CreateRagMetadata.
+ "parent": "A String", # Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}`
+ "ragMetadata": { # Metadata for RagFile provided by users. # Required. The metadata to create.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+ },
+ "ragMetadataId": "A String", # Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+batchDelete(parent, body=None, x__xgafv=None)
+ Batch Deletes one or more RagMetadata.
+
+Args:
+ parent: string, Required. The resource name of the RagFile from which to delete the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for VertexRagDataService.BatchDeleteRagMetadata.
+ "names": [ # Required. The RagMetadata to delete. A maximum of 500 rag metadata can be deleted in a batch.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+close()
+ Close httplib2 connections.+
create(parent, body=None, ragMetadataId=None, x__xgafv=None)
+ Creates a RagMetadata.
+
+Args:
+ parent: string, Required. The parent resource where this metadata will be created. Format: `projects/{project_number}/locations/{location_id}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+}
+
+ ragMetadataId: string, Optional. The ID to use for the metadata, which will become the final component of the metadata's resource name if the user chooses to specify. Otherwise, metadata id will be generated by system. This value should be up to 63 characters, and valid characters are /a-z-/. The first character must be a letter, the last could be a letter or a number.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+}
+delete(name, x__xgafv=None)
+ Deletes a RagMetadata.
+
+Args:
+ name: string, Required. The name of the RagMetadata resource to be deleted. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets a RagMetadata.
+
+Args:
+ name: string, Required. The name of the RagMetadata resource. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists RagMetadata in a RagFile.
+
+Args:
+ parent: string, Required. The resource name of the RagFile from which to list the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}` (required)
+ pageSize: integer, Optional. The standard list page size. The maximum value is 100. If not specified, a default value of 100 will be used.
+ pageToken: string, Optional. The standard list page token. Typically obtained via ListRagMetadataResponse.next_page_token of the previous VertexRagDataService.ListRagMetadata call.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response message for VertexRagDataService.ListRagMetadata.
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass to ListRagMetadataRequest.page_token to obtain that page.
+ "ragMetadata": [ # List of RagMetadata in the requested page.
+ { # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+ },
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
patch(name, body=None, x__xgafv=None)
+ Updates a RagMetadata.
+
+Args:
+ name: string, Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Metadata for RagFile provided by users.
+ "name": "A String", # Identifier. Resource name of the RagMetadata. Format: `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}/ragFiles/{rag_file}/ragMetadata/{rag_metadata}`
+ "userSpecifiedMetadata": { # Metadata provided by users. # User provided metadata.
+ "key": "A String", # Required. Key of the metadata. The key must be set with type by CreateRagDataSchema.
+ "value": { # Value of Metadata, including all types available in data schema. # Value of the metadata. The value must be able to convert to the type according to the data schema.
+ "boolValue": True or False, # Value of boolean type metadata.
+ "datetimeValue": "A String", # Value of date time type metadata.
+ "floatValue": 3.14, # Value of float type metadata.
+ "intValue": "A String", # Value of int type metadata.
+ "listValue": { # List representation in metadata. # Value of list type metadata.
+ "values": [ # The values of `LIST` data type metadata.
+ # Object with schema name: GoogleCloudAiplatformV1beta1MetadataValue
+ ],
+ },
+ "strValue": "A String", # Value of string type metadata.
+ },
+ },
+}
+
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
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`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ 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`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+Returns the examples Resource.
+ +Returns the feedbackEntries Resource.
+ @@ -223,6 +228,7 @@
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
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`.
+
+ close()
Close httplib2 connections.
+ +Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+ +Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+ list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+ +Retrieves the next page of results.
+
+ wait(name, timeout=None, x__xgafv=None)
Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+cancel(name, x__xgafv=None)
+ 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`.
+
+Args:
+ name: string, The name of the operation resource to be cancelled. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+close()
+ Close httplib2 connections.+
delete(name, x__xgafv=None)
+ Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation resource to be deleted. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
+}
+get(name, x__xgafv=None)
+ Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
+
+Args:
+ name: string, The name of the operation resource. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+list(name, filter=None, pageSize=None, pageToken=None, returnPartialSuccess=None, x__xgafv=None)
+ Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
+
+Args:
+ name: string, The name of the operation's parent resource. (required)
+ filter: string, The standard list filter.
+ pageSize: integer, The standard list page size.
+ pageToken: string, The standard list page token.
+ returnPartialSuccess: boolean, When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `"projects/example/locations/-"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The response message for Operations.ListOperations.
+ "nextPageToken": "A String", # The standard List next-page token.
+ "operations": [ # A list of operations that matches the specified filter in the request.
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ },
+ ],
+ "unreachable": [ # Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.
+ "A String",
+ ],
+}
+list_next()
+ Retrieves the next page of results. + + Args: + previous_request: The request for the previous page. (required) + previous_response: The response from the request for the previous page. (required) + + Returns: + A request object that you can call 'execute()' on to request the next + page. Returns None if there are no more items in the collection. ++
wait(name, timeout=None, x__xgafv=None)
+ Waits until the specified long-running operation is done or reaches at most a specified timeout, returning the latest state. If the operation is already done, the latest state is immediately returned. If the timeout specified is greater than the default HTTP/RPC timeout, the HTTP/RPC timeout is used. If the server does not support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Note that this method is on a best-effort basis. It may return the latest state before the specified timeout (including immediately), meaning even an immediate response is no guarantee that the operation is done.
+
+Args:
+ name: string, The name of the operation resource to wait on. (required)
+ timeout: string, The maximum duration to wait before timing out. If left blank, the wait will be at most the time permitted by the underlying HTTP/RPC protocol. If RPC context deadline is also specified, the shorter one will be used.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+Returns the examples Resource.
+ +Returns the feedbackEntries Resource.
+ @@ -213,6 +218,7 @@Initializes the service related config for a project.
Args:
- name: string, Required. The resource name of the serviceConfig used to initialize the service. Format: `projects/{project_id}/locations/{location}/serviceConfig`. (required)
+ name: string, Required. The resource name of the serviceConfig used to initialize the service. The location must be the location of the BackupVault. Format: `projects/{project_id}/locations/{location}/serviceConfig`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for initializing the service.
+ "backupPlanLocation": "A String", # Optional. The location where the BackupPlan will be created. This field is required for multi-region BackupVaults and is optional for regional BackupVaults. It is useful when creating a Backup Vault in a multi-region, allowing the BackupPlan to reside in a specific region within that multi-region. If this field is not provided, the BackupPlan will be created in the same location as specified in the `name` field.
"cloudSqlInstanceInitializationConfig": { # CloudSqlInstanceInitializationConfig contains the configuration for initializing a Cloud SQL instance. # Optional. The configuration for initializing a Cloud SQL instance.
"edition": "A String", # Required. The edition of the Cloud SQL instance.
},
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index ea928209f6..85eb943146 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -267,7 +267,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -523,7 +523,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -725,6 +725,10 @@ Method Details
],
"incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
"disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query.
+ "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason.
+ "firstIncrementalRowTime": "A String", # Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
+ "incrementalRowCount": "A String", # Output only. Number of rows that were in the latest result set before query completion.
+ "lastIncrementalRowTime": "A String", # Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
"resultSetLastModifyTime": "A String", # Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
"resultSetLastReplaceTime": "A String", # Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.
},
@@ -1389,7 +1393,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -1789,7 +1793,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2045,7 +2049,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2247,6 +2251,10 @@ Method Details
],
"incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
"disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query.
+ "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason.
+ "firstIncrementalRowTime": "A String", # Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
+ "incrementalRowCount": "A String", # Output only. Number of rows that were in the latest result set before query completion.
+ "lastIncrementalRowTime": "A String", # Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
"resultSetLastModifyTime": "A String", # Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
"resultSetLastReplaceTime": "A String", # Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.
},
@@ -2911,7 +2919,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3194,7 +3202,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3399,7 +3407,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3655,7 +3663,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3857,6 +3865,10 @@ Method Details
],
"incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
"disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query.
+ "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason.
+ "firstIncrementalRowTime": "A String", # Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
+ "incrementalRowCount": "A String", # Output only. Number of rows that were in the latest result set before query completion.
+ "lastIncrementalRowTime": "A String", # Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
"resultSetLastModifyTime": "A String", # Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
"resultSetLastReplaceTime": "A String", # Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.
},
@@ -4521,7 +4533,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -4892,7 +4904,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -5148,7 +5160,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -5350,6 +5362,10 @@ Method Details
],
"incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
"disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query.
+ "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason.
+ "firstIncrementalRowTime": "A String", # Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
+ "incrementalRowCount": "A String", # Output only. Number of rows that were in the latest result set before query completion.
+ "lastIncrementalRowTime": "A String", # Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
"resultSetLastModifyTime": "A String", # Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
"resultSetLastReplaceTime": "A String", # Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.
},
@@ -6014,7 +6030,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -6408,7 +6424,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -6664,7 +6680,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -6868,6 +6884,10 @@ Method Details
],
"incrementalResultStats": { # Statistics related to Incremental Query Results. Populated as part of JobStatistics2. This feature is not yet available. # Output only. Statistics related to incremental query results, if enabled for the query. This feature is not yet available.
"disabledReason": "A String", # Output only. Reason why incremental query results are/were not written by the query.
+ "disabledReasonDetails": "A String", # Output only. Additional human-readable clarification, if available, for DisabledReason.
+ "firstIncrementalRowTime": "A String", # Output only. The time at which the first incremental result was written. If the query needed to restart internally, this only describes the final attempt.
+ "incrementalRowCount": "A String", # Output only. Number of rows that were in the latest result set before query completion.
+ "lastIncrementalRowTime": "A String", # Output only. The time at which the last incremental result was written. Does not include the final result written after query completion.
"resultSetLastModifyTime": "A String", # Output only. The time at which the result table's contents were modified. May be absent if no results have been written or the query has completed.
"resultSetLastReplaceTime": "A String", # Output only. The time at which the result table's contents were completely replaced. May be absent if no results have been written or the query has completed.
},
@@ -7532,7 +7552,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -7910,7 +7930,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
diff --git a/docs/dyn/bigquery_v2.tables.html b/docs/dyn/bigquery_v2.tables.html
index 4544a399a6..4ecf55e741 100644
--- a/docs/dyn/bigquery_v2.tables.html
+++ b/docs/dyn/bigquery_v2.tables.html
@@ -292,7 +292,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -449,7 +449,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -797,7 +797,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -954,7 +954,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -1243,7 +1243,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -1400,7 +1400,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -1797,7 +1797,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -1954,7 +1954,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2244,7 +2244,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2401,7 +2401,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2809,7 +2809,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -2966,7 +2966,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3256,7 +3256,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
@@ -3413,7 +3413,7 @@ Method Details
},
"collation": "A String", # Optional. Field collation can be set only when the type of field is STRING. The following values are supported: * 'und:ci': undetermined locale, case insensitive. * '': empty string. Default to case-sensitive behavior.
"dataPolicies": [ # Optional. Data policies attached to this field, used for field-level access control.
- { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column/).
+ { # Data policy option. For more information, see [Mask data by applying data policies to a column](https://docs.cloud.google.com/bigquery/docs/column-data-masking#data-policies-on-column).
"name": "A String", # Data policy resource name in the form of projects/project_id/locations/location_id/dataPolicies/data_policy_id.
},
],
diff --git a/docs/dyn/certificatemanager_v1.projects.locations.html b/docs/dyn/certificatemanager_v1.projects.locations.html
index c5a99c8e2f..9db4ee8eb7 100644
--- a/docs/dyn/certificatemanager_v1.projects.locations.html
+++ b/docs/dyn/certificatemanager_v1.projects.locations.html
@@ -112,7 +112,7 @@ Instance Methods
Gets information about a location.
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
-Lists information about the supported locations for this service.
+Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
@@ -151,7 +151,7 @@ Method Details
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists information about the supported locations for this service.
+ Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Args:
name: string, The resource that owns the locations collection, if applicable. (required)
diff --git a/docs/dyn/ces_v1.projects.locations.apps.html b/docs/dyn/ces_v1.projects.locations.apps.html
index 54bdd8eaab..361274d53c 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.html
@@ -238,6 +238,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -328,7 +331,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -373,7 +376,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -469,6 +472,9 @@ Method Details
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
+ "variables": { # Optional. The variables that are available for the tool execution.
+ "a_key": "", # Properties of the object.
+ },
}
x__xgafv: string, V1 error format.
@@ -480,7 +486,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.ExecuteTool.
- "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "response": { # The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
@@ -488,6 +494,9 @@ Method Details
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
+ "variables": { # The variable values at the end of the tool execution.
+ "a_key": "", # Properties of the object.
+ },
}
@@ -614,6 +623,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -704,7 +716,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -749,7 +761,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -897,6 +909,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -987,7 +1002,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1032,7 +1047,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1140,6 +1155,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1230,7 +1248,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1275,7 +1293,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1362,6 +1380,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1452,7 +1473,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1497,7 +1518,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1536,7 +1557,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.RetrieveToolSchema.
- "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the tool input parameters.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # The schema of the tool input parameters.
"additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: Schema
@@ -1561,7 +1582,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1569,7 +1590,7 @@ Method Details
"type": "A String", # Required. The type of the data.
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
},
- "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the tool output parameters.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # The schema of the tool output parameters.
"additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: Schema
@@ -1594,7 +1615,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1.projects.locations.apps.sessions.html b/docs/dyn/ces_v1.projects.locations.apps.sessions.html
index 2ca9abc2f4..30b4168dd4 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.sessions.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.sessions.html
@@ -240,7 +240,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
],
}
@@ -260,7 +260,7 @@ Method Details
"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text.
"citedChunks": [ # List of cited pieces of information.
{ # Piece of cited information.
- "text": "A String", # Text used for citaiton.
+ "text": "A String", # Text used for citation.
"title": "A String", # Title of the cited document.
"uri": "A String", # URI used for citation.
},
diff --git a/docs/dyn/ces_v1.projects.locations.apps.tools.html b/docs/dyn/ces_v1.projects.locations.apps.tools.html
index e339f54a73..c7281a1666 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.tools.html
@@ -139,7 +139,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -172,7 +172,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -385,7 +385,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -419,7 +419,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -530,7 +530,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -580,7 +580,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -613,7 +613,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -826,7 +826,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -860,7 +860,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -971,7 +971,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1047,7 +1047,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1080,7 +1080,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1293,7 +1293,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1327,7 +1327,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1438,7 +1438,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1501,7 +1501,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1534,7 +1534,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1747,7 +1747,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1781,7 +1781,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1892,7 +1892,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1959,7 +1959,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1992,7 +1992,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2205,7 +2205,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2239,7 +2239,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2350,7 +2350,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2400,7 +2400,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2433,7 +2433,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2646,7 +2646,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2680,7 +2680,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2791,7 +2791,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
index 467845ed77..cb27a20aa3 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.toolsets.html
@@ -1007,7 +1007,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.RetrieveTools.
- "tools": [ # Required. The list of tools that are included in the specified toolset.
+ "tools": [ # The list of tools that are included in the specified toolset.
{ # A tool represents an action that the CES agent can take to achieve certain goals.
"clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
"description": "A String", # Optional. The function description.
@@ -1037,7 +1037,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1070,7 +1070,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1283,7 +1283,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1317,7 +1317,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1428,7 +1428,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1.projects.locations.apps.versions.html b/docs/dyn/ces_v1.projects.locations.apps.versions.html
index 7f5f720a15..257b6cea09 100644
--- a/docs/dyn/ces_v1.projects.locations.apps.versions.html
+++ b/docs/dyn/ces_v1.projects.locations.apps.versions.html
@@ -298,6 +298,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -388,7 +391,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -433,7 +436,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -641,7 +644,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -674,7 +677,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -887,7 +890,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -921,7 +924,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1032,7 +1035,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1373,6 +1376,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1463,7 +1469,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1508,7 +1514,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1716,7 +1722,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1749,7 +1755,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1962,7 +1968,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1996,7 +2002,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2107,7 +2113,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2473,6 +2479,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -2563,7 +2572,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2608,7 +2617,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2816,7 +2825,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2849,7 +2858,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3062,7 +3071,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3096,7 +3105,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3207,7 +3216,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3560,6 +3569,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -3650,7 +3662,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3695,7 +3707,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3903,7 +3915,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3936,7 +3948,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4149,7 +4161,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4183,7 +4195,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4294,7 +4306,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html
index 56228a5514..1decb22cbb 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.html
@@ -92,7 +92,7 @@ Instance Methods
get(name, x__xgafv=None)
Gets details of the specified evaluation.
+ list(parent, evaluationFilter=None, evaluationRunFilter=None, filter=None, lastTenResults=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all evaluations in the given app.
@@ -352,7 +352,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -399,6 +399,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -952,6 +955,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1822,7 +1828,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -1869,6 +1875,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -2422,6 +2431,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -3318,7 +3330,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -3365,6 +3377,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -3918,6 +3933,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -4544,12 +4562,14 @@ Method Details
- list(parent, filter=None, lastTenResults=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ list(parent, evaluationFilter=None, evaluationRunFilter=None, filter=None, lastTenResults=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists all evaluations in the given app.
Args:
parent: string, Required. The resource name of the app to list evaluations from. (required)
- filter: string, Optional. Filter to be applied when listing the evaluations. See https://google.aip.dev/160 for more details. Currently supports filtering by the following fields: * evaluation_datasets, using the evaluation dataset ID in the format evaluation_datasets:evaluation_dataset_id. * tags, using the tag in the format tags:tag.
+ evaluationFilter: string, Optional. Filter to be applied on the evaluation when listing the evaluations. See https://google.aip.dev/160 for more details. Supported fields: evaluation_datasets
+ evaluationRunFilter: string, Optional. Filter string for fields on the associated EvaluationRun resources. See https://google.aip.dev/160 for more details. Supported fields: create_time, initiated_by, app_version_display_name
+ filter: string, Optional. Deprecated: Use evaluation_filter and evaluation_run_filter instead.
lastTenResults: boolean, Optional. Whether to include the last 10 evaluation results for each evaluation in the response.
orderBy: string, Optional. Field to sort by. Only "name" and "create_time", and "update_time" are supported. Time fields are ordered in descending order, and the name field is ordered in ascending order. If not included, "update_time" will be the default. See https://google.aip.dev/132#ordering for more details.
pageSize: integer, Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.
@@ -4801,7 +4821,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -4848,6 +4868,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -5401,6 +5424,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -6289,7 +6315,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -6336,6 +6362,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -6889,6 +6918,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -7759,7 +7791,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
},
],
@@ -7806,6 +7838,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -8359,6 +8394,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html
index 4a4b36d8b0..1d37341921 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.evaluations.results.html
@@ -166,6 +166,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -740,6 +743,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.html b/docs/dyn/ces_v1beta.projects.locations.apps.html
index b49460bef8..de1847cec2 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.html
@@ -272,6 +272,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -381,7 +384,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -426,7 +429,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -522,6 +525,9 @@ Method Details
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
+ "variables": { # Optional. The variables that are available for the tool execution.
+ "a_key": "", # Properties of the object.
+ },
}
x__xgafv: string, V1 error format.
@@ -533,7 +539,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.ExecuteTool.
- "response": { # Required. The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
+ "response": { # The tool execution result in JSON object format. Use "output" key to specify tool response and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as tool execution result.
"a_key": "", # Properties of the object.
},
"tool": "A String", # The name of the tool that got executed. Format: `projects/{project}/locations/{location}/apps/{app}/tools/{tool}`
@@ -541,6 +547,9 @@ Method Details
"toolId": "A String", # Optional. The tool ID to filter the tools to retrieve the schema for.
"toolset": "A String", # Required. The resource name of the Toolset from which this tool is derived. Format: `projects/{project}/locations/{location}/apps/{app}/toolsets/{toolset}`
},
+ "variables": { # The variable values at the end of the tool execution.
+ "a_key": "", # Properties of the object.
+ },
}
@@ -667,6 +676,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -776,7 +788,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -821,7 +833,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1020,6 +1032,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1129,7 +1144,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1174,7 +1189,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1282,6 +1297,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1391,7 +1409,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1436,7 +1454,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1523,6 +1541,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1632,7 +1653,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1677,7 +1698,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1716,7 +1737,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.RetrieveToolSchema.
- "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the tool input parameters.
+ "inputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # The schema of the tool input parameters.
"additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: Schema
@@ -1741,7 +1762,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1749,7 +1770,7 @@ Method Details
"type": "A String", # Required. The type of the data.
"uniqueItems": True or False, # Optional. Indicate the items in the array must be unique. Only applies to TYPE.ARRAY.
},
- "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # Required. The schema of the tool output parameters.
+ "outputSchema": { # Represents a select subset of an OpenAPI 3.0 schema object. # The schema of the tool output parameters.
"additionalProperties": # Object with schema name: Schema # Optional. Can either be a boolean or an object, controls the presence of additional properties.
"anyOf": [ # Optional. The value should be validated against any (one or more) of the subschemas in the list.
# Object with schema name: Schema
@@ -1774,7 +1795,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html
index 145eb5e736..75653ac049 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.sessions.html
@@ -240,7 +240,7 @@ Method Details
"variables": { # Optional. Contextual variables for the session, keyed by name. Only variables declared in the app will be used by the CES agent. Unrecognized variables will still be sent to the Dialogflow agent as additional session parameters.
"a_key": "", # Properties of the object.
},
- "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When `true`, the agent will defer processing until a subsequent message with `will_continue` set to `false` is received. Note: This flag has no effect on audio and DTMF inputs, which are always processed in real-time.
+ "willContinue": True or False, # Optional. A flag to indicate if the current message is a fragment of a larger input in the bidi streaming session. When set to `true`, the agent defers processing until it receives a subsequent message where `will_continue` is `false`, or until the system detects an endpoint in the audio input. NOTE: This field does not apply to audio and DTMF inputs, as they are always processed automatically based on the endpointing signal.
},
],
}
@@ -260,7 +260,7 @@ Method Details
"citations": { # Citations associated with the agent response. # Citations that provide the source information for the agent's generated text.
"citedChunks": [ # List of cited pieces of information.
{ # Piece of cited information.
- "text": "A String", # Text used for citaiton.
+ "text": "A String", # Text used for citation.
"title": "A String", # Title of the cited document.
"uri": "A String", # URI used for citation.
},
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
index 3a5fe99ac6..075f4a4d0d 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.tools.html
@@ -139,7 +139,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -172,7 +172,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -385,7 +385,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -419,7 +419,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -530,7 +530,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -580,7 +580,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -613,7 +613,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -826,7 +826,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -860,7 +860,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -971,7 +971,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1047,7 +1047,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1080,7 +1080,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1293,7 +1293,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1327,7 +1327,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1438,7 +1438,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1501,7 +1501,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1534,7 +1534,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1747,7 +1747,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1781,7 +1781,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1892,7 +1892,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1959,7 +1959,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1992,7 +1992,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2205,7 +2205,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2239,7 +2239,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2350,7 +2350,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2400,7 +2400,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2433,7 +2433,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2646,7 +2646,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2680,7 +2680,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2791,7 +2791,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
index cd8a744073..94e2f7693e 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.toolsets.html
@@ -1007,7 +1007,7 @@ Method Details
An object of the form:
{ # Response message for ToolService.RetrieveTools.
- "tools": [ # Required. The list of tools that are included in the specified toolset.
+ "tools": [ # The list of tools that are included in the specified toolset.
{ # A tool represents an action that the CES agent can take to achieve certain goals.
"clientFunction": { # Represents a client-side function that the agent can invoke. When the tool is chosen by the agent, control is handed off to the client. The client is responsible for executing the function and returning the result as a ToolResponse to continue the interaction with the agent. # Optional. The client function.
"description": "A String", # Optional. The function description.
@@ -1037,7 +1037,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1070,7 +1070,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1283,7 +1283,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1317,7 +1317,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1428,7 +1428,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
index 9cf3af3388..fa28def071 100644
--- a/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
+++ b/docs/dyn/ces_v1beta.projects.locations.apps.versions.html
@@ -298,6 +298,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -407,7 +410,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -452,7 +455,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -660,7 +663,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -693,7 +696,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -906,7 +909,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -940,7 +943,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1051,7 +1054,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1392,6 +1395,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -1501,7 +1507,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1546,7 +1552,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1754,7 +1760,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -1787,7 +1793,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2000,7 +2006,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2034,7 +2040,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2145,7 +2151,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2511,6 +2517,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -2620,7 +2629,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2665,7 +2674,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2873,7 +2882,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -2906,7 +2915,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3119,7 +3128,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3153,7 +3162,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3264,7 +3273,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3617,6 +3626,9 @@ Method Details
"expectationLevelMetricsThresholds": { # Expectation level metrics thresholds. # Optional. The expectation level metrics thresholds.
"toolInvocationParameterCorrectnessThreshold": 3.14, # Optional. The success threshold for individual tool invocation parameter correctness. Must be a float between 0 and 1. Default is 1.0.
},
+ "toolMatchingSettings": { # Settings for matching tool calls. # Optional. The tool matching settings. An extra tool call is a tool call that is present in the execution but does not match any tool call in the golden expectation.
+ "extraToolCallBehavior": "A String", # Optional. Behavior for extra tool calls. Defaults to FAIL.
+ },
"turnLevelMetricsThresholds": { # Turn level metrics thresholds. # Optional. The turn level metrics thresholds.
"overallToolInvocationCorrectnessThreshold": 3.14, # Optional. The success threshold for overall tool invocation correctness. Must be a float between 0 and 1. Default is 1.0.
"semanticSimilarityChannel": "A String", # Optional. The semantic similarity channel to use for evaluation.
@@ -3726,7 +3738,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3771,7 +3783,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -3979,7 +3991,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4012,7 +4024,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4225,7 +4237,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4259,7 +4271,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
@@ -4370,7 +4382,7 @@ Method Details
"properties": { # Optional. Properties of Type.OBJECT.
"a_key": # Object with schema name: Schema
},
- "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
+ "ref": "A String", # Optional. Allows indirect references between schema nodes. The value should be a valid reference to a child of the root `defs`. For example, the following schema defines a reference to a schema node named "Pet": ``` type: object properties: pet: ref: #/defs/Pet defs: Pet: type: object properties: name: type: string ``` The value of the "pet" property is a reference to the schema node named "Pet". See details in https://json-schema.org/understanding-json-schema/structuring.
"required": [ # Optional. Required properties of Type.OBJECT.
"A String",
],
diff --git a/docs/dyn/cloudresourcemanager_v3.tagBindings.html b/docs/dyn/cloudresourcemanager_v3.tagBindings.html
index 62a63799f9..d8faa4b35d 100644
--- a/docs/dyn/cloudresourcemanager_v3.tagBindings.html
+++ b/docs/dyn/cloudresourcemanager_v3.tagBindings.html
@@ -103,8 +103,8 @@ Method Details
body: object, The request body.
The object takes the form of:
-{ # A TagBinding represents a connection between a TagValue and a cloud resource Once a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.
- "name": "A String", # Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
+{ # A TagBinding represents a connection between a TagValue and a cloud resource. When a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.
+ "name": "A String", # Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`) or `tagBindings/{full-resource-name}/{tag-key-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagKeys/123`).
"parent": "A String", # The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`
"tagValue": "A String", # The TagValue of the TagBinding. Must be of the form `tagValues/456`.
"tagValueNamespacedName": "A String", # The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected.
@@ -194,8 +194,8 @@ Method Details
{ # The ListTagBindings response.
"nextPageToken": "A String", # Pagination token. If the result set is too large to fit in a single response, this token is returned. It encodes the position of the current result cursor. Feeding this value into a new list request with the `page_token` parameter gives the next page of the results. When `next_page_token` is not filled in, there is no next page and the list returned is the last page in the result set. Pagination tokens have a limited lifetime.
"tagBindings": [ # A possibly paginated list of TagBindings for the specified resource.
- { # A TagBinding represents a connection between a TagValue and a cloud resource Once a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.
- "name": "A String", # Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`).
+ { # A TagBinding represents a connection between a TagValue and a cloud resource. When a TagBinding is created, the TagValue is applied to all the descendants of the Google Cloud resource.
+ "name": "A String", # Output only. The name of the TagBinding. This is a String of the form: `tagBindings/{full-resource-name}/{tag-value-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagValues/456`) or `tagBindings/{full-resource-name}/{tag-key-name}` (e.g. `tagBindings/%2F%2Fcloudresourcemanager.googleapis.com%2Fprojects%2F123/tagKeys/123`).
"parent": "A String", # The full resource name of the resource the TagValue is bound to. E.g. `//cloudresourcemanager.googleapis.com/projects/123`
"tagValue": "A String", # The TagValue of the TagBinding. Must be of the form `tagValues/456`.
"tagValueNamespacedName": "A String", # The namespaced name for the TagValue of the TagBinding. Must be in the format `{parent_id}/{tag_key_short_name}/{short_name}`. For methods that support TagValue namespaced name, only one of tag_value_namespaced_name or tag_value may be filled. Requests with both fields will be rejected.
diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html
index 568dfde3dd..99430a9e67 100644
--- a/docs/dyn/composer_v1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1.projects.locations.environments.html
@@ -267,6 +267,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -606,6 +607,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -791,6 +793,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -1030,6 +1033,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index 85ab6dfa1c..852176a3a4 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -269,6 +269,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -610,6 +611,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -797,6 +799,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
@@ -1038,6 +1041,7 @@ Method Details
"networkingConfig": { # Configuration options for networking connections in the Composer 2 environment. # Optional. Configuration for the network connections configuration in the environment.
"connectionType": "A String", # Optional. Indicates the user requested specific connection type between Tenant and Customer projects. You cannot set networking connection type in public IP environment.
},
+ "networkingType": "A String", # Optional. Networking type for the environment, either private or public.
"privateClusterConfig": { # Configuration options for the private GKE cluster in a Cloud Composer environment. # Optional. Configuration for the private GKE cluster for a Private IP Cloud Composer environment.
"enablePrivateEndpoint": True or False, # Optional. If `true`, access to the public endpoint of the GKE cluster is denied.
"masterIpv4CidrBlock": "A String", # Optional. The CIDR block from which IPv4 range for GKE master will be reserved. If left blank, the default value of '172.16.0.0/23' is used.
diff --git a/docs/dyn/containeranalysis_v1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1.projects.locations.notes.html
index 8fcde6a531..e16c37acb0 100644
--- a/docs/dyn/containeranalysis_v1.projects.locations.notes.html
+++ b/docs/dyn/containeranalysis_v1.projects.locations.notes.html
@@ -125,7 +125,6 @@ Method Details
{ # Request to create notes in batch.
"notes": { # Required. The notes to create. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -283,6 +282,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -428,7 +428,6 @@ Method Details
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -586,6 +585,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -736,7 +736,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -894,6 +893,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1036,7 +1036,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1194,6 +1193,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1360,7 +1360,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1518,6 +1517,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1716,7 +1716,6 @@ Method Details
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1874,6 +1873,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -2036,7 +2036,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2194,6 +2193,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -2336,7 +2336,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2494,6 +2493,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
diff --git a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html
index bfdbea0a26..9ef5258179 100644
--- a/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html
+++ b/docs/dyn/containeranalysis_v1.projects.locations.occurrences.html
@@ -4639,7 +4639,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -4797,6 +4796,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
diff --git a/docs/dyn/containeranalysis_v1.projects.notes.html b/docs/dyn/containeranalysis_v1.projects.notes.html
index bd36a3a4fe..47aed03f74 100644
--- a/docs/dyn/containeranalysis_v1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1.projects.notes.html
@@ -125,7 +125,6 @@ Method Details
{ # Request to create notes in batch.
"notes": { # Required. The notes to create. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -283,6 +282,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -428,7 +428,6 @@ Method Details
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -586,6 +585,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -736,7 +736,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -894,6 +893,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1036,7 +1036,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1194,6 +1193,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1360,7 +1360,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1518,6 +1517,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -1716,7 +1716,6 @@ Method Details
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1874,6 +1873,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -2036,7 +2036,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2194,6 +2193,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
@@ -2336,7 +2336,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2494,6 +2493,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
diff --git a/docs/dyn/containeranalysis_v1.projects.occurrences.html b/docs/dyn/containeranalysis_v1.projects.occurrences.html
index 5dcd5e3673..316c3015c7 100644
--- a/docs/dyn/containeranalysis_v1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1.projects.occurrences.html
@@ -4639,7 +4639,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source feed.
"attestation": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -4797,6 +4796,7 @@ Method Details
},
},
"vulnerability": { # A security vulnerability that can be found in resources. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score of this vulnerability. CVSS score is on a scale of 0 - 10 where 0 indicates low severity and 10 indicates high severity.
"cvssV2": { # Common Vulnerability Scoring System. For details, see https://www.first.org/cvss/specification-document This is a message we will try to use for storing various versions of CVSS rather than making a separate proto for storing a specific version. # The full description of the v2 CVSS for this vulnerability.
"attackComplexity": "A String",
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
index 0ff12c6c69..967db3b716 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.notes.html
@@ -357,6 +357,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -679,6 +680,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1024,6 +1026,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1401,6 +1404,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1739,6 +1743,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2060,6 +2065,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
index 0b594f7d61..918f7a8346 100644
--- a/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1alpha1.projects.occurrences.html
@@ -3350,6 +3350,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html
index 4ae9d77802..20be06b12c 100644
--- a/docs/dyn/containeranalysis_v1alpha1.providers.notes.html
+++ b/docs/dyn/containeranalysis_v1alpha1.providers.notes.html
@@ -357,6 +357,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -679,6 +680,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1024,6 +1026,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1401,6 +1404,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1739,6 +1743,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2060,6 +2065,7 @@ Method Details
"title": "A String", # The title of the note. E.g. `Vex-Debian-11.4`
},
"vulnerabilityType": { # VulnerabilityType provides metadata about a security vulnerability. # A package vulnerability type of note.
+ "advisoryPublishTime": "A String", # Time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this Vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html
index 048c8a19b4..842429c47d 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.notes.html
@@ -125,7 +125,6 @@ Method Details
{ # Request to create notes in batch.
"notes": { # Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -297,6 +296,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -444,7 +444,6 @@ Method Details
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -616,6 +615,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -768,7 +768,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -940,6 +939,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1084,7 +1084,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1256,6 +1255,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1424,7 +1424,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1596,6 +1595,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1796,7 +1796,6 @@ Method Details
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1968,6 +1967,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2132,7 +2132,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2304,6 +2303,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2448,7 +2448,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2620,6 +2619,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html
index c5a92a98ec..a6e837efab 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.locations.occurrences.html
@@ -3254,7 +3254,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -3426,6 +3425,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.notes.html b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
index 949edb88fc..5dbbc5c926 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.notes.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.notes.html
@@ -125,7 +125,6 @@ Method Details
{ # Request to create notes in batch.
"notes": { # Required. The notes to create, the key is expected to be the note ID. Max allowed length is 1000.
"a_key": { # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -297,6 +296,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -444,7 +444,6 @@ Method Details
{ # Response for creating notes in batch.
"notes": [ # The notes that were created.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -616,6 +615,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -768,7 +768,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -940,6 +939,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1084,7 +1084,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1256,6 +1255,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1424,7 +1424,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1596,6 +1595,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -1796,7 +1796,6 @@ Method Details
"nextPageToken": "A String", # The next pagination token in the list response. It should be used as `page_token` for the following request. An empty value means no more results.
"notes": [ # The notes requested.
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -1968,6 +1967,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2132,7 +2132,6 @@ Method Details
The object takes the form of:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2304,6 +2303,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
@@ -2448,7 +2448,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -2620,6 +2619,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
index 5722e46f2e..3c9024e3bb 100644
--- a/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
+++ b/docs/dyn/containeranalysis_v1beta1.projects.occurrences.html
@@ -3254,7 +3254,6 @@ Method Details
An object of the form:
{ # A type of analysis that can be done for a resource.
- "advisoryPublishTime": "A String", # The timestamp when the advisory was first published by the source.
"attestationAuthority": { # Note kind that represents a logical attestation "role" or "authority". For example, an organization might have one `Authority` for "QA" and one for "build". This note is intended to act strictly as a grouping mechanism for the attached occurrences (Attestations). This grouping mechanism also provides a security boundary, since IAM ACLs gate the ability for a principle to attach an occurrence to a given note. It also provides a single point of lookup to find all attached attestation occurrences, even if they don't all live in the same project. # A note describing an attestation role.
"hint": { # This submessage provides human-readable hints about the purpose of the authority. Because the name of a note acts as its resource reference, it is important to disambiguate the canonical name of the Note (which might be a UUID for security purposes) from "readable" names more suitable for debug output. Note that these hints should not be used to look up authorities in security sensitive contexts, such as when looking up attestations to verify. # Hint hints at the purpose of the attestation authority.
"humanReadableName": "A String", # Required. The human readable name of this attestation authority, for example "qa".
@@ -3426,6 +3425,7 @@ Method Details
},
"updateTime": "A String", # Output only. The time this note was last updated. This field can be used as a filter in list requests.
"vulnerability": { # Vulnerability provides metadata about a security vulnerability in a Note. # A note describing a package vulnerability.
+ "advisoryPublishTime": "A String", # The time this advisory was published by the source.
"cvssScore": 3.14, # The CVSS score for this vulnerability.
"cvssV2": { # Common Vulnerability Scoring System. This message is compatible with CVSS v2 and v3. For CVSS v2 details, see https://www.first.org/cvss/v2/guide CVSS v2 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v2-calculator For CVSS v3 details, see https://www.first.org/cvss/specification-document CVSS v3 calculator: https://nvd.nist.gov/vuln-metrics/cvss/v3-calculator # The full description of the CVSS for version 2.
"attackComplexity": "A String", # Defined in CVSS v3, CVSS v2
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
index 0fda4012bd..9e28ded300 100644
--- a/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
+++ b/docs/dyn/datamanager_v1.accountTypes.accounts.partnerLinks.html
@@ -167,7 +167,7 @@ Method Details
Args:
parent: string, Required. Account to search for partner links. If no `filter` is specified, all partner links where this account is either the `owning_account` or `partner_account` are returned. Format: `accountTypes/{account_type}/accounts/{account}` (required)
- filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" OR partner_account.account_id = 987654321`
+ filter: string, Optional. A [filter string](//google.aip.dev/160). All fields need to be on the left hand side of each condition (for example: `partner_link_id = 123456789`). Supported operations: - `AND` - `=` - `!=` Supported fields: - `partner_link_id` - `owning_account.account_type` - `owning_account.account_id` - `partner_account.account_type` - `partner_account.account_id` Example: `owning_account.account_type = "GOOGLE_ADS" AND partner_account.account_id = 987654321`
pageSize: integer, The maximum number of partner links to return. The service may return fewer than this value. If unspecified, at most 10 partner links will be returned. The maximum value is 100; values above 100 will be coerced to 100.
pageToken: string, A page token, received from a previous `SearchPartnerLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchPartnerLinks` must match the call that provided the page token.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html
index 6cf0a8f4d6..b5e37dfbb4 100644
--- a/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html
+++ b/docs/dyn/datamanager_v1.accountTypes.accounts.userLists.html
@@ -128,11 +128,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
@@ -191,11 +191,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
@@ -279,11 +279,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
@@ -354,11 +354,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
@@ -434,11 +434,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
@@ -498,11 +498,11 @@ Method Details
"keySpace": "A String", # Required. Immutable. The key space of mobile IDs.
},
"pairIdInfo": { # Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners. # Optional. Additional information when `PAIR_ID` is one of the `upload_key_types`. This feature is only available to data partners.
- "advertiserIdentifierCount": "A String", # Output only. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
+ "advertiserIdentifierCount": "A String", # Optional. The count of the advertiser's first party data records that have been uploaded to a clean room provider. This does not signify the size of a PAIR user list.
"cleanRoomIdentifier": "A String", # Required. Immutable. Identifies a unique advertiser to publisher relationship with one clean room provider or across multiple clean room providers.
- "matchRatePercentage": 42, # Output only. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
+ "matchRatePercentage": 42, # Optional. This field denotes the percentage of membership match of this user list with the corresponding publisher's first party data. Must be between 0 and 100 inclusive.
"publisherId": "A String", # Required. Immutable. Identifies the publisher that the Publisher Advertiser Identity Reconciliation user list is reconciled with. This field is provided by the cleanroom provider and is only unique in the scope of that cleanroom. This cannot be used as a global identifier across multiple cleanrooms.
- "publisherName": "A String", # Optional. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
+ "publisherName": "A String", # Required. Descriptive name of the publisher to be displayed in the UI for a better targeting experience.
},
"partnerAudienceInfo": { # Additional information for partner audiences. This feature is only available to data partners. # Optional. Additional information for partner audiences. This feature is only available to data partners.
"commercePartner": "A String", # Optional. The commerce partner name. Only allowed if `partner_audience_source` is `COMMERCE_AUDIENCE`.
diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
index 53467c8a14..eef6c9c312 100644
--- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
+++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html
@@ -418,6 +418,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -606,6 +614,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -671,6 +687,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -767,6 +791,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1132,6 +1164,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1320,6 +1360,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1385,6 +1433,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1481,6 +1537,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1873,6 +1937,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2061,6 +2133,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2126,6 +2206,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2222,6 +2310,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2678,6 +2774,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2866,6 +2970,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2931,6 +3043,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3027,6 +3147,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3433,6 +3561,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3621,6 +3757,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3686,6 +3830,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3782,6 +3934,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4256,6 +4416,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4444,6 +4612,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4509,6 +4685,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4605,6 +4789,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4970,6 +5162,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5158,6 +5358,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5223,6 +5431,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5319,6 +5535,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html
index 57eadef2e8..86315da3d6 100644
--- a/docs/dyn/dataproc_v1.projects.regions.clusters.html
+++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html
@@ -162,6 +162,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -350,6 +358,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -415,6 +431,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -511,6 +535,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -825,6 +857,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1013,6 +1053,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1078,6 +1126,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1174,6 +1230,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1449,6 +1513,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1637,6 +1709,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1702,6 +1782,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1798,6 +1886,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1993,6 +2089,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2181,6 +2285,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2246,6 +2358,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2342,6 +2462,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html
index 4c5e78f740..2772dd0dcc 100644
--- a/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html
+++ b/docs/dyn/dataproc_v1.projects.regions.clusters.nodeGroups.html
@@ -117,6 +117,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -235,6 +243,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
diff --git a/docs/dyn/dataproc_v1.projects.regions.jobs.html b/docs/dyn/dataproc_v1.projects.regions.jobs.html
index 2bb9063e18..226146c175 100644
--- a/docs/dyn/dataproc_v1.projects.regions.jobs.html
+++ b/docs/dyn/dataproc_v1.projects.regions.jobs.html
@@ -769,7 +769,7 @@ Method Details
projectId: string, Required. The ID of the Google Cloud Platform project that the job belongs to. (required)
region: string, Required. The Dataproc region in which to handle the request. (required)
clusterName: string, Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.
- filter: string, Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *
+ filter: string, Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or insertTime, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Allows insertTime to be a timestamp in RFC 3339 format in double quotes, such as 2025-01-01T00:00:00Z. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = * AND insertTime <= "2025-01-01T00:00:00Z"
jobStateMatcher: string, Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.
Allowed values
ALL - Match all jobs, regardless of state.
diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
index 7cba9bb987..064baddfe5 100644
--- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
+++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html
@@ -418,6 +418,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -606,6 +614,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -671,6 +687,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -767,6 +791,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1132,6 +1164,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1320,6 +1360,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1385,6 +1433,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1481,6 +1537,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -1873,6 +1937,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2061,6 +2133,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2126,6 +2206,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2222,6 +2310,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2678,6 +2774,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2866,6 +2970,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -2931,6 +3043,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3027,6 +3147,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3433,6 +3561,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3621,6 +3757,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3686,6 +3830,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -3782,6 +3934,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4256,6 +4416,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4444,6 +4612,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4509,6 +4685,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4605,6 +4789,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -4970,6 +5162,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5158,6 +5358,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5223,6 +5431,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
@@ -5319,6 +5535,14 @@ Method Details
},
],
"diskConfig": { # Specifies the config of boot disk and attached disk options for a group of VM instances. # Optional. Disk option config settings.
+ "attachedDiskConfigs": [ # Optional. A list of attached disk configs for a group of VM instances.
+ { # Specifies the config of attached disk options for single VM instance.
+ "diskSizeGb": 42, # Optional. Disk size in GB.
+ "diskType": "A String", # Optional. Disk type.
+ "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the attached disk. This sets the number of I/O operations per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the attached disk. This sets the number of throughput mb per second that the disk can handle. See https://cloud.google.com/compute/docs/disks/hyperdisks#hyperdisk-features
+ },
+ ],
"bootDiskProvisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskProvisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be greater than or equal to 1. This field is supported only if boot_disk_type is hyperdisk-balanced.
"bootDiskSizeGb": 42, # Optional. Size in GB of the boot disk (default is 500GB).
diff --git a/docs/dyn/developerconnect_v1.projects.locations.connections.html b/docs/dyn/developerconnect_v1.projects.locations.connections.html
index b89ee2c33f..49c2e22fef 100644
--- a/docs/dyn/developerconnect_v1.projects.locations.connections.html
+++ b/docs/dyn/developerconnect_v1.projects.locations.connections.html
@@ -247,8 +247,8 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
- "secureSourceManagerInstanceConfig": { # Configuration for connections to SSM instance # Configuration for connections to an instance of Secure Source Manager.
- "instance": "A String", # Required. Immutable. SSM instance resource, formatted as `projects/*/locations/*/instances/*`
+ "secureSourceManagerInstanceConfig": { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
+ "instance": "A String", # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
},
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
@@ -523,8 +523,8 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
- "secureSourceManagerInstanceConfig": { # Configuration for connections to SSM instance # Configuration for connections to an instance of Secure Source Manager.
- "instance": "A String", # Required. Immutable. SSM instance resource, formatted as `projects/*/locations/*/instances/*`
+ "secureSourceManagerInstanceConfig": { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
+ "instance": "A String", # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
},
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
@@ -671,8 +671,8 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
- "secureSourceManagerInstanceConfig": { # Configuration for connections to SSM instance # Configuration for connections to an instance of Secure Source Manager.
- "instance": "A String", # Required. Immutable. SSM instance resource, formatted as `projects/*/locations/*/instances/*`
+ "secureSourceManagerInstanceConfig": { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
+ "instance": "A String", # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
},
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
@@ -828,8 +828,8 @@ Method Details
},
"name": "A String", # Identifier. The resource name of the connection, in the format `projects/{project}/locations/{location}/connections/{connection_id}`.
"reconciling": True or False, # Output only. Set to true when the connection is being set up or updated in the background.
- "secureSourceManagerInstanceConfig": { # Configuration for connections to SSM instance # Configuration for connections to an instance of Secure Source Manager.
- "instance": "A String", # Required. Immutable. SSM instance resource, formatted as `projects/*/locations/*/instances/*`
+ "secureSourceManagerInstanceConfig": { # Configuration for connections to Secure Source Manager instance # Configuration for connections to an instance of Secure Source Manager.
+ "instance": "A String", # Required. Immutable. Secure Source Manager instance resource, formatted as `projects/*/locations/*/instances/*`
},
"uid": "A String", # Output only. A system-assigned unique identifier for the Connection.
"updateTime": "A String", # Output only. [Output only] Update timestamp
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
index 4f588f681f..f23cb0db42 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.dataStores.sessions.html
@@ -944,7 +944,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
index a5af7cde14..c8b1ac5f66 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.html
@@ -218,6 +218,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -243,6 +244,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -395,6 +397,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -420,6 +423,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -548,6 +552,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -573,6 +578,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -673,6 +679,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -698,6 +705,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -780,6 +788,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -805,6 +814,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
index 7fad073a49..d9ea70d05e 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.engines.sessions.html
@@ -944,7 +944,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1.projects.locations.collections.html b/docs/dyn/discoveryengine_v1.projects.locations.collections.html
index 9af3a037d2..d2de23f459 100644
--- a/docs/dyn/discoveryengine_v1.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1.projects.locations.collections.html
@@ -218,6 +218,9 @@ Method Details
},
},
],
+ "egressFqdns": [ # Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes.
+ "A String",
+ ],
"endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
"additionalParams": { # Optional. Any additional parameters needed for EUA.
"a_key": "", # Properties of the object.
@@ -351,6 +354,7 @@ Method Details
"staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
"syncMode": "A String", # The data synchronization mode supported by the data connector.
"updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+ "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose.
}
@@ -420,6 +424,9 @@ Close httplib2 connections.
create(parent, body=None, licenseConfigId=None, x__xgafv=None)
Creates a LicenseConfig
+Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Gets a LicenseConfig.
@@ -94,7 +94,7 @@create(parent, body=None, licenseConfigId=None, x__xgafv=None)
- Creates a LicenseConfig
+ Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
index dc08ba18d7..9242cf79e1 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.dataStores.sessions.html
@@ -1088,7 +1088,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
index fab9e24a45..0f467286ff 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.html
@@ -235,6 +235,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -260,6 +261,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -421,6 +423,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -446,6 +449,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -602,6 +606,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -627,6 +632,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -736,6 +742,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -761,6 +768,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -852,6 +860,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -877,6 +886,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -980,6 +990,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -1005,6 +1016,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
@@ -1108,6 +1120,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -1133,6 +1146,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"recommendationMetadata": { # Additional information of a recommendation engine. # Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
"dataState": "A String", # Output only. The state of data requirements for this engine: `DATA_OK` and `DATA_ERROR`. Engine cannot be trained if the data is in `DATA_ERROR` state. Engine can have `DATA_ERROR` state even if serving state is `ACTIVE`: engines were trained successfully before, but cannot be refreshed because the underlying engine no longer has sufficient data for training.
"lastTrainTime": "A String", # Output only. The timestamp when the latest successful training finished. Only applicable on Media Recommendation engines.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
index 60f0d2a235..c49ffefb6a 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.engines.sessions.html
@@ -1103,7 +1103,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
index 3c05ffdb19..beca64c9f9 100644
--- a/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
+++ b/docs/dyn/discoveryengine_v1alpha.projects.locations.collections.html
@@ -237,6 +237,9 @@ Method Details
},
},
],
+ "egressFqdns": [ # Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes.
+ "A String",
+ ],
"endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
"additionalParams": { # Optional. Any additional parameters needed for EUA.
"a_key": "", # Properties of the object.
@@ -390,6 +393,7 @@ Method Details
"staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
"syncMode": "A String", # The data synchronization mode supported by the data connector.
"updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+ "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose.
},
"displayName": "A String", # Required. The Collection display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
"name": "A String", # Immutable. The full resource name of the Collection. Format: `projects/{project}/locations/{location}/collections/{collection_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
@@ -472,6 +476,9 @@ Method Details
},
},
],
+ "egressFqdns": [ # Output only. The list of FQDNs of the data connector can egress to. This includes both FQDN derived from the customer provided instance URL and default per connector type FQDNs. Note: This field is derived from both the DataConnector.params, and connector source spec. It should only be used for CAIS and Org Policy evaluation purposes.
+ "A String",
+ ],
"endUserConfig": { # Any params and credentials used specifically for EUA connectors. # Optional. Any params and credentials used specifically for EUA connectors.
"additionalParams": { # Optional. Any additional parameters needed for EUA.
"a_key": "", # Properties of the object.
@@ -625,6 +632,7 @@ Method Details
"staticIpEnabled": True or False, # Optional. Whether customer has enabled static IP addresses for this connector.
"syncMode": "A String", # The data synchronization mode supported by the data connector.
"updateTime": "A String", # Output only. Timestamp the DataConnector was last updated.
+ "vpcscEnabled": True or False, # Output only. Whether the connector is created with VPC-SC enabled. This is only used for CuOP evaluation purpose.
}
Close httplib2 connections.
create(parent, body=None, licenseConfigId=None, x__xgafv=None)
Creates a LicenseConfig
+Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Gets a LicenseConfig.
@@ -94,7 +94,7 @@create(parent, body=None, licenseConfigId=None, x__xgafv=None)
- Creates a LicenseConfig
+ Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html
index c4322c28ee..a1ae9cf4b3 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.dataStores.sessions.html
@@ -989,7 +989,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
index f551fae328..a7051e45f2 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.html
@@ -222,6 +222,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -247,6 +248,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -399,6 +401,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -424,6 +427,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -552,6 +556,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -577,6 +582,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -677,6 +683,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -702,6 +709,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -784,6 +792,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -809,6 +818,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -903,6 +913,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -928,6 +939,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
@@ -1022,6 +1034,7 @@ Method Details
"A String",
],
},
+ "marketplaceAgentVisibility": "A String", # Optional. The visibility of marketplace agents in the agent gallery.
"mediaRecommendationEngineConfig": { # Additional config specs for a Media Recommendation engine. # Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
"engineFeaturesConfig": { # More feature configs of the selected engine type. # Optional. Additional engine features config.
"mostPopularConfig": { # Feature configurations that are required for creating a Most Popular engine. # Most popular engine feature config.
@@ -1047,6 +1060,7 @@ Method Details
"observabilityEnabled": True or False, # Optional. Enables observability. If false, all other flags are ignored.
"sensitiveLoggingEnabled": True or False, # Optional. Enables sensitive logging. Sensitive logging includes customer core content (e.g. prompts, responses). If false, will sanitize all sensitive fields.
},
+ "procurementContactEmail": "A String", # Optional. The email of the procurement contact.
"searchEngineConfig": { # Configurations for a Search Engine. # Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
"requiredSubscriptionTier": "A String", # Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine.
"searchAddOns": [ # The add-on that this search engine enables.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html
index aa69abec37..17b5c448b0 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.collections.engines.sessions.html
@@ -989,7 +989,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html
index dd4e60e34f..d4df0aca81 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.dataStores.sessions.html
@@ -989,7 +989,7 @@ Method Details
Args:
parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store_id}` (required)
- filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"`
+ filter: string, A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"`
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time.
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page.
diff --git a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
index a33970d746..009b91e8b4 100644
--- a/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
+++ b/docs/dyn/discoveryengine_v1beta.projects.locations.licenseConfigs.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, licenseConfigId=None, x__xgafv=None)
-Creates a LicenseConfig
+Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Gets a LicenseConfig.
@@ -94,7 +94,7 @@ Method Details
create(parent, body=None, licenseConfigId=None, x__xgafv=None)
- Creates a LicenseConfig
+ Creates a LicenseConfig This method should only be used for creating NotebookLm licenses or Gemini Enterprise free trial licenses.
Args:
parent: string, Required. The parent resource name, such as `projects/{project}/locations/{location}`. (required)
diff --git a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html
index 5ed64dac1d..c6689aa70f 100644
--- a/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html
+++ b/docs/dyn/displayvideo_v2.advertisers.insertionOrders.html
@@ -112,11 +112,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -205,11 +205,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -325,11 +325,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -431,11 +431,11 @@ Method Details
"insertionOrders": [ # The list of insertion orders. This list will be absent if empty.
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -544,11 +544,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -638,11 +638,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
diff --git a/docs/dyn/displayvideo_v2.advertisers.lineItems.html b/docs/dyn/displayvideo_v2.advertisers.lineItems.html
index 8ebf2c1868..3da5030708 100644
--- a/docs/dyn/displayvideo_v2.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v2.advertisers.lineItems.html
@@ -801,7 +801,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1032,7 +1032,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1223,7 +1223,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1469,7 +1469,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1673,7 +1673,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1884,7 +1884,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -2076,7 +2076,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
diff --git a/docs/dyn/displayvideo_v3.advertisers.adGroups.html b/docs/dyn/displayvideo_v3.advertisers.adGroups.html
index 3c0732eefb..c51de5c5aa 100644
--- a/docs/dyn/displayvideo_v3.advertisers.adGroups.html
+++ b/docs/dyn/displayvideo_v3.advertisers.adGroups.html
@@ -494,7 +494,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -533,7 +533,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
}
@@ -566,7 +566,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -605,7 +605,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
},
],
diff --git a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html
index 982156ead3..a389f66861 100644
--- a/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html
+++ b/docs/dyn/displayvideo_v3.advertisers.insertionOrders.html
@@ -112,11 +112,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -212,11 +212,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -339,11 +339,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -452,11 +452,11 @@ Method Details
"insertionOrders": [ # The list of insertion orders. This list will be absent if empty.
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -572,11 +572,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -673,11 +673,11 @@ Method Details
{ # A single insertion order.
"advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set.
+ "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated.
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
diff --git a/docs/dyn/displayvideo_v3.advertisers.lineItems.html b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
index c3289e99e7..fb7c2eb6dd 100644
--- a/docs/dyn/displayvideo_v3.advertisers.lineItems.html
+++ b/docs/dyn/displayvideo_v3.advertisers.lineItems.html
@@ -887,7 +887,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -988,7 +988,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -1118,7 +1118,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1219,7 +1219,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -1309,7 +1309,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1410,7 +1410,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -1555,7 +1555,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1656,7 +1656,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -1759,7 +1759,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -1860,7 +1860,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -1970,7 +1970,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -2071,7 +2071,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
@@ -2162,7 +2162,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -2263,7 +2263,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
"updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
"warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
diff --git a/docs/dyn/displayvideo_v4.advertisers.adGroups.html b/docs/dyn/displayvideo_v4.advertisers.adGroups.html
index bb08cfbf9a..b290e62081 100644
--- a/docs/dyn/displayvideo_v4.advertisers.adGroups.html
+++ b/docs/dyn/displayvideo_v4.advertisers.adGroups.html
@@ -499,7 +499,7 @@ Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
"bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
},
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
+ "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
"customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
"maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
"performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
@@ -538,7 +538,7 @@ Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # Optional. The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the ad group.
"audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
"audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
+ "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`.
},
}
- targetingTypes()
-
Returns the targetingTypes Resource.
-Close httplib2 connections.
@@ -94,12 +89,6 @@
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists campaigns in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, campaigns with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
- -Lists assigned targeting options of a campaign across targeting types.
-
- listAssignedTargetingOptions_next()
Retrieves the next page of results.
Retrieves the next page of results.
@@ -477,371 +466,6 @@listAssignedTargetingOptions(advertiserId, campaignId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists assigned targeting options of a campaign across targeting types.
-
-Args:
- advertiserId: string, Required. The ID of the advertiser the campaign belongs to. (required)
- campaignId: string, Required. The ID of the campaign to list assigned targeting options for. (required)
- filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the `OR` logical operator. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_LANGUAGE` or `TARGETING_TYPE_GENDER`: `targetingType="TARGETING_TYPE_LANGUAGE" OR targetingType="TARGETING_TYPE_GENDER"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
- orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
- pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
- pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListCampaignAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
- { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
- "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
- "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
- },
- "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- "displayName": "A String", # Output only. The display name of the app category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- },
- "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
- "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
- "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
- "displayName": "A String", # Output only. The display name of the app.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
- "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
- "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
- "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
- { # Details of first party and partner audience targeting setting.
- "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
- "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
- "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
- { # Details of combined audience targeting setting.
- "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
- },
- ],
- },
- "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
- "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
- { # Details of custom list targeting setting.
- "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
- },
- ],
- },
- "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
- { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
- "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
- { # Details of first party and partner audience targeting setting.
- "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
- "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- ],
- "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- },
- "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
- "audioContentType": "A String", # Required. The audio content type.
- },
- "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
- "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
- },
- "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
- "displayName": "A String", # Output only. The display name of the browser.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
- },
- "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
- "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
- },
- "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
- "displayName": "A String", # Output only. The display name of the carrier or ISP.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
- },
- "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
- "displayName": "A String", # Output only. The display name of the category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
- },
- "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
- "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
- "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
- },
- "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- "contentDuration": "A String", # Output only. The content duration.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- },
- "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- "displayName": "A String", # Output only. The display name of the content genre.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- },
- "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
- "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
- },
- "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "contentOutstreamPosition": "A String", # Required. The content outstream position.
- },
- "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- "contentStreamType": "A String", # Output only. The content stream type.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- },
- "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
- "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
- "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
- "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
- },
- "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
- "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
- "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
- "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
- "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
- },
- "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- "displayName": "A String", # Output only. The display name of the device make and model.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- },
- "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
- "deviceType": "A String", # Required. The display name of the device type.
- "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
- },
- "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
- "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
- },
- "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
- "environment": "A String", # Required. The serving environment.
- },
- "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
- "exchange": "A String", # Required. The enum value for the exchange.
- },
- "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
- "gender": "A String", # Required. The gender of the audience.
- },
- "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
- "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
- "geoRegionType": "A String", # Output only. The type of geographic region targeting.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
- },
- "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
- "householdIncome": "A String", # Required. The household income of the audience.
- },
- "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
- "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
- "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
- },
- "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
- "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
- },
- "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
- "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
- "displayName": "A String", # Output only. The display name of the language (e.g., "French").
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
- },
- "name": "A String", # Output only. The resource name for this assigned targeting option.
- "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
- "contentPosition": "A String", # Required. The content position.
- },
- "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
- "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
- },
- "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
- "omid": "A String", # Required. The type of Open Measurement enabled inventory.
- },
- "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "onScreenPosition": "A String", # Output only. The on screen position.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- },
- "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- "displayName": "A String", # Output only. The display name of the operating system.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- },
- "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
- "parentalStatus": "A String", # Required. The parental status of the audience.
- },
- "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
- "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
- "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
- "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
- },
- "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
- "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
- "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
- "proximityRadiusUnit": "A String", # Required. Radius distance units.
- },
- "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
- },
- "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
- "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
- },
- "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
- "sessionPosition": "A String", # The position where the ad will show in a session.
- },
- "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
- },
- "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
- "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
- "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
- "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
- "excludedAdlooxCategories": [ # Scope3 categories to exclude.
- "A String",
- ],
- "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
- "A String",
- ],
- "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
- },
- "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
- "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
- "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
- "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
- },
- "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
- "A String",
- ],
- "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
- "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
- "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
- "A String",
- ],
- "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
- "A String",
- ],
- },
- "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
- "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
- "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
- "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
- },
- "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
- "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
- "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
- },
- "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
- "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
- "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
- "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
- },
- },
- "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
- "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
- "A String",
- ],
- "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
- "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
- "excludedAdFraudRisk": "A String", # Ad Fraud settings.
- "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
- "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
- "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
- "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
- "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
- "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
- "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
- "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
- "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
- "A String",
- ],
- "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
- "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
- },
- },
- "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
- },
- "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
- },
- "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
- "videoPlayerSize": "A String", # Required. The video player size.
- },
- "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
- "viewability": "A String", # Required. The predicted viewability percentage.
- },
- "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
- "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
- },
- },
- ],
- "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListCampaignAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
-}
-listAssignedTargetingOptions_next()
- Retrieves the next page of results. - - Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - - Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
list_next()
Retrieves the next page of results. diff --git a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html index 2166455c58..71c022e18e 100644 --- a/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html +++ b/docs/dyn/displayvideo_v4.advertisers.insertionOrders.html @@ -74,11 +74,6 @@Display & Video 360 API . advertisers . insertionOrders
Instance Methods
--
-targetingTypes()-Returns the targetingTypes Resource.
-Close httplib2 connections.
@@ -94,12 +89,6 @@Instance Methods
list(advertiserId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)Lists insertion orders in an advertiser. The order is defined by the order_by parameter. If a filter by entity_status is not specified, insertion orders with `ENTITY_STATUS_ARCHIVED` will not be included in the results.
- -Lists assigned targeting options of an insertion order across targeting types.
--
-listAssignedTargetingOptions_next()Retrieves the next page of results.
Retrieves the next page of results.
@@ -123,11 +112,11 @@Method Details
{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -223,11 +212,11 @@Method Details
{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -350,11 +339,11 @@Method Details
{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -463,11 +452,11 @@Method Details
"insertionOrders": [ # The list of insertion orders. This list will be absent if empty. { # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -557,371 +546,6 @@Method Details
}
listAssignedTargetingOptions(advertiserId, insertionOrderId, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
- Lists assigned targeting options of an insertion order across targeting types.
-
-Args:
- advertiserId: string, Required. The ID of the advertiser the insertion order belongs to. (required)
- insertionOrderId: string, Required. The ID of the insertion order to list assigned targeting options for. (required)
- filter: string, Allows filtering by assigned targeting option fields. Supported syntax: * Filter expressions are made up of one or more restrictions. * Restrictions can be combined by the logical operator `OR`. * A restriction has the form of `{field} {operator} {value}`. * All fields must use the `EQUALS (=)` operator. Supported fields: * `targetingType` * `inheritance` Examples: * `AssignedTargetingOption` resources of targeting type `TARGETING_TYPE_PROXIMITY_LOCATION_LIST` or `TARGETING_TYPE_CHANNEL`: `targetingType="TARGETING_TYPE_PROXIMITY_LOCATION_LIST" OR targetingType="TARGETING_TYPE_CHANNEL"` * `AssignedTargetingOption` resources with inheritance status of `NOT_INHERITED` or `INHERITED_FROM_PARTNER`: `inheritance="NOT_INHERITED" OR inheritance="INHERITED_FROM_PARTNER"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information.
- orderBy: string, Field by which to sort the list. Acceptable values are: * `targetingType` (default) The default sorting order is ascending. To specify descending order for a field, a suffix "desc" should be added to the field name. Example: `targetingType desc`.
- pageSize: integer, Requested page size. The size must be an integer between `1` and `5000`. If unspecified, the default is `5000`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified.
- pageToken: string, A token that lets the client fetch the next page of results. Typically, this is the value of next_page_token returned from the previous call to `BulkListInsertionOrderAssignedTargetingOptions` method. If not specified, the first page of results will be returned.
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- {
- "assignedTargetingOptions": [ # The list of assigned targeting options. This list will be absent if empty.
- { # A single assigned targeting option, which defines the state of a targeting option for an entity with targeting settings.
- "ageRangeDetails": { # Represents a targetable age range. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AGE_RANGE`. # Age range details. This field will be populated when the targeting_type is `TARGETING_TYPE_AGE_RANGE`.
- "ageRange": "A String", # Required. The age range of an audience. We only support targeting a continuous age range of an audience. Thus, the age range represented in this field can be 1) targeted solely, or, 2) part of a larger continuous age range. The reach of a continuous age range targeting can be expanded by also targeting an audience of an unknown age.
- },
- "appCategoryDetails": { # Details for assigned app category targeting option. This will be populated in the app_category_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP_CATEGORY`. # App category details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- "displayName": "A String", # Output only. The display name of the app category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_APP_CATEGORY`.
- },
- "appDetails": { # Details for assigned app targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_APP`. # App details. This field will be populated when the targeting_type is `TARGETING_TYPE_APP`.
- "appId": "A String", # Required. The ID of the app. Android's Play store app uses bundle ID, for example `com.google.android.gm`. Apple's App store app ID uses 9 digit string, for example `422689480`.
- "appPlatform": "A String", # Indicates the platform of the targeted app. If this field is not specified, the app platform will be assumed to be mobile (i.e., Android or iOS), and we will derive the appropriate mobile platform from the app ID.
- "displayName": "A String", # Output only. The display name of the app.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "assignedTargetingOptionId": "A String", # Output only. The unique ID of the assigned targeting option. The ID is only unique within a given resource and targeting type. It may be reused in other contexts.
- "assignedTargetingOptionIdAlias": "A String", # Output only. An alias for the assigned_targeting_option_id. This value can be used in place of `assignedTargetingOptionId` when retrieving or deleting existing targeting. This field will only be supported for all assigned targeting options of the following targeting types: * `TARGETING_TYPE_AGE_RANGE` * `TARGETING_TYPE_DEVICE_TYPE` * `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION` * `TARGETING_TYPE_ENVIRONMENT` * `TARGETING_TYPE_EXCHANGE` * `TARGETING_TYPE_GENDER` * `TARGETING_TYPE_HOUSEHOLD_INCOME` * `TARGETING_TYPE_NATIVE_CONTENT_POSITION` * `TARGETING_TYPE_OMID` * `TARGETING_TYPE_PARENTAL_STATUS` * `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION` * `TARGETING_TYPE_VIDEO_PLAYER_SIZE` * `TARGETING_TYPE_VIEWABILITY` This field is also supported for line item assigned targeting options of the following targeting types: * `TARGETING_TYPE_CONTENT_INSTREAM_POSITION` * `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`
- "audienceGroupDetails": { # Assigned audience group targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. The relation between each group is UNION, except for excluded_first_and_third_party_audience_group and excluded_google_audience_group, of which COMPLEMENT is used as an INTERSECTION with other groups. # Audience targeting details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIENCE_GROUP`. You can only target one audience group option per resource.
- "excludedFirstPartyAndPartnerAudienceGroup": { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other. # Optional. The first party and partner audience ids and recencies of the excluded first party and partner audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
- { # Details of first party and partner audience targeting setting.
- "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
- "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- "excludedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the excluded Google audience group. Used for negative targeting. The COMPLEMENT of the UNION of this group and other excluded audience groups is used as an INTERSECTION to any positive audience targeting. Only contains Affinity, In-market and Installed-apps type Google audiences. All items are logically ‘OR’ of each other.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- "includedCombinedAudienceGroup": { # Details of combined audience group. All combined audience targeting settings are logically ‘OR’ of each other. # Optional. The combined audience ids of the included combined audience group. Contains combined audience ids only.
- "settings": [ # Required. All combined audience targeting settings in combined audience group. Repeated settings with the same id will be ignored. The number of combined audience settings should be no more than five, error will be thrown otherwise.
- { # Details of combined audience targeting setting.
- "combinedAudienceId": "A String", # Required. Combined audience id of combined audience targeting setting. This id is combined_audience_id.
- },
- ],
- },
- "includedCustomListGroup": { # Details of custom list group. All custom list targeting settings are logically ‘OR’ of each other. # Optional. The custom list ids of the included custom list group. Contains custom list ids only.
- "settings": [ # Required. All custom list targeting settings in custom list group. Repeated settings with the same id will be ignored.
- { # Details of custom list targeting setting.
- "customListId": "A String", # Required. Custom id of custom list targeting setting. This id is custom_list_id.
- },
- ],
- },
- "includedFirstPartyAndPartnerAudienceGroups": [ # Optional. The first party and partner audience ids and recencies of included first party and partner audience groups. Each first party and partner audience group contains first party and partner audience ids only. The relation between each first party and partner audience group is INTERSECTION, and the result is UNION'ed with other audience groups. Repeated groups with the same settings will be ignored.
- { # Details of first party and partner audience group. All first party and partner audience targeting settings are logically ‘OR’ of each other.
- "settings": [ # Required. All first party and partner audience targeting settings in first party and partner audience group. Repeated settings with the same id are not allowed.
- { # Details of first party and partner audience targeting setting.
- "firstPartyAndPartnerAudienceId": "A String", # Required. First party and partner audience id of the first party and partner audience targeting setting. This id is first_party_and_partner_audience_id.
- "recency": "A String", # Required. The recency of the first party and partner audience targeting setting. Only applicable to first party audiences, otherwise will be ignored. For more info, refer to https://support.google.com/displayvideo/answer/2949947#recency When unspecified, no recency limit will be used.
- },
- ],
- },
- ],
- "includedGoogleAudienceGroup": { # Details of Google audience group. All Google audience targeting settings are logically ‘OR’ of each other. # Optional. The Google audience ids of the included Google audience group. Contains Google audience ids only.
- "settings": [ # Required. All Google audience targeting settings in Google audience group. Repeated settings with the same id will be ignored.
- { # Details of Google audience targeting setting.
- "googleAudienceId": "A String", # Required. Google audience id of the Google audience targeting setting. This id is google_audience_id.
- },
- ],
- },
- },
- "audioContentTypeDetails": { # Details for audio content type assigned targeting option. This will be populated in the audio_content_type_details field when targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`. Explicitly targeting all options is not supported. Remove all audio content type targeting options to achieve this effect. # Audio content type details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUDIO_CONTENT_TYPE`.
- "audioContentType": "A String", # Required. The audio content type.
- },
- "authorizedSellerStatusDetails": { # Represents an assigned authorized seller status. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. If a resource does not have an `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS` assigned targeting option, it is using the "Authorized Direct Sellers and Resellers" option. # Authorized seller status details. This field will be populated when the targeting_type is `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`. You can only target one authorized seller status option per resource. If a resource doesn't have an authorized seller status option, all authorized sellers indicated as DIRECT or RESELLER in the ads.txt file are targeted by default.
- "authorizedSellerStatus": "A String", # Output only. The authorized seller status to target.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_AUTHORIZED_SELLER_STATUS`.
- },
- "browserDetails": { # Details for assigned browser targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BROWSER`. # Browser details. This field will be populated when the targeting_type is `TARGETING_TYPE_BROWSER`.
- "displayName": "A String", # Output only. The display name of the browser.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned browser targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BROWSER`.
- },
- "businessChainDetails": { # Details for assigned Business chain targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`. # Business chain details. This field will be populated when the targeting_type is `TARGETING_TYPE_BUSINESS_CHAIN`.
- "displayName": "A String", # Output only. The display name of a business chain, e.g. "KFC", "Chase Bank".
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the business chain that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`. The minimum increment for both cases is 0.1. Inputs will be rounded to the nearest acceptable value if it is too granular, e.g. 15.57 will become 15.6.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_BUSINESS_CHAIN`. Accepted business chain targeting option IDs can be retrieved using SearchTargetingOptions.
- },
- "carrierAndIspDetails": { # Details for assigned carrier and ISP targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`. # Carrier and ISP details. This field will be populated when the targeting_type is `TARGETING_TYPE_CARRIER_AND_ISP`.
- "displayName": "A String", # Output only. The display name of the carrier or ISP.
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned carrier and ISP targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_CARRIER_AND_ISP`.
- },
- "categoryDetails": { # Assigned category targeting option details. This will be populated in the category_details field when targeting_type is `TARGETING_TYPE_CATEGORY`. # Category details. This field will be populated when the targeting_type is `TARGETING_TYPE_CATEGORY`. Targeting a category will also target its subcategories. If a category is excluded from targeting and a subcategory is included, the exclusion will take precedence.
- "displayName": "A String", # Output only. The display name of the category.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CATEGORY`.
- },
- "channelDetails": { # Details for assigned channel targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CHANNEL`. # Channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_CHANNEL`.
- "channelId": "A String", # Required. ID of the channel. Should refer to the channel ID field on a [Partner-owned channel](partners.channels#Channel.FIELDS.channel_id) or [advertiser-owned channel](advertisers.channels#Channel.FIELDS.channel_id) resource.
- "negative": True or False, # Indicates if this option is being negatively targeted. For advertiser level assigned targeting option, this field must be true.
- },
- "contentDurationDetails": { # Details for content duration assigned targeting option. This will be populated in the content_duration_details field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`. Explicitly targeting all options is not supported. Remove all content duration targeting options to achieve this effect. # Content duration details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- "contentDuration": "A String", # Output only. The content duration.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_DURATION`.
- },
- "contentGenreDetails": { # Details for content genre assigned targeting option. This will be populated in the content_genre_details field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`. Explicitly targeting all options is not supported. Remove all content genre targeting options to achieve this effect. # Content genre details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- "displayName": "A String", # Output only. The display name of the content genre.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_GENRE`.
- },
- "contentInstreamPositionDetails": { # Assigned content instream position targeting option details. This will be populated in the content_instream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`. # Content instream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_INSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`. * `AD_TYPE_AUDIO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_AUDIO_DEFAULT`.
- "contentInstreamPosition": "A String", # Required. The content instream position for video or audio ads.
- },
- "contentOutstreamPositionDetails": { # Assigned content outstream position targeting option details. This will be populated in the content_outstream_position_details field when targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`. # Content outstream position details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_OUTSTREAM_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "contentOutstreamPosition": "A String", # Required. The content outstream position.
- },
- "contentStreamTypeDetails": { # Details for content stream type assigned targeting option. This will be populated in the content_stream_type_details field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`. Explicitly targeting all options is not supported. Remove all content stream type targeting options to achieve this effect. # Content duration details. This field will be populated when the TargetingType is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- "contentStreamType": "A String", # Output only. The content stream type.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_CONTENT_STREAM_TYPE`.
- },
- "contentThemeExclusionDetails": { # Targeting details for content theme. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. # Content theme details. This field will be populated when the targeting_type is `TARGETING_TYPE_CONTENT_THEME_EXCLUSION`. Content theme are targeting exclusions. Advertiser level content theme exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content theme in addition to advertiser exclusions.
- "contentTheme": "A String", # Output only. An enum for the DV360 content theme classifier.
- "excludedContentTheme": "A String", # Required. An enum for the DV360 content theme classified to be EXCLUDED.
- "excludedTargetingOptionId": "A String", # Required. ID of the content theme to be EXCLUDED.
- },
- "dayAndTimeDetails": { # Representation of a segment of time defined on a specific day of the week and with a start and end time. The time represented by `start_hour` must be before the time represented by `end_hour`. # Day and time details. This field will be populated when the targeting_type is `TARGETING_TYPE_DAY_AND_TIME`.
- "dayOfWeek": "A String", # Required. The day of the week for this day and time targeting setting.
- "endHour": 42, # Required. The end hour for day and time targeting. Must be between 1 (1 hour after start of day) and 24 (end of day).
- "startHour": 42, # Required. The start hour for day and time targeting. Must be between 0 (start of day) and 23 (1 hour before end of day).
- "timeZoneResolution": "A String", # Required. The mechanism used to determine which timezone to use for this day and time targeting setting.
- },
- "deviceMakeModelDetails": { # Assigned device make and model targeting option details. This will be populated in the device_make_model_details field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`. # Device make and model details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- "displayName": "A String", # Output only. The display name of the device make and model.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_DEVICE_MAKE_MODEL`.
- },
- "deviceTypeDetails": { # Targeting details for device type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DEVICE_TYPE`. # Device Type details. This field will be populated when the targeting_type is `TARGETING_TYPE_DEVICE_TYPE`.
- "deviceType": "A String", # Required. The display name of the device type.
- "youtubeAndPartnersBidMultiplier": 3.14, # Output only. Bid multiplier allows you to show your ads more or less frequently based on the device type. It will apply a multiplier on the original bid price. When this field is 0, it indicates this field is not applicable instead of multiplying 0 on the original bid price. For example, if the bid price without multiplier is $10.0 and the multiplier is 1.5 for Tablet, the resulting bid price for Tablet will be $15.0. Only applicable to YouTube and Partners line items.
- },
- "digitalContentLabelExclusionDetails": { # Targeting details for digital content label. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. # Digital content label details. This field will be populated when the targeting_type is `TARGETING_TYPE_DIGITAL_CONTENT_LABEL_EXCLUSION`. Digital content labels are targeting exclusions. Advertiser level digital content label exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude content labels in addition to advertiser exclusions, but can't override them. A line item won't serve if all the digital content labels are excluded.
- "excludedContentRatingTier": "A String", # Required. The display name of the digital content label rating tier to be EXCLUDED.
- },
- "environmentDetails": { # Assigned environment targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_ENVIRONMENT`. # Environment details. This field will be populated when the targeting_type is `TARGETING_TYPE_ENVIRONMENT`.
- "environment": "A String", # Required. The serving environment.
- },
- "exchangeDetails": { # Details for assigned exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_EXCHANGE`. # Exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_EXCHANGE`.
- "exchange": "A String", # Required. The enum value for the exchange.
- },
- "genderDetails": { # Details for assigned gender targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GENDER`. # Gender details. This field will be populated when the targeting_type is `TARGETING_TYPE_GENDER`.
- "gender": "A String", # Required. The gender of the audience.
- },
- "geoRegionDetails": { # Details for assigned geographic region targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_GEO_REGION`. # Geographic region details. This field will be populated when the targeting_type is `TARGETING_TYPE_GEO_REGION`.
- "displayName": "A String", # Output only. The display name of the geographic region (e.g., "Ontario, Canada").
- "geoRegionType": "A String", # Output only. The type of geographic region targeting.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_GEO_REGION`.
- },
- "householdIncomeDetails": { # Details for assigned household income targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`. # Household income details. This field will be populated when the targeting_type is `TARGETING_TYPE_HOUSEHOLD_INCOME`.
- "householdIncome": "A String", # Required. The household income of the audience.
- },
- "inheritance": "A String", # Output only. The inheritance status of the assigned targeting option.
- "inventorySourceDetails": { # Targeting details for inventory source. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`. # Inventory source details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE`.
- "inventorySourceId": "A String", # Required. ID of the inventory source. Should refer to the inventory_source_id field of an InventorySource resource.
- },
- "inventorySourceGroupDetails": { # Targeting details for inventory source group. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`. # Inventory source group details. This field will be populated when the targeting_type is `TARGETING_TYPE_INVENTORY_SOURCE_GROUP`.
- "inventorySourceGroupId": "A String", # Required. ID of the inventory source group. Should refer to the inventory_source_group_id field of an InventorySourceGroup resource.
- },
- "keywordDetails": { # Details for assigned keyword targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_KEYWORD`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_KEYWORD`. A maximum of 5000 direct negative keywords can be assigned to a resource. No limit on number of positive keywords that can be assigned.
- "keyword": "A String", # Required. The keyword, for example `car insurance`. Positive keyword cannot be offensive word. Must be UTF-8 encoded with a maximum size of 255 bytes. Maximum number of characters is 80. Maximum number of words is 10.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "languageDetails": { # Details for assigned language targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_LANGUAGE`. # Language details. This field will be populated when the targeting_type is `TARGETING_TYPE_LANGUAGE`.
- "displayName": "A String", # Output only. The display name of the language (e.g., "French").
- "negative": True or False, # Indicates if this option is being negatively targeted. All assigned language targeting options on the same resource must have the same value for this field.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_LANGUAGE`.
- },
- "name": "A String", # Output only. The resource name for this assigned targeting option.
- "nativeContentPositionDetails": { # Details for native content position assigned targeting option. This will be populated in the native_content_position_details field when targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`. Explicitly targeting all options is not supported. Remove all native content position targeting options to achieve this effect. # Native content position details. This field will be populated when the targeting_type is `TARGETING_TYPE_NATIVE_CONTENT_POSITION`.
- "contentPosition": "A String", # Required. The content position.
- },
- "negativeKeywordListDetails": { # Targeting details for negative keyword list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. # Keyword details. This field will be populated when the targeting_type is `TARGETING_TYPE_NEGATIVE_KEYWORD_LIST`. A maximum of 4 negative keyword lists can be assigned to a resource.
- "negativeKeywordListId": "A String", # Required. ID of the negative keyword list. Should refer to the negative_keyword_list_id field of a NegativeKeywordList resource.
- },
- "omidDetails": { # Represents a targetable Open Measurement enabled inventory type. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_OMID`. # Open Measurement enabled inventory details. This field will be populated when the targeting_type is `TARGETING_TYPE_OMID`.
- "omid": "A String", # Required. The type of Open Measurement enabled inventory.
- },
- "onScreenPositionDetails": { # On screen position targeting option details. This will be populated in the on_screen_position_details field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`. # On screen position details. This field will be populated when the targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- "adType": "A String", # Output only. The ad type to target. Only applicable to insertion order targeting and new line items supporting the specified ad type will inherit this targeting option by default. Possible values are: * `AD_TYPE_DISPLAY`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_DISPLAY_DEFAULT`. * `AD_TYPE_VIDEO`, the setting will be inherited by new line item when line_item_type is `LINE_ITEM_TYPE_VIDEO_DEFAULT`.
- "onScreenPosition": "A String", # Output only. The on screen position.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_ON_SCREEN_POSITION`.
- },
- "operatingSystemDetails": { # Assigned operating system targeting option details. This will be populated in the operating_system_details field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`. # Operating system details. This field will be populated when the targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- "displayName": "A String", # Output only. The display name of the operating system.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "targetingOptionId": "A String", # Required. The targeting option ID populated in targeting_option_id field when targeting_type is `TARGETING_TYPE_OPERATING_SYSTEM`.
- },
- "parentalStatusDetails": { # Details for assigned parental status targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`. # Parental status details. This field will be populated when the targeting_type is `TARGETING_TYPE_PARENTAL_STATUS`.
- "parentalStatus": "A String", # Required. The parental status of the audience.
- },
- "poiDetails": { # Details for assigned POI targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_POI`. # POI details. This field will be populated when the targeting_type is `TARGETING_TYPE_POI`.
- "displayName": "A String", # Output only. The display name of a POI, e.g. "Times Square", "Space Needle", followed by its full address if available.
- "latitude": 3.14, # Output only. Latitude of the POI rounding to 6th decimal place.
- "longitude": 3.14, # Output only. Longitude of the POI rounding to 6th decimal place.
- "proximityRadiusAmount": 3.14, # Required. The radius of the area around the POI that will be targeted. The units of the radius are specified by proximity_radius_unit. Must be 1 to 800 if unit is `DISTANCE_UNIT_KILOMETERS` and 1 to 500 if unit is `DISTANCE_UNIT_MILES`.
- "proximityRadiusUnit": "A String", # Required. The unit of distance by which the targeting radius is measured.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_POI`. Accepted POI targeting option IDs can be retrieved using `targetingTypes.targetingOptions.search`. If targeting a specific latitude/longitude coordinate removed from an address or POI name, you can generate the necessary targeting option ID by rounding the desired coordinate values to the 6th decimal place, removing the decimals, and concatenating the string values separated by a semicolon. For example, you can target the latitude/longitude pair of 40.7414691, -74.003387 using the targeting option ID "40741469;-74003387". **Upon** **creation, this field value will be updated to append a semicolon and** **alphanumerical hash value if only latitude/longitude coordinates are** **provided.**
- },
- "proximityLocationListDetails": { # Targeting details for proximity location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`. # Proximity location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_PROXIMITY_LOCATION_LIST`.
- "proximityLocationListId": "A String", # Required. ID of the proximity location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_PROXIMITY`.
- "proximityRadius": 3.14, # Required. Radius expressed in the distance units set in proximity_radius_unit. This represents the size of the area around a chosen location that will be targeted. Radius should be between 1 and 500 miles or 800 kilometers.
- "proximityRadiusUnit": "A String", # Required. Radius distance units.
- },
- "regionalLocationListDetails": { # Targeting details for regional location list. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`. # Regional location list details. This field will be populated when the targeting_type is `TARGETING_TYPE_REGIONAL_LOCATION_LIST`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "regionalLocationListId": "A String", # Required. ID of the regional location list. Should refer to the location_list_id field of a LocationList resource whose type is `TARGETING_LOCATION_TYPE_REGIONAL`.
- },
- "sensitiveCategoryExclusionDetails": { # Targeting details for sensitive category. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. # Sensitive category details. This field will be populated when the targeting_type is `TARGETING_TYPE_SENSITIVE_CATEGORY_EXCLUSION`. Sensitive categories are targeting exclusions. Advertiser level sensitive category exclusions, if set, are always applied in serving (even though they aren't visible in resource settings). Resource settings can exclude sensitive categories in addition to advertiser exclusions, but can't override them.
- "excludedSensitiveCategory": "A String", # Required. An enum for the DV360 Sensitive category content classified to be EXCLUDED.
- },
- "sessionPositionDetails": { # Details for session position assigned targeting option. This will be populated in the session_position_details field when targeting_type is `TARGETING_TYPE_SESSION_POSITION`. # Session position details. This field will be populated when the targeting_type is `TARGETING_TYPE_SESSION_POSITION`.
- "sessionPosition": "A String", # The position where the ad will show in a session.
- },
- "subExchangeDetails": { # Details for assigned sub-exchange targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`. # Sub-exchange details. This field will be populated when the targeting_type is `TARGETING_TYPE_SUB_EXCHANGE`.
- "targetingOptionId": "A String", # Required. The targeting_option_id of a TargetingOption of type `TARGETING_TYPE_SUB_EXCHANGE`.
- },
- "targetingType": "A String", # Output only. Identifies the type of this assigned targeting option.
- "thirdPartyVerifierDetails": { # Assigned third party verifier targeting option details. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`. # Third party verification details. This field will be populated when the targeting_type is `TARGETING_TYPE_THIRD_PARTY_VERIFIER`.
- "adloox": { # Details of Scope3 (previously known as Adloox) brand safety settings. # Third party brand verifier -- Scope3 (previously known as Adloox).
- "adultExplicitSexualContent": "A String", # Optional. Adult and Explicit Sexual Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "armsAmmunitionContent": "A String", # Optional. Arms and Ammunition Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "crimeHarmfulActsIndividualsSocietyHumanRightsViolationsContent": "A String", # Optional. Crime and Harmful Acts Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "deathInjuryMilitaryConflictContent": "A String", # Optional. Death, Injury, or Military Conflict Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "debatedSensitiveSocialIssueContent": "A String", # Optional. Debated Sensitive Social Issue Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "displayIabViewability": "A String", # Optional. IAB viewability threshold for display ads.
- "excludedAdlooxCategories": [ # Scope3 categories to exclude.
- "A String",
- ],
- "excludedFraudIvtMfaCategories": [ # Optional. Scope3's fraud IVT MFA categories to exclude.
- "A String",
- ],
- "hateSpeechActsAggressionContent": "A String", # Optional. Hate Speech and Acts of Aggression Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "illegalDrugsTobaccoEcigarettesVapingAlcoholContent": "A String", # Optional. Illegal Drugs/Alcohol Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "misinformationContent": "A String", # Optional. Misinformation Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "obscenityProfanityContent": "A String", # Optional. Obscenity and Profanity Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "onlinePiracyContent": "A String", # Optional. Online Piracy Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "spamHarmfulContent": "A String", # Optional. Spam or Harmful Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "terrorismContent": "A String", # Optional. Terrorism Content [GARM](https://wfanet.org/leadership/garm/about-garm) risk ranges to exclude.
- "videoIabViewability": "A String", # Optional. IAB viewability threshold for video ads.
- },
- "doubleVerify": { # Details of DoubleVerify settings. # Third party brand verifier -- DoubleVerify.
- "appStarRating": { # Details of DoubleVerify star ratings settings. # Avoid bidding on apps with the star ratings.
- "avoidInsufficientStarRating": True or False, # Avoid bidding on apps with insufficient star ratings.
- "avoidedStarRating": "A String", # Avoid bidding on apps with the star ratings.
- },
- "avoidedAgeRatings": [ # Avoid bidding on apps with the age rating.
- "A String",
- ],
- "brandSafetyCategories": { # Settings for brand safety controls. # DV Brand Safety Controls.
- "avoidUnknownBrandSafetyCategory": True or False, # Unknown or unrateable.
- "avoidedHighSeverityCategories": [ # Brand safety high severity avoidance categories.
- "A String",
- ],
- "avoidedMediumSeverityCategories": [ # Brand safety medium severity avoidance categories.
- "A String",
- ],
- },
- "customSegmentId": "A String", # The custom segment ID provided by DoubleVerify. The ID must start with "51" and consist of eight digits. Custom segment ID cannot be specified along with any of the following fields: * brand_safety_categories * avoided_age_ratings * app_star_rating * fraud_invalid_traffic
- "displayViewability": { # Details of DoubleVerify display viewability settings. # Display viewability settings (applicable to display line items only).
- "iab": "A String", # Target web and app inventory to maximize IAB viewable rate.
- "viewableDuring": "A String", # Target web and app inventory to maximize 100% viewable duration.
- },
- "fraudInvalidTraffic": { # DoubleVerify Fraud & Invalid Traffic settings. # Avoid Sites and Apps with historical Fraud & IVT Rates.
- "avoidInsufficientOption": True or False, # Insufficient Historical Fraud & IVT Stats.
- "avoidedFraudOption": "A String", # Avoid Sites and Apps with historical Fraud & IVT.
- },
- "videoViewability": { # Details of DoubleVerify video viewability settings. # Video viewability settings (applicable to video line items only).
- "playerImpressionRate": "A String", # Target inventory to maximize impressions with 400x300 or greater player size.
- "videoIab": "A String", # Target web inventory to maximize IAB viewable rate.
- "videoViewableRate": "A String", # Target web inventory to maximize fully viewable rate.
- },
- },
- "integralAdScience": { # Details of Integral Ad Science settings. # Third party brand verifier -- Integral Ad Science.
- "customSegmentId": [ # The custom segment ID provided by Integral Ad Science. The ID must be between `1000001` and `1999999` or `3000001` and `3999999`, inclusive.
- "A String",
- ],
- "displayViewability": "A String", # Display Viewability section (applicable to display line items only).
- "excludeUnrateable": True or False, # Brand Safety - **Unrateable**.
- "excludedAdFraudRisk": "A String", # Ad Fraud settings.
- "excludedAdultRisk": "A String", # Brand Safety - **Adult content**.
- "excludedAlcoholRisk": "A String", # Brand Safety - **Alcohol**.
- "excludedDrugsRisk": "A String", # Brand Safety - **Drugs**.
- "excludedGamblingRisk": "A String", # Brand Safety - **Gambling**.
- "excludedHateSpeechRisk": "A String", # Brand Safety - **Hate speech**.
- "excludedIllegalDownloadsRisk": "A String", # Brand Safety - **Illegal downloads**.
- "excludedOffensiveLanguageRisk": "A String", # Brand Safety - **Offensive language**.
- "excludedViolenceRisk": "A String", # Brand Safety - **Violence**.
- "qualitySyncCustomSegmentId": [ # Optional. The quality sync custom segment ID provided by Integral Ad Science. The ID must be between `3000000` and `4999999`, inclusive.
- "A String",
- ],
- "traqScoreOption": "A String", # True advertising quality (applicable to Display line items only).
- "videoViewability": "A String", # Video Viewability Section (applicable to video line items only).
- },
- },
- "urlDetails": { # Details for assigned URL targeting option. This will be populated in the details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_URL`. # URL details. This field will be populated when the targeting_type is `TARGETING_TYPE_URL`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "url": "A String", # Required. The URL, for example `example.com`. DV360 supports two levels of subdirectory targeting, for example `www.example.com/one-subdirectory-level/second-level`, and five levels of subdomain targeting, for example `five.four.three.two.one.example.com`.
- },
- "userRewardedContentDetails": { # User rewarded content targeting option details. This will be populated in the user_rewarded_content_details field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`. # User rewarded content details. This field will be populated when the targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "targetingOptionId": "A String", # Required. The targeting_option_id field when targeting_type is `TARGETING_TYPE_USER_REWARDED_CONTENT`.
- "userRewardedContent": "A String", # Output only. User rewarded content status for video ads.
- },
- "videoPlayerSizeDetails": { # Video player size targeting option details. This will be populated in the video_player_size_details field when targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`. Explicitly targeting all options is not supported. Remove all video player size targeting options to achieve this effect. # Video player size details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIDEO_PLAYER_SIZE`.
- "videoPlayerSize": "A String", # Required. The video player size.
- },
- "viewabilityDetails": { # Assigned viewability targeting option details. This will be populated in the viewability_details field of an AssignedTargetingOption when targeting_type is `TARGETING_TYPE_VIEWABILITY`. # Viewability details. This field will be populated when the targeting_type is `TARGETING_TYPE_VIEWABILITY`. You can only target one viewability option per resource.
- "viewability": "A String", # Required. The predicted viewability percentage.
- },
- "youtubeChannelDetails": { # Details for YouTube channel assigned targeting option. This will be populated in the youtube_channel_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`. # YouTube channel details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_CHANNEL`.
- "channelId": "A String", # The YouTube uploader channel id or the channel code of a YouTube channel.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- },
- "youtubeVideoDetails": { # Details for YouTube video assigned targeting option. This will be populated in the youtube_video_details field when targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`. # YouTube video details. This field will be populated when the targeting_type is `TARGETING_TYPE_YOUTUBE_VIDEO`.
- "negative": True or False, # Indicates if this option is being negatively targeted.
- "videoId": "A String", # YouTube video id as it appears on the YouTube watch page.
- },
- },
- ],
- "nextPageToken": "A String", # A token identifying the next page of results. This value should be specified as the pageToken in a subsequent BulkListInsertionOrderAssignedTargetingOptionsRequest to fetch the next page of results. This token will be absent if there are no more assigned_targeting_options to return.
-}
-listAssignedTargetingOptions_next()
- Retrieves the next page of results. - - Args: - previous_request: The request for the previous page. (required) - previous_response: The response from the request for the previous page. (required) - - Returns: - A request object that you can call 'execute()' on to request the next - page. Returns None if there are no more items in the collection. --
list_next()
Retrieves the next page of results. @@ -948,11 +572,11 @@Method Details
{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -1049,11 +673,11 @@Method Details
{ # A single insertion order. "advertiserId": "A String", # Output only. The unique ID of the advertiser the insertion order belongs to. - "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. + "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Optional. The bidding strategy of the insertion order. By default, fixed_bid is set. If the budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`, the insertion order will impose this bidding strategy on its line items. If an imposed bidding strategy is not compatible with a line item's enableOptimizedTargeting setting, the optimized targeting setting will be updated. "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. diff --git a/docs/dyn/displayvideo_v4.advertisers.lineItems.html b/docs/dyn/displayvideo_v4.advertisers.lineItems.html index b348226e2b..c288e6f6af 100644 --- a/docs/dyn/displayvideo_v4.advertisers.lineItems.html +++ b/docs/dyn/displayvideo_v4.advertisers.lineItems.html @@ -108,9 +108,6 @@Instance Methods
duplicate(advertiserId, lineItemId, body=None, x__xgafv=None)Duplicates a line item. Returns the ID of the created line item if successful. YouTube & Partners line items cannot be created or updated using the API. **This method regularly experiences high latency.** We recommend [increasing your default timeout](/display-video/api/guides/best-practices/timeouts#client_library_timeout) to avoid errors.
--
-generateDefault(advertiserId, body=None, x__xgafv=None)Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.
get(advertiserId, lineItemId, x__xgafv=None)Gets a line item.
@@ -895,7 +892,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -996,7 +993,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1126,7 +1123,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -1227,7 +1224,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1317,7 +1314,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -1418,7 +1415,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1542,220 +1539,6 @@Method Details
}
generateDefault(advertiserId, body=None, x__xgafv=None)
- Creates a new line item with settings (including targeting) inherited from the insertion order and an `ENTITY_STATUS_DRAFT` entity_status. Returns the newly created line item if successful. There are default values based on the three fields: * The insertion order's insertion_order_type * The insertion order's automation_type * The given line_item_type YouTube & Partners line items cannot be created or updated using the API.
-
-Args:
- advertiserId: string, Required. The ID of the advertiser this line item belongs to. (required)
- body: object, The request body.
- The object takes the form of:
-
-{ # Request message for LineItemService.GenerateDefaultLineItem.
- "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
- "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
- "insertionOrderId": "A String", # Required. The unique ID of the insertion order that the line item belongs to.
- "lineItemType": "A String", # Required. The type of the line item.
- "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
- "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
- "displayName": "A String", # Output only. The app name.
- "platform": "A String", # Output only. The app platform.
- "publisher": "A String", # Output only. The app publisher.
- },
-}
-
- x__xgafv: string, V1 error format.
- Allowed values
- 1 - v1 error format
- 2 - v2 error format
-
-Returns:
- An object of the form:
-
- { # A single line item.
- "advertiserId": "A String", # Output only. The unique ID of the advertiser the line item belongs to.
- "bidStrategy": { # Settings that control the bid strategy. Bid strategy determines the bid price. # Required. The bidding strategy of the line item.
- "fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price.
- "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency.
- },
- "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items.
- "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy.
- "raiseBidForDeals": True or False, # Whether the strategy takes deal floor prices into account.
- },
- "performanceGoalAutoBid": { # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. # A strategy that automatically adjusts the bid to meet or beat a specified performance goal. It is to be used only for a line item entity.
- "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error.
- "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. Not applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`. For example, 1500000 represents 1.5 standard units of the currency.
- "performanceGoalAmountMicros": "A String", # Required. The performance goal the bidding strategy will attempt to meet or beat, in micros of the advertiser's currency or in micro of the ROAS (Return On Advertising Spend) value which is also based on advertiser's currency. Must be greater than or equal to a billable unit of the given currency and smaller or equal to upper bounds. Each performance_goal_type has its upper bound: * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, upper bound is 10000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, upper bound is 1000.00 USD. * when performance_goal_type is `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`, upper bound is 1000.00 and lower bound is 0.01. Example: If set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`, the bid price will be based on the probability that each available impression will be viewable. For example, if viewable CPM target is $2 and an impression is 40% likely to be viewable, the bid price will be $0.80 CPM (40% of $2). For example, 1500000 represents 1.5 standard units of the currency or ROAS value.
- "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy will try to meet or beat. For line item level usage, the value must be one of: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`.
- },
- "youtubeAndPartnersBid": { # Settings that control the bid strategy for YouTube and Partners resources. # A bid strategy used by YouTube and Partners resources. It can only be used for a YouTube and Partners line item or ad group entity.
- "adGroupEffectiveTargetCpaSource": "A String", # Output only. Source of the effective target CPA value for ad group.
- "adGroupEffectiveTargetCpaValue": "A String", # Output only. The effective target CPA for ad group, in micros of advertiser's currency.
- "type": "A String", # The type of the bidding strategy.
- "value": "A String", # The value used by the bidding strategy. When the bidding strategy is assigned at the line item level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_SHARE_OF_VOICE` When the bidding strategy is assigned at the ad group level, this field is only applicable for the following strategy types: * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_MANUAL_CPV` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPA` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_RESERVE_CPM` * `YOUTUBE_AND_PARTNERS_BIDDING_STRATEGY_TYPE_TARGET_ROAS` If not using an applicable strategy, the value of this field will be 0.
- },
- },
- "budget": { # Settings that control how budget is allocated. # Required. The budget allocation setting of the line item.
- "budgetAllocationType": "A String", # Required. The type of the budget allocation. `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC` is only applicable when automatic budget allocation is enabled for the parent insertion order.
- "budgetUnit": "A String", # Output only. The budget unit specifies whether the budget is currency based or impression based. This value is inherited from the parent insertion order.
- "maxAmount": "A String", # The maximum budget amount the line item will spend. Must be greater than 0. When budget_allocation_type is: * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_AUTOMATIC`, this field is immutable and is set by the system. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_FIXED`, if budget_unit is: - `BUDGET_UNIT_CURRENCY`, this field represents maximum budget amount to spend, in micros of the advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. - `BUDGET_UNIT_IMPRESSIONS`, this field represents the maximum number of impressions to serve. * `LINE_ITEM_BUDGET_ALLOCATION_TYPE_UNLIMITED`, this field is not applicable and will be ignored by the system.
- },
- "campaignId": "A String", # Output only. The unique ID of the campaign that the line item belongs to.
- "containsEuPoliticalAds": "A String", # Whether this line item will serve European Union political ads. If contains_eu_political_ads has been set to `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` in the parent advertiser, then this field will be assigned `DOES_NOT_CONTAIN_EU_POLITICAL_ADVERTISING` if not otherwise specified. This field can then be updated using the UI, API, or Structured Data Files. This field must be assigned when creating a new line item. Otherwise, **the `advertisers.lineItems.create` request will fail**.
- "conversionCounting": { # Settings that control how conversions are counted. All post-click conversions will be counted. A percentage value can be set for post-view conversions counting. # The conversion tracking setting of the line item.
- "floodlightActivityConfigs": [ # The Floodlight activity configs used to track conversions. The number of conversions counted is the sum of all of the conversions counted by all of the Floodlight activity IDs specified in this field. This field can't be updated if a custom bidding algorithm is assigned to the line item. If you set this field and assign a custom bidding algorithm in the same request, the floodlight activities must match the ones used by the custom bidding algorithm.
- { # Settings that control the behavior of a single Floodlight activity config.
- "floodlightActivityId": "A String", # Required. The ID of the Floodlight activity.
- "postClickLookbackWindowDays": 42, # Required. The number of days after an ad has been clicked in which a conversion may be counted. Must be between 0 and 90 inclusive.
- "postViewLookbackWindowDays": 42, # Required. The number of days after an ad has been viewed in which a conversion may be counted. Must be between 0 and 90 inclusive.
- },
- ],
- "postViewCountPercentageMillis": "A String", # The percentage of post-view conversions to count, in millis (1/1000 of a percent). Must be between 0 and 100000 inclusive. For example, to track 50% of the post-click conversions, set a value of 50000.
- },
- "creativeIds": [ # The IDs of the creatives associated with the line item.
- "A String",
- ],
- "displayName": "A String", # Required. The display name of the line item. Must be UTF-8 encoded with a maximum size of 240 bytes.
- "entityStatus": "A String", # Required. Controls whether or not the line item can spend its budget and bid on inventory. * For CreateLineItem method, only `ENTITY_STATUS_DRAFT` is allowed. To activate a line item, use UpdateLineItem method and update the status to `ENTITY_STATUS_ACTIVE` after creation. * A line item cannot be changed back to `ENTITY_STATUS_DRAFT` status from any other status. * If the line item's parent insertion order is not active, the line item can't spend its budget even if its own status is `ENTITY_STATUS_ACTIVE`.
- "excludeNewExchanges": True or False, # Whether to exclude new exchanges from automatically being targeted by the line item. This field is false by default.
- "flight": { # Settings that control the active duration of a line item. # Required. The start and end time of the line item's flight.
- "dateRange": { # A date range. # The flight start and end dates of the line item. They are resolved relative to the parent advertiser's time zone. * Required when flight_date_type is `LINE_ITEM_FLIGHT_DATE_TYPE_CUSTOM`. Output only otherwise. * When creating a new flight, both `start_date` and `end_date` must be in the future. * An existing flight with a `start_date` in the past has a mutable `end_date` but an immutable `start_date`. * `end_date` must be the `start_date` or later, both before the year 2037.
- "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The upper bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- "startDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # The lower bound of the date range, inclusive. Must specify a positive value for `year`, `month`, and `day`.
- "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.
- "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.
- "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
- },
- },
- "flightDateType": "A String", # Required. The type of the line item's flight dates.
- },
- "frequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # Required. The impression frequency cap settings of the line item. The max_impressions field in this settings object must be used if assigning a limited cap.
- "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
- "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
- },
- "insertionOrderId": "A String", # Required. Immutable. The unique ID of the insertion order that the line item belongs to.
- "integrationDetails": { # Integration details of an entry. # Integration details of the line item.
- "details": "A String", # Additional details of the entry in string format. Must be UTF-8 encoded with a length of no more than 1000 characters.
- "integrationCode": "A String", # An external identifier to be associated with the entry. The integration code will show up together with the entry in many places in the system, for example, reporting. Must be UTF-8 encoded with a length of no more than 500 characters.
- },
- "lineItemId": "A String", # Output only. The unique ID of the line item. Assigned by the system.
- "lineItemType": "A String", # Required. Immutable. The type of the line item.
- "mobileApp": { # A mobile app promoted by a mobile app install line item. # The mobile app promoted by the line item. This is applicable only when line_item_type is either `LINE_ITEM_TYPE_DISPLAY_MOBILE_APP_INSTALL` or `LINE_ITEM_TYPE_VIDEO_MOBILE_APP_INSTALL`.
- "appId": "A String", # Required. The ID of the app provided by the platform store. Android apps are identified by the bundle ID used by Android's Play store, such as `com.google.android.gm`. iOS apps are identified by a nine-digit app ID used by Apple's App store, such as `422689480`.
- "displayName": "A String", # Output only. The app name.
- "platform": "A String", # Output only. The app platform.
- "publisher": "A String", # Output only. The app publisher.
- },
- "name": "A String", # Output only. The resource name of the line item.
- "pacing": { # Settings that control the rate at which a budget is spent. # Required. The budget spending speed setting of the line item.
- "dailyMaxImpressions": "A String", # Maximum number of impressions to serve every day. Applicable when the budget is impression based. Must be greater than 0.
- "dailyMaxMicros": "A String", # Maximum currency amount to spend every day in micros of advertiser's currency. Applicable when the budget is currency based. Must be greater than 0. For example, for 1.5 standard unit of the currency, set this field to 1500000. The value assigned will be rounded to whole billable units for the relevant currency by the following rules: any positive value less than a single billable unit will be rounded up to one billable unit and any value larger than a single billable unit will be rounded down to the nearest billable value. For example, if the currency's billable unit is 0.01, and this field is set to 10257770, it will round down to 10250000, a value of 10.25. If set to 505, it will round up to 10000, a value of 0.01.
- "pacingPeriod": "A String", # Required. The time period in which the pacing budget will be spent. When automatic budget allocation is enabled at the insertion order via automationType, this field is output only and defaults to `PACING_PERIOD_FLIGHT`.
- "pacingType": "A String", # Required. The type of pacing that defines how the budget amount will be spent across the pacing_period. `PACING_TYPE_ASAP` is not compatible with pacing_period `PACING_PERIOD_FLIGHT` for insertion orders.
- },
- "partnerCosts": [ # The partner costs associated with the line item. If absent or empty in CreateLineItem method, the newly created line item will inherit partner costs from its parent insertion order.
- { # Settings that control a partner cost. A partner cost is any type of expense involved in running a campaign, other than the costs of purchasing impressions (which is called the media cost) and using third-party audience segment data (data fee). Some examples of partner costs include the fees for using DV360, a third-party ad server, or a third-party ad serving verification service.
- "costType": "A String", # Required. The type of the partner cost.
- "feeAmount": "A String", # The CPM fee amount in micros of advertiser's currency. Applicable when the fee_type is `PARTNER_FEE_TYPE_CPM_FEE`. Must be greater than or equal to 0. For example, for 1.5 standard unit of the advertiser's currency, set this field to 1500000.
- "feePercentageMillis": "A String", # The media fee percentage in millis (1/1000 of a percent). Applicable when the fee_type is `PARTNER_FEE_TYPE_MEDIA_FEE`. Must be greater than or equal to 0. For example: 100 represents 0.1%.
- "feeType": "A String", # Required. The fee type for this partner cost.
- "invoiceType": "A String", # The invoice type for this partner cost. * Required when cost_type is one of: - `PARTNER_COST_TYPE_ADLOOX` - `PARTNER_COST_TYPE_DOUBLE_VERIFY` - `PARTNER_COST_TYPE_INTEGRAL_AD_SCIENCE`. * Output only for other types.
- },
- ],
- "partnerRevenueModel": { # Settings that control how partner revenue is calculated. # Required. The partner revenue model setting of the line item.
- "markupAmount": "A String", # Required. The markup amount of the partner revenue model. Must be greater than or equal to 0. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`, this field represents the CPM markup in micros of advertiser's currency. For example, 1500000 represents 1.5 standard units of the currency. * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_MEDIA_COST_MARKUP`, this field represents the media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001). * When the markup_type is set to be `PARTNER_REVENUE_MODEL_MARKUP_TYPE_TOTAL_MEDIA_COST_MARKUP`, this field represents the total media cost percent markup in millis. For example, 100 represents 0.1% (decimal 0.001).
- "markupType": "A String", # Required. The markup type of the partner revenue model.
- },
- "reservationType": "A String", # Output only. The reservation type of the line item.
- "targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists.
- "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources.
- "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources.
- "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM`
- },
- "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system.
- "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running.
- "A String",
- ],
- "youtubeAndPartnersSettings": { # Settings for YouTube and Partners line items. # Output only. Settings specific to YouTube and Partners line items.
- "contentCategory": "A String", # Output only. The kind of content on which the YouTube and Partners ads will be shown. *Warning*: This field will be removed in the near future. Use effective_content_category instead.
- "effectiveContentCategory": "A String", # Output only. The content category which takes effect when serving the line item. When content category is set in both line item and advertiser, the stricter one will take effect when serving the line item. New line items will only inherit the advertiser level setting.
- "inventorySourceSettings": { # Settings that control what YouTube related inventories the YouTube and Partners line item will target. # Settings that control what YouTube and Partners inventories the line item will target.
- "includeGoogleTv": True or False, # Optional. Whether to target inventory in video apps available with Google TV.
- "includeYoutube": True or False, # Optional. Whether to target inventory on YouTube. This includes both search, channels and videos.
- "includeYoutubeVideoPartners": True or False, # Whether to target inventory on a collection of partner sites and apps that follow the same brand safety standards as YouTube.
- },
- "leadFormId": "A String", # Optional. The ID of the form to generate leads.
- "linkedMerchantId": "A String", # Optional. The ID of the merchant which is linked to the line item for product feed.
- "relatedVideoIds": [ # Optional. The IDs of the videos appear below the primary video ad when the ad is playing in the YouTube app on mobile devices.
- "A String",
- ],
- "targetFrequency": { # Setting that controls the average number of times the ads will show to the same person over a certain period of time. # Optional. The average number of times you want ads from this line item to show to the same person over a certain period of time.
- "targetCount": "A String", # The target number of times, on average, the ads will be shown to the same person in the timespan dictated by time_unit and time_unit_count.
- "timeUnit": "A String", # The unit of time in which the target frequency will be applied. The following time unit is applicable: * `TIME_UNIT_WEEKS`
- "timeUnitCount": 42, # The number of time_unit the target frequency will last. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_WEEKS` - must be 1
- },
- "thirdPartyMeasurementConfigs": { # Settings that control what third-party vendors are measuring specific line item metrics. # Optional. The third-party measurement configs of the line item.
- "brandLiftVendorConfigs": [ # Optional. The third-party vendors measuring brand lift. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_DYNATA` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_INTAGE` * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_MACROMILL`
- { # Settings that control how third-party measurement vendors are configured.
- "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
- "vendor": "A String", # The third-party measurement vendor.
- },
- ],
- "brandSafetyVendorConfigs": [ # Optional. The third-party vendors measuring brand safety. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_ZERF` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_ZEFR`
- { # Settings that control how third-party measurement vendors are configured.
- "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
- "vendor": "A String", # The third-party measurement vendor.
- },
- ],
- "reachVendorConfigs": [ # Optional. The third-party vendors measuring reach. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_NIELSEN` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_KANTAR` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL` * `THIRD_PARTY_VENDOR_KANTAR_MILLWARD_BROWN` * `THIRD_PARTY_VENDOR_VIDEO_RESEARCH` * `THIRD_PARTY_VENDOR_MEDIA_SCOPE` * `THIRD_PARTY_VENDOR_AUDIENCE_PROJECT` * `THIRD_PARTY_VENDOR_VIDEO_AMP` * `THIRD_PARTY_VENDOR_ISPOT_TV`
- { # Settings that control how third-party measurement vendors are configured.
- "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
- "vendor": "A String", # The third-party measurement vendor.
- },
- ],
- "viewabilityVendorConfigs": [ # Optional. The third-party vendors measuring viewability. The following third-party vendors are applicable: * `THIRD_PARTY_VENDOR_MOAT` * `THIRD_PARTY_VENDOR_DOUBLE_VERIFY` * `THIRD_PARTY_VENDOR_INTEGRAL_AD_SCIENCE` * `THIRD_PARTY_VENDOR_COMSCORE` * `THIRD_PARTY_VENDOR_TELEMETRY` * `THIRD_PARTY_VENDOR_MEETRICS` * `THIRD_PARTY_VENDOR_GOOGLE_INTERNAL`
- { # Settings that control how third-party measurement vendors are configured.
- "placementId": "A String", # The ID used by the platform of the third-party vendor to identify the line item.
- "vendor": "A String", # The third-party measurement vendor.
- },
- ],
- },
- "videoAdInventoryControl": { # The video ad inventory control used in certain YouTube line item types. # Optional. The settings to control which inventory is allowed for this line item.
- "allowInFeed": True or False, # Optional. Whether ads can serve as in-feed format.
- "allowInStream": True or False, # Optional. Whether ads can serve as in-stream format.
- "allowShorts": True or False, # Optional. Whether ads can serve as shorts format.
- },
- "videoAdSequenceSettings": { # Settings related to VideoAdSequence. # Optional. The settings related to VideoAdSequence.
- "minimumDuration": "A String", # The minimum time interval before the same user sees this sequence again.
- "steps": [ # The steps of which the sequence consists.
- { # The detail of a single step in a VideoAdSequence.
- "adGroupId": "A String", # The ID of the corresponding ad group of the step.
- "interactionType": "A String", # The interaction on the previous step that will lead the viewer to this step. The first step does not have interaction_type.
- "previousStepId": "A String", # The ID of the previous step. The first step does not have previous step.
- "stepId": "A String", # The ID of the step.
- },
- ],
- },
- "viewFrequencyCap": { # Settings that control the number of times a user may be shown with the same ad during a given time period. # The view frequency cap settings of the line item. The max_views field in this settings object must be used if assigning a limited cap.
- "maxImpressions": 42, # The maximum number of times a user may be shown the same ad during this period. Must be greater than 0. Required when unlimited is `false` and max_views is not set.
- "maxViews": 42, # Optional. The maximum number of times a user may click-through or fully view an ad during this period until it is no longer served to them. Must be greater than 0. Only applicable to YouTube and Partners resources. Required when unlimited is `false` and max_impressions is not set.
- "timeUnit": "A String", # The time unit in which the frequency cap will be applied. Required when unlimited is `false`.
- "timeUnitCount": 42, # The number of time_unit the frequency cap will last. Required when unlimited is `false`. The following restrictions apply based on the value of time_unit: * `TIME_UNIT_MONTHS` - must be 1 * `TIME_UNIT_WEEKS` - must be between 1 and 4 * `TIME_UNIT_DAYS` - must be between 1 and 6 * `TIME_UNIT_HOURS` - must be between 1 and 23 * `TIME_UNIT_MINUTES` - must be between 1 and 59
- "unlimited": True or False, # Whether unlimited frequency capping is applied. When this field is set to `true`, the remaining frequency cap fields are not applicable.
- },
- },
-}
-get(advertiserId, lineItemId, x__xgafv=None)
Gets a line item. @@ -1777,7 +1560,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -1878,7 +1661,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -1981,7 +1764,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -2082,7 +1865,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2192,7 +1975,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -2293,7 +2076,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. @@ -2384,7 +2167,7 @@Method Details
"fixedBid": { # A strategy that uses a fixed bidding price. # A strategy that uses a fixed bid price. "bidAmountMicros": "A String", # The fixed bid amount, in micros of the advertiser's currency. For insertion order entity, bid_amount_micros should be set as 0. For line item entity, bid_amount_micros must be greater than or equal to billable unit of the given currency and smaller than or equal to the upper limit 1000000000. For example, 1500000 represents 1.5 standard units of the currency. }, - "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. + "maximizeSpendAutoBid": { # A strategy that automatically adjusts the bid to optimize a specified performance goal while spending the full budget. # A strategy that automatically adjusts the bid to optimize to your performance goal while spending the full budget. At insertion order level, the markup_type of line items cannot be set to `PARTNER_REVENUE_MODEL_MARKUP_TYPE_CPM`. In addition, the performance_goal_type value assigned to an insertion order determines the possible line_item_type values available for line items under that insertion order: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPA`, `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CPC`, and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` only allow for `LINE_ITEM_TYPE_DISPLAY_DEFAULT` or `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` and `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` only allow for `LINE_ITEM_TYPE_VIDEO_DEFAULT` line items. * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_REACH` only allows for `LINE_ITEM_TYPE_VIDEO_OVER_THE_TOP` line items. "customBiddingAlgorithmId": "A String", # The ID of the Custom Bidding Algorithm used by this strategy. Only applicable when performance_goal_type is set to `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CUSTOM_ALGO`. Assigning a custom bidding algorithm that uses floodlight activities not identified in floodlightActivityConfigs will return an error. "maxAverageCpmBidAmountMicros": "A String", # The maximum average CPM that may be bid, in micros of the advertiser's currency. Must be greater than or equal to a billable unit of the given currency. For example, 1500000 represents 1.5 standard units of the currency. "performanceGoalType": "A String", # Required. The type of the performance goal that the bidding strategy tries to minimize while spending the full budget. `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` is not supported for this strategy. @@ -2485,7 +2268,7 @@Method Details
"targetingExpansion": { # Settings that control the [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. # The [optimized targeting](//support.google.com/displayvideo/answer/12060859) settings of the line item. This config is only applicable for display, video, or audio line items that use automated bidding and positively target eligible audience lists. "audienceExpansionLevel": "A String", # Output only. Magnitude of expansion for eligible first-party user lists under this ad group. This field only applies to YouTube and Partners line item and ad group resources. "audienceExpansionSeedListExcluded": True or False, # Output only. Whether to exclude seed list for audience expansion. This field only applies to YouTube and Partners line item and ad group resources. - "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` + "enableOptimizedTargeting": True or False, # Required. Whether to enable Optimized Targeting for the line item. Optimized targeting is not compatible with all bid strategies. Attempting to set this field to `true` for a line item using the BiddingStrategy field fixed_bid or one of the following combinations of BiddingStrategy fields and BiddingStrategyPerformanceGoalType will result in an error: maximize_auto_spend_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_CIVA` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_IVO_TEN` * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_AV_VIEWED` performance_goal_auto_bid: * `BIDDING_STRATEGY_PERFORMANCE_GOAL_TYPE_VIEWABLE_CPM` This also applies if the line item inherits one of the above bid strategies from the parent insertion order. Bid strategies set at the insertion order-level will be inherited by their line items if the `InsertionOrder` budget field automationType is set to `INSERTION_ORDER_AUTOMATION_TYPE_BUDGET` or `INSERTION_ORDER_AUTOMATION_TYPE_BID_BUDGET`. }, "updateTime": "A String", # Output only. The timestamp when the line item was last updated. Assigned by the system. "warningMessages": [ # Output only. The warning messages generated by the line item. These warnings do not block saving the line item, but some may block the line item from running. diff --git a/docs/dyn/dns_v1.resourceRecordSets.html b/docs/dyn/dns_v1.resourceRecordSets.html index 3a30e041e2..eefffd3e17 100644 --- a/docs/dyn/dns_v1.resourceRecordSets.html +++ b/docs/dyn/dns_v1.resourceRecordSets.html @@ -87,7 +87,7 @@Instance Methods
get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)Fetches the representation of an existing ResourceRecordSet.
-
+list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)list(project, managedZone, filter=None, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)Enumerates ResourceRecordSets that you have created but not yet deleted.
@@ -571,12 +571,13 @@Method Details
list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
+ list(project, managedZone, filter=None, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
Enumerates ResourceRecordSets that you have created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
+ filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name="example.com." - name="example.com." AND type="A" - name=has_suffix("example.com.") - name=has_suffix("example.com.") AND type="A"
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
diff --git a/docs/dyn/dns_v1beta2.resourceRecordSets.html b/docs/dyn/dns_v1beta2.resourceRecordSets.html
index 2456b95f68..b12ec3cb95 100644
--- a/docs/dyn/dns_v1beta2.resourceRecordSets.html
+++ b/docs/dyn/dns_v1beta2.resourceRecordSets.html
@@ -87,7 +87,7 @@ Instance Methods
get(project, managedZone, name, type, clientOperationId=None, x__xgafv=None)
Fetches the representation of an existing ResourceRecordSet.
- list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
+ list(project, managedZone, filter=None, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
Enumerates ResourceRecordSets that you have created but not yet deleted.
@@ -761,12 +761,13 @@ Method Details
list(project, managedZone, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
+ list(project, managedZone, filter=None, maxResults=None, name=None, pageToken=None, type=None, x__xgafv=None)
Enumerates ResourceRecordSets that you have created but not yet deleted.
Args:
project: string, Identifies the project addressed by this request. (required)
managedZone: string, Identifies the managed zone addressed by this request. Can be the managed zone name or ID. (required)
+ filter: string, Specify a filter expression to view records that exactly match the specified domain. Both the name and type parameters are not supported when you use filter and must be omitted. Your filter expression must conform to AIP-160 and you must specify a domain in the name field. Optionally, you can include the type field to filter records by type. You can also include the has_suffix function to view records that match by domain suffix. Examples: - name="example.com." - name="example.com." AND type="A" - name=has_suffix("example.com.") - name=has_suffix("example.com.") AND type="A"
maxResults: integer, Optional. Maximum number of results to be returned. If unspecified, the server decides how many results to return.
name: string, Specify a fully qualified domain name to view only those records. The name parameter is not supported and must be omitted when you use filter.
pageToken: string, Optional. A tag returned by a previous list request that was truncated. Use this parameter to continue a previous list request.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.html b/docs/dyn/documentai_v1.projects.locations.processors.html
index e37582555f..9469c4f0b5 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.html
@@ -1580,6 +1580,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -2775,6 +2776,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
index d09c28d46e..2bf11f9910 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.humanReviewConfig.html
@@ -1165,6 +1165,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
index 63c17553d2..7ea6077e13 100644
--- a/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
+++ b/docs/dyn/documentai_v1.projects.locations.processors.processorVersions.html
@@ -1672,6 +1672,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -2867,6 +2868,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html
index 37ec6c7a93..8cb71dad79 100644
--- a/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html
+++ b/docs/dyn/documentai_v1.projects.locations.schemas.schemaVersions.html
@@ -1395,6 +1395,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
index a023a02ddd..3f86379596 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.dataset.html
@@ -1339,6 +1339,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
index 876c08480b..9e41db579b 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.html
@@ -1650,6 +1650,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -2798,6 +2799,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -4052,6 +4054,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
index 484c819588..ffdf4d0e61 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.humanReviewConfig.html
@@ -1170,6 +1170,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -2361,6 +2362,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
index 1d58e12f3e..91c1b0f7e4 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.processors.processorVersions.html
@@ -1811,6 +1811,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -2959,6 +2960,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
@@ -4213,6 +4215,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html
index 3a95eb9531..4a5b66b0ea 100644
--- a/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html
+++ b/docs/dyn/documentai_v1beta3.projects.locations.schemas.schemaVersions.html
@@ -1491,6 +1491,7 @@ Method Details
},
],
"shardInfo": { # For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is. # Information about the sharding if this document is sharded part of a larger document. If the document is not sharded, this message is not specified.
+ "pageOffset": 42, # The index of the first page in Document.pages in the overall document global pages. Available for document shards created by the document splitter.
"shardCount": "A String", # Total number of shards.
"shardIndex": "A String", # The 0-based index of this shard.
"textOffset": "A String", # The index of the first character in Document.text in the overall document global text.
diff --git a/docs/dyn/drive_v3.approvals.html b/docs/dyn/drive_v3.approvals.html
index 1082225714..de983b8690 100644
--- a/docs/dyn/drive_v3.approvals.html
+++ b/docs/dyn/drive_v3.approvals.html
@@ -109,7 +109,7 @@ Method Details
{ # Metadata for an approval. An approval is a review/approve process for a Drive item.
"approvalId": "A String", # The Approval ID.
- "completeTime": "A String", # Output only. The time time the approval was completed.
+ "completeTime": "A String", # Output only. The time the approval was completed.
"createTime": "A String", # Output only. The time the approval was created.
"dueTime": "A String", # The time that the approval is due.
"initiator": { # Information about a Drive user. # The user that requested the Approval.
@@ -161,7 +161,7 @@ Method Details
"items": [ # The list of Approvals. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
{ # Metadata for an approval. An approval is a review/approve process for a Drive item.
"approvalId": "A String", # The Approval ID.
- "completeTime": "A String", # Output only. The time time the approval was completed.
+ "completeTime": "A String", # Output only. The time the approval was completed.
"createTime": "A String", # Output only. The time the approval was created.
"dueTime": "A String", # The time that the approval is due.
"initiator": { # Information about a Drive user. # The user that requested the Approval.
diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html
index f12f037434..3c81f7f49b 100644
--- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html
+++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.builds.html
@@ -125,7 +125,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -137,7 +137,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -173,14 +173,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -195,6 +195,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
@@ -308,7 +309,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -320,7 +321,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -356,14 +357,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -378,6 +379,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
@@ -429,7 +431,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -441,7 +443,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -477,14 +479,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -499,6 +501,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
diff --git a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.html
index a71b039db9..72c03bf453 100644
--- a/docs/dyn/firebaseapphosting_v1.projects.locations.backends.html
+++ b/docs/dyn/firebaseapphosting_v1.projects.locations.backends.html
@@ -137,7 +137,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -257,7 +257,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -314,7 +314,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -379,7 +379,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html
index bfce3e080b..535e1cd753 100644
--- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html
+++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.builds.html
@@ -125,7 +125,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -137,7 +137,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -149,7 +149,7 @@ Method Details
"deleteTime": "A String", # Output only. Time at which the build was deleted.
"displayName": "A String", # Optional. Human-readable name. 63 character limit.
"environment": "A String", # Output only. The environment name of the backend when this build was created.
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Deprecated: Use `errors` instead. A status and (human readable) error message for the build, if in a `FAILED` state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -158,7 +158,7 @@ Method Details
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "errorSource": "A String", # Output only. Deprecated: Use `errors` instead. The source of the error for the build, if in a `FAILED` state.
"errors": [ # Output only. A list of all errors that occurred during an App Hosting build.
{ # The container for the rpc status and source for any errors found during the build process.
"cloudResource": "A String", # Output only. Resource link
@@ -183,14 +183,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -205,6 +205,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
@@ -318,7 +319,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -330,7 +331,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -342,7 +343,7 @@ Method Details
"deleteTime": "A String", # Output only. Time at which the build was deleted.
"displayName": "A String", # Optional. Human-readable name. 63 character limit.
"environment": "A String", # Output only. The environment name of the backend when this build was created.
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Deprecated: Use `errors` instead. A status and (human readable) error message for the build, if in a `FAILED` state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -351,7 +352,7 @@ Method Details
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "errorSource": "A String", # Output only. Deprecated: Use `errors` instead. The source of the error for the build, if in a `FAILED` state.
"errors": [ # Output only. A list of all errors that occurred during an App Hosting build.
{ # The container for the rpc status and source for any errors found during the build process.
"cloudResource": "A String", # Output only. Resource link
@@ -376,14 +377,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -398,6 +399,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
@@ -449,7 +451,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_build_source) Attempts to set this for other build types will result in an error
+ "env": [ # Optional. Supplied environment variables for a specific build. Provided at Build creation time and immutable afterwards. This field is only applicable for Builds using a build image - (e.g., ContainerSource or ArchiveSource with locally_built_source) Attempts to set this for other build types will result in an error
{ # Environment variables for this build.
"availability": [ # Optional. Where this variable should be made available. If left unspecified, will be available in both BUILD and BACKEND.
"A String",
@@ -461,7 +463,7 @@ Method Details
"variable": "A String", # Required. The name of the environment variable. - Must be a valid environment variable name (e.g. A-Z or underscores). - May not start with "FIREBASE" or "GOOGLE". - May not be a reserved environment variable for KNative/Cloud Run
},
],
- "runConfig": { # Additional configuration to apply to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
+ "runConfig": { # Configuration applied to the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service). # Optional. Additional configuration of the Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service).
"concurrency": 42, # Optional. Maximum number of requests that each Cloud Run instance can receive. By default, each instance can receive Cloud Run's default of up to 80 requests at the same time. Concurrency can be set to any integer value up to 1000.
"cpu": 3.14, # Optional. Number of CPUs used for each serving instance. By default, cpu defaults to the Cloud Run's default of 1.0. CPU can be set to value 1, 2, 4, 6, or 8 CPUs, and for less than 1 CPU, a value from 0.08 to less than 1.00, in increments of 0.01. If you set a value of less than 1 CPU, you must set concurrency to 1, and CPU will only be allocated during request processing. Increasing CPUs limit may require increase in memory limits: - 4 CPUs: at least 2 GiB - 6 CPUs: at least 4 GiB - 8 CPUs: at least 4 GiB
"maxInstances": 42, # Optional. Number of Cloud Run instances to maintain at maximum for each revision. By default, each Cloud Run [`service`](https://cloud.google.com/run/docs/reference/rest/v2/projects.locations.services#resource:-service) scales out to Cloud Run's default of a maximum of 100 instances. The maximum max_instances limit is based on your quota. See https://cloud.google.com/run/docs/configuring/max-instances#limits.
@@ -473,7 +475,7 @@ Method Details
"deleteTime": "A String", # Output only. Time at which the build was deleted.
"displayName": "A String", # Optional. Human-readable name. 63 character limit.
"environment": "A String", # Output only. The environment name of the backend when this build was created.
- "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. A status and (human readable) error message for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # Output only. Deprecated: Use `errors` instead. A status and (human readable) error message for the build, if in a `FAILED` state.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
@@ -482,7 +484,7 @@ Method Details
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
- "errorSource": "A String", # Output only. The source of the error for the build, if in a `FAILED` state. Deprecated: Use `errors` instead.
+ "errorSource": "A String", # Output only. Deprecated: Use `errors` instead. The source of the error for the build, if in a `FAILED` state.
"errors": [ # Output only. A list of all errors that occurred during an App Hosting build.
{ # The container for the rpc status and source for any errors found during the build process.
"cloudResource": "A String", # Output only. Resource link
@@ -507,14 +509,14 @@ Method Details
"reconciling": True or False, # Output only. A field that, if true, indicates that the build has an ongoing LRO.
"source": { # The source for the build. # Required. Immutable. The source for the build.
"archive": { # The URI of an storage archive or a signed URL to use as the build source. # An archive source.
- "author": { # Metadata for the user who started the build. # Optional. The author contained in the metadata of a version control change.
- "displayName": "A String", # Output only. The user-chosen displayname. May be empty.
- "email": "A String", # Output only. The account email linked to the EUC that created the build. May be a service account or other robot account.
- "imageUri": "A String", # Output only. The URI of a profile photo associated with the user who created the build.
+ "author": { # Deprecated: Not used. Metadata for the user who started the build. # Optional. Deprecated: Not used. The author contained in the metadata of a version control change.
+ "displayName": "A String", # Output only. Deprecated: Not used. The user-chosen displayname. May be empty.
+ "email": "A String", # Output only. Deprecated: Not used. The account email linked to the EUC that created the build. May be a service account or other robot account.
+ "imageUri": "A String", # Output only. Deprecated: Not used. The URI of a profile photo associated with the user who created the build.
},
"description": "A String", # Optional. An optional message that describes the uploaded version of the source code.
"externalSignedUri": "A String", # Signed URL to an archive in a storage bucket.
- "rootDirectory": "A String", # Optional. Relative path in the archive.
+ "rootDirectory": "A String", # Optional. The directory relative to the root of the archive to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
"userStorageUri": "A String", # URI to an archive in Cloud Storage. The object must be a zipped (.zip) or gzipped archive file (.tar.gz) containing source to deploy.
},
"codebase": { # A codebase source, representing the state of the codebase that the build will be created at. # A codebase source.
@@ -529,6 +531,7 @@ Method Details
"commitTime": "A String", # Output only. The time the change was made.
"displayName": "A String", # Output only. The human-friendly name to use for this Codebase when displaying a build. We use the first eight characters of the SHA-1 hash for GitHub.com.
"hash": "A String", # Output only. The full SHA-1 hash of a Git commit, if available.
+ "repository": "A String", # Output only. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) used for this build, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}`
"uri": "A String", # Output only. A URI linking to the codebase on an hosting provider's website. May not be valid if the commit has been rebased or force-pushed out of existence in the linked repository.
},
"container": { # The URI of an Artifact Registry [container image](https://cloud.google.com/artifact-registry/docs/reference/rest/v1/projects.locations.repositories.dockerImages) to use as the build source. # An Artifact Registry container image source.
diff --git a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
index 1f1832447d..56ee358902 100644
--- a/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
+++ b/docs/dyn/firebaseapphosting_v1beta.projects.locations.backends.html
@@ -137,7 +137,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -269,7 +269,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -338,7 +338,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
@@ -415,7 +415,7 @@ Method Details
"appId": "A String", # Optional. The [ID of a Web App](https://firebase.google.com/docs/reference/firebase-management/rest/v1beta1/projects.webApps#WebApp.FIELDS.app_id) associated with the backend.
"codebase": { # The connection to an external source repository to watch for event-driven updates to the backend. # Optional. If specified, the connection to an external source repository to watch for event-driven updates to the backend.
"repository": "A String", # Required. The resource name for the Developer Connect [`gitRepositoryLink`](https://cloud.google.com/developer-connect/docs/api/reference/rest/v1/projects.locations.connections.gitRepositoryLinks) connected to this backend, in the format: `projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}` The connection for the `gitRepositoryLink` must made be using the Firebase App Hosting GitHub App via the Firebase Console.
- "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app.
+ "rootDirectory": "A String", # Optional. If `repository` is provided, the directory relative to the root of the repository to use as the root for the deployed web app. Defaults to use the root of the repository if not provided. If deploying a [monorepo](https://firebase.google.com/docs/app-hosting/monorepos), this should be the directory that contains the `package.json` or `apphosting.yaml` file.
},
"createTime": "A String", # Output only. Time at which the backend was created.
"deleteTime": "A String", # Output only. Time at which the backend was deleted.
diff --git a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
index d0e7caee71..3aa1725f8a 100644
--- a/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
+++ b/docs/dyn/firebaseml_v2beta.projects.locations.publishers.models.html
@@ -216,7 +216,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -404,7 +404,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -444,7 +444,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -485,6 +485,12 @@ Method Details
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
+ "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+ "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+ },
+ "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+ },
+ },
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
@@ -739,7 +745,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -953,7 +959,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -993,7 +999,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -1034,6 +1040,12 @@ Method Details
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
+ "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+ "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+ },
+ "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+ },
+ },
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
@@ -1253,6 +1265,12 @@ Method Details
"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
"groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
{ # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+ "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details.
+ "domain": "A String", # The domain of the image search result page.
+ "imageUri": "A String", # The URI of the image.
+ "sourceUri": "A String", # The URI of the image search result page.
+ "title": "A String", # The title of the image search result page.
+ },
"maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
"placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
"reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
@@ -1264,6 +1282,11 @@ Method Details
],
},
"placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+ "route": { # Route information from Google Maps. # Output only. Route information.
+ "distanceMeters": 42, # The total distance of the route, in meters.
+ "duration": "A String", # The total duration of the route.
+ "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+ },
"text": "A String", # The text of the place answer.
"title": "A String", # The title of the place.
"uri": "A String", # The URI of the place.
@@ -1289,13 +1312,16 @@ Method Details
},
],
"groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
- { # A collection of supporting references for a segment of the model's response.
+ { # A collection of supporting references for a segment or part of the model's response.
"confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
3.14,
],
"groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
42,
],
+ "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.
+ 42,
+ ],
"segment": { # A segment of the content. # The content segment that this support message applies to.
"endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
"partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
@@ -1304,6 +1330,9 @@ Method Details
},
},
],
+ "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.
+ "A String",
+ ],
"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
"googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
},
@@ -1545,7 +1574,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -1759,7 +1788,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -1799,7 +1828,7 @@ Method Details
"defs": { # Optional. `defs` provides a map of schema definitions that can be reused by `ref` elsewhere in the schema. Only allowed at root level of the schema.
"a_key": # Object with schema name: GoogleCloudAiplatformV1beta1Schema
},
- "description": "A String", # Optional. Description of the schema.
+ "description": "A String", # Optional. Describes the data. The model uses this field to understand the purpose of the schema and how to use it. It is a best practice to provide a clear and descriptive explanation for the schema and its properties here, rather than in the prompt.
"enum": [ # Optional. Possible values of the field. This field can be used to restrict a value to a fixed set of values. To mark a field as an enum, set `format` to `enum` and provide the list of possible values in `enum`. For example: 1. To define directions: `{type:STRING, format:enum, enum:["EAST", "NORTH", "SOUTH", "WEST"]}` 2. To define apartment numbers: `{type:INTEGER, format:enum, enum:["101", "201", "301"]}`
"A String",
],
@@ -1840,6 +1869,12 @@ Method Details
"excludeDomains": [ # Optional. List of domains to be excluded from the search results. The default limit is 2000 domains. Example: ["amazon.com", "facebook.com"].
"A String",
],
+ "searchTypes": { # Different types of search that can be enabled on the GoogleSearch tool. # Optional. The set of search types to enable. If not set, web search is enabled by default.
+ "imageSearch": { # Image search for grounding and related configurations. # Optional. Setting this field enables image search. Image bytes are returned.
+ },
+ "webSearch": { # Standard web search for grounding and related configurations. Only text results are returned. # Optional. Setting this field enables web search. Only text results are returned.
+ },
+ },
},
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. Specialized retrieval tool that is powered by Google Search.
"dynamicRetrievalConfig": { # Describes the options to customize dynamic retrieval. # Specifies the dynamic retrieval configuration for the given source.
@@ -2059,6 +2094,12 @@ Method Details
"googleMapsWidgetContextToken": "A String", # Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.
"groundingChunks": [ # A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.
{ # A piece of evidence that supports a claim made by the model. This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a `GroundingChunk` that contains a reference to the source of the information.
+ "image": { # An `Image` chunk is a piece of evidence that comes from an image search result. It contains the URI of the image search result and the URI of the image. This is used to provide the user with a link to the source of the information. # A grounding chunk from an image search result. See the `Image` message for details.
+ "domain": "A String", # The domain of the image search result page.
+ "imageUri": "A String", # The URI of the image.
+ "sourceUri": "A String", # The URI of the image search result page.
+ "title": "A String", # The title of the image search result page.
+ },
"maps": { # A `Maps` chunk is a piece of evidence that comes from Google Maps, containing information about places or routes. This is used to provide the user with rich, location-based information. # A grounding chunk from Google Maps. See the `Maps` message for details.
"placeAnswerSources": { # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content. # The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.
"reviewSnippets": [ # Snippets of reviews that were used to generate the answer.
@@ -2070,6 +2111,11 @@ Method Details
],
},
"placeId": "A String", # This Place's resource name, in `places/{place_id}` format. This can be used to look up the place in the Google Maps API.
+ "route": { # Route information from Google Maps. # Output only. Route information.
+ "distanceMeters": 42, # The total distance of the route, in meters.
+ "duration": "A String", # The total duration of the route.
+ "encodedPolyline": "A String", # An encoded polyline of the route. See https://developers.google.com/maps/documentation/utilities/polylinealgorithm
+ },
"text": "A String", # The text of the place answer.
"title": "A String", # The title of the place.
"uri": "A String", # The URI of the place.
@@ -2095,13 +2141,16 @@ Method Details
},
],
"groundingSupports": [ # Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.
- { # A collection of supporting references for a segment of the model's response.
+ { # A collection of supporting references for a segment or part of the model's response.
"confidenceScores": [ # The confidence scores for the support references. This list is parallel to the `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim. For Gemini 2.0 and before, this list has the same size as `grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and should be ignored.
3.14,
],
"groundingChunkIndices": [ # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` message. These indices specify which grounding chunks support the claim made in the content segment. For example, if this field has the values `[1, 3]`, it means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for the claim in the content segment.
42,
],
+ "renderedParts": [ # Indices into the `rendered_parts` field of the `GroundingMetadata` message. These indices specify which rendered parts are associated with this support message.
+ 42,
+ ],
"segment": { # A segment of the content. # The content segment that this support message applies to.
"endIndex": 42, # Output only. The end index of the segment in the `Part`, measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.
"partIndex": 42, # Output only. The index of the `Part` object that this segment belongs to. This is useful for associating the segment with a specific part of the content.
@@ -2110,6 +2159,9 @@ Method Details
},
},
],
+ "imageSearchQueries": [ # Optional. The image search queries that were used to generate the content. This field is populated only when the grounding source is Google Search with the Image Search search_type enabled.
+ "A String",
+ ],
"retrievalMetadata": { # Metadata related to the retrieval grounding source. This is part of the `GroundingMetadata` returned when grounding is enabled. # Optional. Output only. Metadata related to the retrieval grounding source.
"googleSearchDynamicRetrievalScore": 3.14, # Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.
},
diff --git a/docs/dyn/integrations_v1.projects.locations.connections.html b/docs/dyn/integrations_v1.projects.locations.connections.html
index a665ec39a2..e1795d8a5d 100644
--- a/docs/dyn/integrations_v1.projects.locations.connections.html
+++ b/docs/dyn/integrations_v1.projects.locations.connections.html
@@ -151,17 +151,17 @@ Method Details
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
@@ -226,17 +226,17 @@ Method Details
},
"configVariables": [ # Optional. Configuration for configuring the connection with an external system.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"connectionRevision": "A String", # Output only. Connection revision. This field is only updated when the connection is created or updated by User.
@@ -268,31 +268,31 @@ Method Details
"description": "A String", # Optional. Description of the resource.
"destinationConfigs": [ # Optional. Configuration of the Connector's destination. Only accepted for Connectors that accepts user defined destination(s).
{ # Define the Connectors target endpoint.
- "destinations": [ # The destinations for the key.
+ "destinations": [ # Optional. The destinations for the key.
{
"host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
+ "port": 42, # Optional. The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ "key": "A String", # Optional. The key is the destination identifier that is supported by the Connector.
},
],
"envoyImageLocation": "A String", # Output only. GCR location where the envoy image is stored. formatted like: gcr.io/{bucketName}/{imageName}
"euaOauthAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Additional Oauth2.0 Auth config for EUA. If the connection is configured using non-OAuth authentication but OAuth needs to be used for EUA, this field can be populated with the OAuth config. This should be a OAuth2AuthCodeFlow Auth type only.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
@@ -351,36 +351,39 @@ Method Details
"username": "A String", # Optional. Username.
},
},
- "eventingConfig": { # Eventing Configuration of a connection next: 19 # Optional. Eventing config of a connection
+ "eventingConfig": { # Eventing Configuration of a connection next: 20 # Optional. Eventing config of a connection
"additionalVariables": [ # Optional. Additional eventing related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
+ "allowedEventTypes": [ # Optional. List of allowed event types for the connection.
+ "A String",
+ ],
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the webhook adapter.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
@@ -447,21 +450,21 @@ Method Details
"appendAcl": True or False, # Optional. Append ACL to the event.
},
"enrichmentEnabled": True or False, # Optional. Enrichment Enabled.
- "eventsListenerIngressEndpoint": "A String", # Optional. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
+ "eventsListenerIngressEndpoint": "A String", # Output only. Ingress endpoint of the event listener. This is used only when private connectivity is enabled.
"listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener.
"additionalVariables": [ # Optional. List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"authKey": "A String", # Optional. Identifier key for auth config
@@ -525,39 +528,39 @@ Method Details
],
"privateConnectivityEnabled": True or False, # Optional. Private Connectivity Enabled.
"proxyDestinationConfig": { # Define the Connectors target endpoint. # Optional. Proxy for Eventing auto-registration.
- "destinations": [ # The destinations for the key.
+ "destinations": [ # Optional. The destinations for the key.
{
"host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
+ "port": 42, # Optional. The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ "key": "A String", # Optional. The key is the destination identifier that is supported by the Connector.
},
"registrationDestinationConfig": { # Define the Connectors target endpoint. # Optional. Registration endpoint for auto registration.
- "destinations": [ # The destinations for the key.
+ "destinations": [ # Optional. The destinations for the key.
{
"host": "A String", # For publicly routable host.
- "port": 42, # The port is the target port number that is accepted by the destination.
+ "port": 42, # Optional. The port is the target port number that is accepted by the destination.
"serviceAttachment": "A String", # PSC service attachments. Format: projects/*/regions/*/serviceAttachments/*
},
],
- "key": "A String", # The key is the destination identifier that is supported by the Connector.
+ "key": "A String", # Optional. The key is the destination identifier that is supported by the Connector.
},
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Optional. Additional SSL related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"clientCertType": "A String", # Optional. Type of Client Cert (PEM/JKS/.. etc.)
@@ -590,17 +593,17 @@ Method Details
"webhookData": { # WebhookData has details of webhook configuration. # Output only. Webhook data.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
@@ -614,17 +617,17 @@ Method Details
{ # WebhookData has details of webhook configuration.
"additionalVariables": [ # Output only. Additional webhook related field values.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"createTime": "A String", # Output only. Timestamp when the webhook was created.
@@ -661,17 +664,17 @@ Method Details
"sslConfig": { # SSL Configuration of a connection # Optional. Ssl config of a connection
"additionalVariables": [ # Optional. Additional SSL related field values
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
- "boolValue": True or False, # Value is a bool.
- "encryptionKeyValue": { # Encryption Key value. # Value is a Encryption Key.
+ "boolValue": True or False, # Optional. Value is a bool.
+ "encryptionKeyValue": { # Encryption Key value. # Optional. Value is a Encryption Key.
"kmsKeyName": "A String", # Optional. The [KMS key name] with which the content of the Operation is encrypted. The expected format: `projects/*/locations/*/keyRings/*/cryptoKeys/*`. Will be empty string if google managed.
- "type": "A String", # Type.
+ "type": "A String", # Optional. Specifies the type of the encryption key.
},
- "intValue": "A String", # Value is an integer
+ "intValue": "A String", # Optional. Value is an integer
"key": "A String", # Optional. Key of the config variable.
- "secretValue": { # Secret provides a reference to entries in Secret Manager. # Value is a secret.
+ "secretValue": { # Secret provides a reference to entries in Secret Manager. # Optional. Value is a secret.
"secretVersion": "A String", # Optional. The resource name of the secret version in the format, format as: `projects/*/secrets/*/versions/*`.
},
- "stringValue": "A String", # Value is a string.
+ "stringValue": "A String", # Optional. Value is a string.
},
],
"clientCertType": "A String", # Optional. Type of Client Cert (PEM/JKS/.. etc.)
@@ -702,7 +705,7 @@ Method Details
"tlsServiceDirectory": "A String", # Output only. The name of the Service Directory service with TLS.
"trafficShapingConfigs": [ # Optional. Traffic shaping configuration for the connection.
{ # * TrafficShapingConfig defines the configuration for shaping API traffic by specifying a quota limit and the duration over which this limit is enforced. This configuration helps to control and manage the rate at which API calls are made on the client side, preventing service overload on the backend. For example: - if the quota limit is 100 calls per 10 seconds, then the message would be: { quota_limit: 100 duration: { seconds: 10 } } - if the quota limit is 100 calls per 5 minutes, then the message would be: { quota_limit: 100 duration: { seconds: 300 } } - if the quota limit is 10000 calls per day, then the message would be: { quota_limit: 10000 duration: { seconds: 86400 } and so on.
- "duration": "A String", # Required. * The duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
+ "duration": "A String", # Required. Specifies the duration over which the API call quota limits are calculated. This duration is used to define the time window for evaluating if the number of API calls made by a user is within the allowed quota limits. For example: - To define a quota sampled over 16 seconds, set `seconds` to 16 - To define a quota sampled over 5 minutes, set `seconds` to 300 (5 * 60) - To define a quota sampled over 1 day, set `seconds` to 86400 (24 * 60 * 60) and so on. It is important to note that this duration is not the time the quota is valid for, but rather the time window over which the quota is evaluated. For example, if the quota is 100 calls per 10 seconds, then this duration field would be set to 10 seconds.
"quotaLimit": "A String", # Required. Maximum number of api calls allowed.
},
],
diff --git a/docs/dyn/memcache_v1.projects.locations.instances.html b/docs/dyn/memcache_v1.projects.locations.instances.html
index b6fc51b576..16aa7467b6 100644
--- a/docs/dyn/memcache_v1.projects.locations.instances.html
+++ b/docs/dyn/memcache_v1.projects.locations.instances.html
@@ -175,9 +175,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -209,6 +213,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -333,9 +338,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -367,6 +376,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -456,9 +466,13 @@ Method Details
"instances": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -490,6 +504,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -565,9 +580,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -599,6 +618,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
diff --git a/docs/dyn/memcache_v1beta2.projects.locations.instances.html b/docs/dyn/memcache_v1beta2.projects.locations.instances.html
index 4605cc1eb9..2d51a714b3 100644
--- a/docs/dyn/memcache_v1beta2.projects.locations.instances.html
+++ b/docs/dyn/memcache_v1beta2.projects.locations.instances.html
@@ -217,9 +217,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -251,6 +255,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -377,9 +382,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -411,6 +420,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -480,9 +490,13 @@ Method Details
"resources": [ # A list of Memcached instances in the project in the specified location, or across all locations. If the `location_id` in the parent field of the request is "-", all regions available to the project are queried, and the results aggregated.
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -514,6 +528,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
@@ -590,9 +605,13 @@ Method Details
{ # A Memorystore for Memcached instance
"authorizedNetwork": "A String", # The full name of the Google Compute Engine [network](https://cloud.google.com/vpc/docs/vpc) to which the instance is connected. If left unspecified, the `default` network will be used.
+ "availableMaintenanceVersions": [ # Output only. The available maintenance versions that can be applied to the instance.
+ "A String",
+ ],
"createTime": "A String", # Output only. The time the instance was created.
"discoveryEndpoint": "A String", # Output only. Endpoint for the Discovery API.
"displayName": "A String", # User provided name for the instance, which is only used for display purposes. Cannot be more than 80 characters.
+ "effectiveMaintenanceVersion": "A String", # Output only. The effective maintenance version of the instance.
"instanceMessages": [ # List of messages that describe the current state of the Memcached instance.
{
"code": "A String", # A code that correspond to one type of user-facing message.
@@ -624,6 +643,7 @@ Method Details
"scheduleDeadlineTime": "A String", # Output only. The deadline that the maintenance schedule start time can not go beyond, including reschedule.
"startTime": "A String", # Output only. The start time of any upcoming scheduled maintenance for this instance.
},
+ "maintenanceVersion": "A String", # Optional. Last self service update maintenance version triggered by the customer. If it is empty, it means that the maintenance version is not set by the user.
"memcacheFullVersion": "A String", # Output only. The full version of memcached server running on this instance. System automatically determines the full memcached version for an instance based on the input MemcacheVersion. The full version format will be "memcached-1.5.16".
"memcacheNodes": [ # Output only. List of Memcached nodes. Refer to Node message for more details.
{
diff --git a/docs/dyn/merchantapi_products_v1.accounts.products.html b/docs/dyn/merchantapi_products_v1.accounts.products.html
index ffcf0f6773..4313a2b001 100644
--- a/docs/dyn/merchantapi_products_v1.accounts.products.html
+++ b/docs/dyn/merchantapi_products_v1.accounts.products.html
@@ -461,7 +461,7 @@ Method Details
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
- { # The destination status of the product status.
+ { # The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
@@ -870,7 +870,7 @@ Method Details
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
- { # The destination status of the product status.
+ { # The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
diff --git a/docs/dyn/merchantapi_products_v1beta.accounts.products.html b/docs/dyn/merchantapi_products_v1beta.accounts.products.html
index b176bd7dfd..79ae70e6a6 100644
--- a/docs/dyn/merchantapi_products_v1beta.accounts.products.html
+++ b/docs/dyn/merchantapi_products_v1beta.accounts.products.html
@@ -432,7 +432,7 @@ Method Details
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
- { # The destination status of the product status.
+ { # The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
@@ -812,7 +812,7 @@ Method Details
"productStatus": { # The status of a product, data validation issues, that is, information about a product computed asynchronously. # Output only. The status of a product, data validation issues, that is, information about a product computed asynchronously.
"creationDate": "A String", # Date on which the item has been created, in [ISO 8601](http://en.wikipedia.org/wiki/ISO_8601) format.
"destinationStatuses": [ # The intended destinations for the product.
- { # The destination status of the product status.
+ { # The destination status of the product status. Equivalent to `StatusPerReportingContext` in Reports API.
"approvedCountries": [ # List of country codes (ISO 3166-1 alpha-2) where the offer is approved.
"A String",
],
diff --git a/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html b/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html
index 4492387206..c1185dcb63 100644
--- a/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html
+++ b/docs/dyn/merchantapi_promotions_v1.accounts.promotions.html
@@ -111,67 +111,78 @@ Method Details
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
- "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
+ "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
+ "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
"customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
- "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
- "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
+ "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
+ "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
+ "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).
"getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`.
- "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en).
+ "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).
"A String",
],
- "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion.
+ "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.
"A String",
],
- "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
"limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumPurchaseQuantity": "A String",
- "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion.
+ "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
+ "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
"percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion.
- "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set.
- "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.
+ "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)
+ "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)
"A String",
],
"promotionDisplayTimePeriod": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads.
@@ -184,11 +195,14 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
- "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).
"A String",
],
- "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
+ "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
"A String",
],
},
@@ -251,67 +265,78 @@ Method Details
"dataSource": "A String", # Required. The data source of the [promotion](https://support.google.com/merchants/answer/6396268?sjid=5155774230887277618-NC) Format: `accounts/{account}/dataSources/{datasource}`.
"promotion": { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. # Required. The promotion to insert.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
- "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
+ "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
+ "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
"customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
- "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
- "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
+ "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
+ "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
+ "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).
"getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`.
- "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en).
+ "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).
"A String",
],
- "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion.
+ "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.
"A String",
],
- "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
"limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumPurchaseQuantity": "A String",
- "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion.
+ "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
+ "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
"percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion.
- "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set.
- "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.
+ "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)
+ "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)
"A String",
],
"promotionDisplayTimePeriod": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads.
@@ -324,11 +349,14 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
- "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).
"A String",
],
- "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
+ "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
"A String",
],
},
@@ -388,67 +416,78 @@ Method Details
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
- "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
+ "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
+ "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
"customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
- "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
- "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
+ "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
+ "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
+ "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).
"getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`.
- "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en).
+ "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).
"A String",
],
- "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion.
+ "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.
"A String",
],
- "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
"limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumPurchaseQuantity": "A String",
- "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion.
+ "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
+ "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
"percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion.
- "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set.
- "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.
+ "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)
+ "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)
"A String",
],
"promotionDisplayTimePeriod": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads.
@@ -461,11 +500,14 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
- "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).
"A String",
],
- "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
+ "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
"A String",
],
},
@@ -536,67 +578,78 @@ Method Details
"promotions": [ # The processed promotions from the specified account.
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
- "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
+ "brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "brandInclusion": [ # Optional. Product filter by brand for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355&sjid=17642868584668136159-NC) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
+ "couponValueType": "A String", # Required. The [coupon value type] (https://support.google.com/merchants/answer/13861986?ref_topic=13773355) attribute to signal the type of promotion that you are running. Depending on type of the selected coupon value [some attributes are required](https://support.google.com/merchants/answer/6393006?ref_topic=7322920).
"customRedemptionRestriction": "A String", # Optional. The custom redemption restriction for the promotion. If the `redemption_restriction` field is set to `CUSTOM`, this field must be set.
- "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289?hl=en&sjid=11099988466404504696-NC) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
- "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
- "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "eventApplicability": "A String", # Optional. Event applicability for this promotion. When present, this field indicates you are creating a [sales event](https://support.google.com/merchants/answer/15523289) and not a product promotion. Exactly one of `product_applicability` or `event_applicability` must be set.
+ "freeGiftDescription": "A String", # Optional. [Free gift description](https://support.google.com/merchants/answer/13847245?ref_topic=13773355) for the promotion.
+ "freeGiftItemId": "A String", # Optional. [Free gift item ID](https://support.google.com/merchants/answer/13857152?ref_topic=13773355) for the promotion.
+ "freeGiftValue": { # The price represented as a number and currency. # Optional. [Free gift value](https://support.google.com/merchants/answer/13844477?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "genericRedemptionCode": "A String", # Optional. Generic redemption code for the promotion. To be used with the `offerType` field and must meet the [minimum requirements](https://support.google.com/merchants/answer/13837405?ref_topic=13773355).
"getThisQuantityDiscounted": "A String", # Optional. The number of items discounted in the promotion. The attribute is set when `couponValueType` is equal to `buy_m_get_n_money_off` or `buy_m_get_n_percent_off`.
- "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014?hl=en).
+ "googleProductCategories": [ # Optional. A list of Google product categories for this promotion. Set if `EventApplicability` is `SPECIFIC_CATEGORIES`. Up to 5 product categories can be specified. For more details on eligible values for product categories, checkout the `google_product_category` attribute in the [Promotion data specification](https://support.google.com/merchants/answer/2906014).
"A String",
],
- "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355&sjid=17642868584668136159-NC). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC). exclusion for the promotion.
+ "itemGroupIdExclusion": [ # Optional. Product filter by [item group ID](https://support.google.com/merchants/answer/13837298?ref_topic=13773355). The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355). exclusion for the promotion.
"A String",
],
- "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemGroupIdInclusion": [ # Optional. Product filter by item group ID for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability [product_applicability] attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdExclusion": [ # Optional. Product filter by [item ID exclusion](https://support.google.com/merchants/answer/13863524?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "itemIdInclusion": [ # Optional. Product filter by [item ID](https://support.google.com/merchants/answer/13861565?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "limitQuantity": "A String", # Optional. [Maximum purchase quantity](https://support.google.com/merchants/answer/13861564?ref_topic=13773355) for the promotion.
"limitValue": { # The price represented as a number and currency. # Optional. [Maximum product price](https://support.google.com/merchants/answer/2906014) for promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "longTitle": "A String", # Required. [Long title](https://support.google.com/merchants/answer/13838102?ref_topic=13773355) for the promotion.
"maxDiscountAmount": { # The price represented as a number and currency. # Optional. The maximum monetary discount a customer can receive for the promotion. This field is only supported with the `Percent off` coupon value type.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion.
+ "maxMoneyOffAmount": { # The price represented as a number and currency. # Optional. Maximum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "maxPercentOff": "A String", # Optional. Maximum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minMoneyOffAmount": { # The price represented as a number and currency. # Optional. Minimum money off amount for a promotion with `MONEY_OFF_RANGE` coupon value type. At least one of `min_money_off_amount` or `max_money_off_amount` must be present when the coupon value type is `MONEY_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
+ "currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
+ },
+ "minPercentOff": "A String", # Optional. Minimum percent off for a promotion with `PERCENT_OFF_RANGE` coupon value type. At least one of `min_percent_off` or `max_percent_off` must be present when the coupon value type is `PERCENT_OFF_RANGE`. If neither is provided an `INVALID_PROMOTION_MISSING_BENEFIT_OR_RESTRICTION` error is returned.
+ "minimumPurchaseAmount": { # The price represented as a number and currency. # Optional. [Minimum purchase amount](https://support.google.com/merchants/answer/13837705?ref_topic=13773355) for the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
"minimumPurchaseQuantity": "A String",
- "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355&sjid=17642868584668136159-NC) offered in the promotion.
+ "moneyOffAmount": { # The price represented as a number and currency. # Optional. The [money off amount](https://support.google.com/merchants/answer/13838101?ref_topic=13773355) offered in the promotion.
"amountMicros": "A String", # The price represented as a number in micros (1 million micros is an equivalent to one's currency standard unit, for example, 1 USD = 1000000 micros).
"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217).
},
- "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355&sjid=17642868584668136159-NC) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
+ "offerType": "A String", # Required. [Type](https://support.google.com/merchants/answer/13837405?ref_topic=13773355) of the promotion. Use this attribute to indicate whether or not customers need a coupon code to redeem your promotion.
"percentOff": "A String", # Optional. The [percentage discount](https://support.google.com/merchants/answer/13837404?sjid=17642868584668136159-NC) offered in the promotion.
- "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257?ref_topic=6396150&sjid=17642868584668136159-NC). Exactly one of `product_applicability` or `event_applicability` must be set.
- "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productApplicability": "A String", # Optional. Applicability of the promotion to either all products or [only specific products](https://support.google.com/merchants/answer/6396257). Exactly one of `product_applicability` or `event_applicability` must be set.
+ "productTypeExclusion": [ # Optional. Product filter by [product type exclusion](https://support.google.com/merchants/answer/13863746?ref_topic=13773355) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "productTypeInclusion": [ # Optional. Product filter by product type for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355).
"A String",
],
- "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465?sjid=5155774230887277618-NC)
+ "promotionDestinations": [ # Required. The list of destinations (also known as [Marketing methods](https://support.google.com/merchants/answer/15130232)) where the promotion applies to. If you don't specify a destination by including a supported value in your data source, your promotion will display in Shopping ads and free listings by default. You may have previously submitted the following values as destinations for your products: Shopping Actions, Surfaces across Google, Local surfaces across Google. To represent these values use `FREE_LISTINGS`, `FREE_LOCAL_LISTINGS`, `LOCAL_INVENTORY_ADS`. For more details see [Promotion destination](https://support.google.com/merchants/answer/13837465)
"A String",
],
"promotionDisplayTimePeriod": { # Represents a time interval, encoded as a Timestamp start (inclusive) and a Timestamp end (exclusive). The start must be less than or equal to the end. When the start equals the end, the interval is empty (matches no time). When both start and end are unspecified, the interval matches any time. # Optional. `TimePeriod` representation of the promotion's display dates. This attribute specifies the date and time frame when the promotion will be live on Google.com and Shopping ads. If the display time period for promotion `promotion_display_time_period` attribute is not specified, the promotion effective time period `promotion_effective_time_period` determines the date and time frame when the promotion will be live on Google.com and Shopping ads.
@@ -609,11 +662,14 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
- "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
+ "storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355).
"A String",
],
- "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
+ "storeCodesInclusion": [ # Optional. [Store codes to include](https://support.google.com/merchants/answer/13857470?ref_topic=13773355) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355). Store code (the store ID from your Business Profile) of the physical store the product is sold in. See the [Local product inventory data specification](https://support.google.com/merchants/answer/3061342) for more information.
"A String",
],
},
diff --git a/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html b/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html
index fe63f5c9e9..92bc115337 100644
--- a/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html
+++ b/docs/dyn/merchantapi_promotions_v1beta.accounts.promotions.html
@@ -111,6 +111,7 @@ Method Details
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
"brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
],
@@ -184,6 +185,9 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
"storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
@@ -251,6 +255,7 @@ Method Details
"dataSource": "A String", # Required. The data source of the [promotion](https://support.google.com/merchants/answer/6396268?sjid=5155774230887277618-NC) Format: `accounts/{account}/dataSources/{datasource}`.
"promotion": { # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved. # Required. The promotion to insert.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
"brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
],
@@ -324,6 +329,9 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
"storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
@@ -388,6 +396,7 @@ Method Details
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
"brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
],
@@ -461,6 +470,9 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
"storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
@@ -536,6 +548,7 @@ Method Details
"promotions": [ # The processed promotions from the specified account.
{ # Represents a promotion. See the following articles for more details. Required promotion input attributes to pass data validation checks are primarily defined below: * [Promotions data specification](https://support.google.com/merchants/answer/2906014) * [Local promotions data specification](https://support.google.com/merchants/answer/10146130) After inserting, updating a promotion input, it may take several minutes before the final promotion can be retrieved.
"attributes": { # Attributes. # Optional. A list of promotion attributes.
+ "audience": "A String", # Optional. This field defines the audience a promotion will be visible to.
"brandExclusion": [ # Optional. Product filter by [brand exclusion](https://support.google.com/merchants/answer/13861679?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The product filter attributes only applies when the products eligible for promotion product applicability `product_applicability` attribute is set to [specific_products](https://support.google.com/merchants/answer/13837299?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
],
@@ -609,6 +622,9 @@ Method Details
},
"promotionUrl": "A String", # Optional. URL to the page on the merchant's site where the promotion shows. Local Inventory ads promotions throw an error if no `promotion_url` is included. URL is used to confirm that the promotion is valid and can be redeemed.
"redemptionRestriction": "A String", # Optional. A restriction customers must meet before they can redeem the promotion.
+ "regionIdInclusion": [ # Optional. A list of [regions](https://support.google.com/merchants/answer/15406457?hl=en&sjid=8815806704218720187-NC#howregionswork) where the promotion is applicable. Must be set if `audience` is set to `LOCATION`.
+ "A String",
+ ],
"storeApplicability": "A String", # Optional. Whether the promotion applies to [all stores, or only specified stores](https://support.google.com/merchants/answer/13857563?sjid=17642868584668136159-NC). Local Inventory ads promotions throw an error if no store applicability is included. An `INVALID_ARGUMENT` error is thrown if `store_applicability` is set to `ALL_STORES` and `store_codes_inclusion` or `score_code_exclusion` is set to a value.
"storeCodesExclusion": [ # Optional. [Store codes to exclude](https://support.google.com/merchants/answer/13859586?ref_topic=13773355&sjid=17642868584668136159-NC) for the promotion. The store filter attributes only applies when the `store_applicability` attribute is set to [specific_stores](https://support.google.com/merchants/answer/13857563?ref_topic=13773355&sjid=17642868584668136159-NC).
"A String",
diff --git a/docs/dyn/merchantapi_reports_v1.accounts.reports.html b/docs/dyn/merchantapi_reports_v1.accounts.reports.html
index 78fa4aa9f4..806d169015 100644
--- a/docs/dyn/merchantapi_reports_v1.accounts.reports.html
+++ b/docs/dyn/merchantapi_reports_v1.accounts.reports.html
@@ -99,9 +99,9 @@ Method Details
The object takes the form of:
{ # Request message for the `ReportService.Search` method.
- "pageSize": 42, # Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
+ "pageSize": 42, # Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000.
"pageToken": "A String", # Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.
- "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the [Available fields](/merchant/api/reference/rest/reports_{api_version}/accounts.reports).
+ "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.
}
x__xgafv: string, V1 error format.
@@ -313,8 +313,8 @@ Method Details
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
},
- "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_view` table.
- "aggregatedReportingContextStatus": "A String", # Aggregated status.
+ "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_view` table.
+ "aggregatedReportingContextStatus": "A String", # Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field.
"availability": "A String", # [Availability](https://support.google.com/merchants/answer/6324448) of the product.
"brand": "A String", # Brand of the product.
"categoryL1": "A String", # Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
@@ -342,8 +342,8 @@ Method Details
{ # Item issue associated with the product.
"resolution": "A String", # Item issue resolution.
"severity": { # How the issue affects the serving of the product. # Item issue severity.
- "aggregatedSeverity": "A String", # Aggregated severity of the issue for all reporting contexts it affects. **This field can be used for filtering the results.**
- "severityPerReportingContext": [ # Issue severity per reporting context.
+ "aggregatedSeverity": "A String", # Aggregated severity of the issue for all reporting contexts it affects. Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the `reporting_context` field. **This field can be used for filtering the results.**
+ "severityPerReportingContext": [ # Issue severity per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field.
{ # Issue severity per reporting context.
"demotedCountries": [ # List of demoted countries in the reporting context, represented in ISO 3166 format.
"A String",
@@ -372,7 +372,22 @@ Method Details
"productTypeL3": "A String", # Product type (3rd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
"productTypeL4": "A String", # Product type (4th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
"productTypeL5": "A String", # Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
+ "reportingContext": "A String", # Reporting context to restrict the query to. Restricts the reporting contexts returned in `status_per_reporting_context` and `item_issues`, and used to compute `aggregated_reporting_context_status`. **This field can only be used in the `WHERE` clause and cannot be selected in the `SELECT` clause.**
"shippingLabel": "A String", # Normalized [shipping label](https://support.google.com/merchants/answer/6324504) specified in the data source.
+ "statusPerReportingContext": [ # Detailed product status per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field. Equivalent to `ProductStatus.destination_statuses` in Products API. **This field cannot be used for sorting or filtering the results.**
+ { # Status of the product for a specific reporting context. Equivalent to `DestinationStatus` in Products API.
+ "approvedCountries": [ # List of approved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "disapprovedCountries": [ # List of disapproved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "pendingCountries": [ # List of pending countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "reportingContext": "A String", # Reporting context the status applies to.
+ },
+ ],
"thumbnailLink": "A String", # Link to the processed image of the product, hosted on the Google infrastructure.
"title": "A String", # Title of the product.
},
diff --git a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html
index 9aebdec6f0..5004426aae 100644
--- a/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html
+++ b/docs/dyn/merchantapi_reports_v1beta.accounts.reports.html
@@ -99,9 +99,9 @@ Method Details
The object takes the form of:
{ # Request message for the `ReportService.Search` method.
- "pageSize": 42, # Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 5000 are coerced to 5000.
+ "pageSize": 42, # Optional. Number of `ReportRows` to retrieve in a single page. Defaults to 1000. Values above 100,000 are coerced to 100,000.
"pageToken": "A String", # Optional. Token of the page to retrieve. If not specified, the first page of results is returned. In order to request the next page of results, the value obtained from `next_page_token` in the previous response should be used.
- "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the [Available fields](/merchant/api/reference/rest/reports_{api_version}/accounts.reports).
+ "query": "A String", # Required. Query that defines a report to be retrieved. For details on how to construct your query, see the [Query Language guide](/merchant/api/guides/reports/query-language). For the full list of available tables and fields, see the Available fields.
}
x__xgafv: string, V1 error format.
@@ -313,8 +313,8 @@ Method Details
"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.
},
},
- "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as in Products sub-API but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_view` table.
- "aggregatedReportingContextStatus": "A String", # Aggregated status.
+ "productView": { # Fields available for query in `product_view` table. Products in the current inventory. Products in this table are the same as a [Product resource in Products sub-API](https://developers.google.com/merchant/api/reference/rest/products_v1/accounts.products) but not all product attributes from Products sub-API are available for query in this table. In contrast to Products sub-API, this table allows to filter the returned list of products by product attributes. To retrieve a single product by `id` or list all products, Products sub-API should be used. Values are only set for fields requested explicitly in the request's search query. # Fields available for query in `product_view` table.
+ "aggregatedReportingContextStatus": "A String", # Aggregated status across all reporting contexts. Reporting contexts included in the computation of the aggregated status can be restricted using a filter on the `reporting_context` field.
"availability": "A String", # [Availability](https://support.google.com/merchants/answer/6324448) of the product.
"brand": "A String", # Brand of the product.
"categoryL1": "A String", # Product category (1st level) in [Google's product taxonomy](https://support.google.com/merchants/answer/6324436).
@@ -342,8 +342,8 @@ Method Details
{ # Item issue associated with the product.
"resolution": "A String", # Item issue resolution.
"severity": { # How the issue affects the serving of the product. # Item issue severity.
- "aggregatedSeverity": "A String", # Aggregated severity of the issue for all reporting contexts it affects. **This field can be used for filtering the results.**
- "severityPerReportingContext": [ # Issue severity per reporting context.
+ "aggregatedSeverity": "A String", # Aggregated severity of the issue for all reporting contexts it affects. Reporting contexts included in the computation of the aggregated severity can be restricted using a filter on the `reporting_context` field. **This field can be used for filtering the results.**
+ "severityPerReportingContext": [ # Issue severity per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field.
{ # Issue severity per reporting context.
"demotedCountries": [ # List of demoted countries in the reporting context, represented in ISO 3166 format.
"A String",
@@ -372,7 +372,22 @@ Method Details
"productTypeL3": "A String", # Product type (3rd level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
"productTypeL4": "A String", # Product type (4th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
"productTypeL5": "A String", # Product type (5th level) in merchant's own [product taxonomy](https://support.google.com/merchants/answer/6324406).
+ "reportingContext": "A String", # Reporting context to restrict the query to. Restricts the reporting contexts returned in `status_per_reporting_context` and `item_issues`, and used to compute `aggregated_reporting_context_status`. **This field can only be used in the `WHERE` clause and cannot be selected in the `SELECT` clause.**
"shippingLabel": "A String", # Normalized [shipping label](https://support.google.com/merchants/answer/6324504) specified in the data source.
+ "statusPerReportingContext": [ # Detailed product status per reporting context. Reporting contexts included in this list can be restricted using a filter on the `reporting_context` field. Equivalent to `ProductStatus.destination_statuses` in Products API. **This field cannot be used for sorting or filtering the results.**
+ { # Status of the product for a specific reporting context. Equivalent to `DestinationStatus` in Products API.
+ "approvedCountries": [ # List of approved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "disapprovedCountries": [ # List of disapproved countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "pendingCountries": [ # List of pending countries in the reporting context, represented in [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format, for example, `US`.
+ "A String",
+ ],
+ "reportingContext": "A String", # Reporting context the status applies to.
+ },
+ ],
"thumbnailLink": "A String", # Link to the processed image of the product, hosted on the Google infrastructure.
"title": "A String", # Title of the product.
},
diff --git a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html
index a3cf760724..f812b86f96 100644
--- a/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html
+++ b/docs/dyn/networkservices_v1.projects.locations.authzExtensions.html
@@ -121,7 +121,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -224,7 +224,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -267,7 +267,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -319,7 +319,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html
index a07f8ab16d..1324189954 100644
--- a/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html
+++ b/docs/dyn/networkservices_v1beta1.projects.locations.authzExtensions.html
@@ -121,7 +121,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -224,7 +224,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -267,7 +267,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
@@ -319,7 +319,7 @@ Method Details
"labels": { # Optional. Set of labels associated with the `AuthzExtension` resource. The format must comply with [the requirements for labels](/compute/docs/labeling-resources#requirements) for Google Cloud resources.
"a_key": "A String",
},
- "loadBalancingScheme": "A String", # Required. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
+ "loadBalancingScheme": "A String", # Optional. All backend services and forwarding rules referenced by this extension must share the same load balancing scheme. Supported values: `INTERNAL_MANAGED`, `EXTERNAL_MANAGED`. Can be omitted for AuthzExtensions that do not reference a backend service. For more information, refer to [Backend services overview](https://cloud.google.com/load-balancing/docs/backend-service).
"metadata": { # Optional. The metadata provided here is included as part of the `metadata_context` (of type `google.protobuf.Struct`) in the `ProcessingRequest` message sent to the extension server. The metadata is available under the namespace `com.google.authz_extension.`. The following variables are supported in the metadata Struct: `{forwarding_rule_id}` - substituted with the forwarding rule's fully qualified resource name.
"a_key": "", # Properties of the object.
},
diff --git a/docs/dyn/observability_v1.folders.locations.html b/docs/dyn/observability_v1.folders.locations.html
index 543929038e..bf6290768a 100644
--- a/docs/dyn/observability_v1.folders.locations.html
+++ b/docs/dyn/observability_v1.folders.locations.html
@@ -85,12 +85,18 @@ Instance Methods
Gets information about a location.
+
+ getSettings(name, x__xgafv=None)
+Get Settings
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
Retrieves the next page of results.
+
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None)
+Update Settings
Method Details
close()
@@ -124,6 +130,28 @@ Method Details
}
+
+ getSettings(name, x__xgafv=None)
+ Get Settings
+
+Args:
+ name: string, Required. Name of the settings to retrieve. Name format: "projects/[PROJECT_ID]/locations/[LOCATION]/settings" "folders/[FOLDER_ID]/locations/[LOCATION]/settings" "organizations/[ORGANIZATION_ID]/locations/[LOCATION]/settings" (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Describes the settings associated with a project, organization, or folder.
+ "defaultStorageLocation": "A String", # Optional. The location which should be used when any regional resources are provisioned by Google Cloud.
+ "kmsKeyName": "A String", # Optional. The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: `"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
+ "name": "A String", # Identifier. The resource name of the settings.
+ "serviceAccountId": "A String", # Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region.
+}
+
+
list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
@@ -174,4 +202,50 @@ Method Details
+
+ updateSettings(name, body=None, updateMask=None, x__xgafv=None)
+ Update Settings
+
+Args:
+ name: string, Identifier. The resource name of the settings. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Describes the settings associated with a project, organization, or folder.
+ "defaultStorageLocation": "A String", # Optional. The location which should be used when any regional resources are provisioned by Google Cloud.
+ "kmsKeyName": "A String", # Optional. The resource name for the configured Cloud KMS key. KMS key name format: "projects/[PROJECT_ID]/locations/[LOCATION]/keyRings/[KEYRING]/cryptoKeys/[KEY]" For example: `"projects/my-project/locations/us-central1/keyRings/my-ring/cryptoKeys/my-key"`
+ "name": "A String", # Identifier. The resource name of the settings.
+ "serviceAccountId": "A String", # Output only. The service account for the given resource container, such as project or folder. This will be used by Cloud Observability to perform actions in the container's project like access KMS keys or create Links. Always the same service account per resource container regardless of region.
+}
+
+ updateMask: string, Optional. The field mask specifying which fields of the settings are to be updated.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # This resource represents a long-running operation that is the result of a network API call.
+ "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
+ "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
+ "code": 42, # The status code, which should be an enum value of google.rpc.Code.
+ "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
+ {
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ ],
+ "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
+ },
+ "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+ "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
+ "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
+ "a_key": "", # Properties of the object. Contains field @type with type URL.
+ },
+}
+
+