+ platforms()
+
Returns the platforms Resource.
+ +
+ close()
Close httplib2 connections.
+ +Create a BatchHttpRequest object based on the discovery document.
+close()
+ Close httplib2 connections.+
new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document. + + Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + + Returns: + A BatchHttpRequest object based on the discovery document. ++
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates an account event.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates an account event.
+
+Args:
+ parent: string, Required. Account to log events about. Format: platforms/{platform}/accounts/{account} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A platform sub-account event to record spam signals.
+ "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+ "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+ "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+ "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+ "city": "A String", # City. Max length 60 bytes or 30 characters.
+ "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+ "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+ "fax": "A String", # Fax number with international code (i.e. +441234567890).
+ "phone": "A String", # Phone number with international code (i.e. +441234567890).
+ "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+ "state": "A String", # State. Max length 60 bytes or 30 characters.
+ "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+ },
+ "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+ },
+ "eventTime": "A String", # Required. Event timestamp.
+ "eventType": "A String", # Required. Event type.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A platform sub-account event to record spam signals.
+ "eventInfo": { # Private information for partner recorded events (PII). # Required. Information associated with the event.
+ "billingAddress": { # Address data. # The billing address of the publisher associated with this event, if available.
+ "address1": "A String", # First line of address. Max length 64 bytes or 30 characters.
+ "address2": "A String", # Second line of address. Max length 64 bytes or 30 characters.
+ "city": "A String", # City. Max length 60 bytes or 30 characters.
+ "company": "A String", # Name of the company. Max length 255 bytes or 34 characters.
+ "contact": "A String", # Contact name of the company. Max length 128 bytes or 34 characters.
+ "fax": "A String", # Fax number with international code (i.e. +441234567890).
+ "phone": "A String", # Phone number with international code (i.e. +441234567890).
+ "regionCode": "A String", # Country/Region code. The region is specified as a CLDR region code (e.g. "US", "FR").
+ "state": "A String", # State. Max length 60 bytes or 30 characters.
+ "zip": "A String", # Zip/post code. Max length 10 bytes or 10 characters.
+ },
+ "email": "A String", # Required. The email address that is associated with the publisher when performing the event.
+ },
+ "eventTime": "A String", # Required. Event timestamp.
+ "eventType": "A String", # Required. Event type.
+}
+
+ events()
+
Returns the events Resource.
+ +
+ sites()
+
Returns the sites Resource.
+ +
+ close(name, body=None, x__xgafv=None)
Closes a sub-account.
+
+ create(parent, body=None, x__xgafv=None)
Creates a sub-account.
+ +Gets information about the selected sub-account.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists a partial view of sub-accounts for a specific parent account.
+ +Retrieves the next page of results.
+
+ lookup(parent, creationRequestId=None, x__xgafv=None)
Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+close(name, body=None, x__xgafv=None)
+ Closes a sub-account.
+
+Args:
+ name: string, Required. Account to close. Format: platforms/{platform}/accounts/{account_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request definition for the account close rpc.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response definition for the account close rpc.
+}
+create(parent, body=None, x__xgafv=None)
+ Creates a sub-account.
+
+Args:
+ parent: string, Required. Platform to create an account for. Format: platforms/{platform} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Representation of an Account.
+ "createTime": "A String", # Output only. Creation time of the account.
+ "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+ "displayName": "A String", # Display name of this account.
+ "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+ "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+ "state": "A String", # Output only. Approval state of the account.
+ "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of an Account.
+ "createTime": "A String", # Output only. Creation time of the account.
+ "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+ "displayName": "A String", # Display name of this account.
+ "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+ "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+ "state": "A String", # Output only. Approval state of the account.
+ "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+}
+get(name, x__xgafv=None)
+ Gets information about the selected sub-account.
+
+Args:
+ name: string, Required. Account to get information about. Format: platforms/{platform}/accounts/{account_id} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of an Account.
+ "createTime": "A String", # Output only. Creation time of the account.
+ "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+ "displayName": "A String", # Display name of this account.
+ "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+ "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+ "state": "A String", # Output only. Approval state of the account.
+ "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists a partial view of sub-accounts for a specific parent account.
+
+Args:
+ parent: string, Required. Platform who parents the accounts. Format: platforms/{platform} (required)
+ pageSize: integer, Optional. The maximum number of accounts to include in the response, used for paging. If unspecified, at most 10000 accounts will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+ pageToken: string, Optional. A page token, received from a previous `ListAccounts` call. Provide this to retrieve the subsequent page.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response definition for the list accounts rpc.
+ "accounts": [ # The Accounts returned in the list response. Represented by a partial view of the Account resource, populating `name` and `creation_request_id`.
+ { # Representation of an Account.
+ "createTime": "A String", # Output only. Creation time of the account.
+ "creationRequestId": "A String", # Required. An opaque token that uniquely identifies the account among all the platform's accounts. This string may contain at most 64 non-whitespace ASCII characters, but otherwise has no predefined structure. However, it is expected to be a platform-specific identifier for the user creating the account, so that only a single account can be created for any given user. This field must not contain any information that is recognizable as personally identifiable information. e.g. it should not be an email address or login name. Once an account has been created, a second attempt to create an account using the same creation_request_id will result in an ALREADY_EXISTS error.
+ "displayName": "A String", # Display name of this account.
+ "name": "A String", # Output only. Resource name of the account. Format: platforms/pub-[0-9]+/accounts/pub-[0-9]+
+ "regionCode": "A String", # Required. Input only. CLDR region code of the country/region of the address. Set this to country code of the child account if known, otherwise to your own country code.
+ "state": "A String", # Output only. Approval state of the account.
+ "timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Required. The IANA TZ timezone code of this account. For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones. This field is used for reporting. It is recommended to set it to the same value for all child accounts.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token used to page through accounts. To retrieve the next page of the results, set the next request's "page_token" value to this.
+}
+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. ++
lookup(parent, creationRequestId=None, x__xgafv=None)
+ Looks up information about a sub-account for a specified creation_request_id. If no account exists for the given creation_request_id, returns 404.
+
+Args:
+ parent: string, Required. Platform who parents the account. Format: platforms/{platform} (required)
+ creationRequestId: string, Optional. The creation_request_id provided when calling createAccount.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response definition for the lookup account rpc.
+ "name": "A String", # The name of the Account Format: platforms/{platform}/accounts/{account_id}
+}
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
Creates a site for a specified account.
+ +Deletes a site from a specified account.
+ +Gets a site from a specified sub-account.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists sites for a specific account.
+ +Retrieves the next page of results.
+
+ requestReview(name, x__xgafv=None)
Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+close()
+ Close httplib2 connections.+
create(parent, body=None, x__xgafv=None)
+ Creates a site for a specified account.
+
+Args:
+ parent: string, Required. Account to create site. Format: platforms/{platform}/accounts/{account_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Representation of a Site.
+ "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+ "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+ "state": "A String", # Output only. State of a site.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of a Site.
+ "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+ "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+ "state": "A String", # Output only. State of a site.
+}
+delete(name, x__xgafv=None)
+ Deletes a site from a specified account.
+
+Args:
+ name: string, Required. The name of the site to delete. Format: platforms/{platform}/accounts/{account}/sites/{site} (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 site from a specified sub-account.
+
+Args:
+ name: string, Required. The name of the site to retrieve. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Representation of a Site.
+ "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+ "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+ "state": "A String", # Output only. State of a site.
+}
+list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists sites for a specific account.
+
+Args:
+ parent: string, Required. The account which owns the sites. Format: platforms/{platform}/accounts/{account} (required)
+ pageSize: integer, The maximum number of sites to include in the response, used for paging. If unspecified, at most 10000 sites will be returned. The maximum value is 10000; values above 10000 will be coerced to 10000.
+ pageToken: string, A page token, received from a previous `ListSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSites` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response definition for the site list rpc.
+ "nextPageToken": "A String", # Continuation token used to page through sites. To retrieve the next page of the results, set the next request's "page_token" value to this.
+ "sites": [ # The sites returned in this list response.
+ { # Representation of a Site.
+ "domain": "A String", # Domain/sub-domain of the site. Must be a valid domain complying with [RFC 1035](https://www.ietf.org/rfc/rfc1035.txt) and formatted as punycode [RFC 3492](https://www.ietf.org/rfc/rfc3492.txt) in case the domain contains unicode characters.
+ "name": "A String", # Output only. Resource name of a site. Format: platforms/{platform}/accounts/{account}/sites/{site}
+ "state": "A String", # Output only. State of a site.
+ },
+ ],
+}
+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. ++
requestReview(name, x__xgafv=None)
+ Requests the review of a site. The site should be in REQUIRES_REVIEW or NEEDS_ATTENTION state. Note: Make sure you place an [ad tag](https://developers.google.com/adsense/platforms/direct/ad-tags) on your site before requesting a review.
+
+Args:
+ name: string, Required. The name of the site to submit for review. Format: platforms/{platform}/accounts/{account}/sites/{site} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Response definition for the site request review rpc.
+}
+
+ accounts()
+
Returns the accounts Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
Updates a DatasetVersion.
Args:
- name: string, Output only. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
body: object, The request body.
The object takes the form of:
@@ -281,7 +281,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
@@ -301,7 +301,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
diff --git a/docs/dyn/aiplatform_v1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1.projects.locations.datasets.html
index 039f667f418..b14cce7c329 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.datasets.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.datasets.html
@@ -163,7 +163,7 @@ Updates a Dataset.
Args:
- name: string, Output only. The resource name of the Dataset. (required)
+ name: string, Output only. Identifier. The resource name of the Dataset. (required)
body: object, The request body.
The object takes the form of:
@@ -510,7 +510,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -553,7 +553,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
index 066cb53dcd4..3b52e278156 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html
@@ -340,7 +340,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -374,6 +374,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1340,7 +1342,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1499,6 +1501,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1703,6 +1707,8 @@ Method Details
"endpoints": [ # List of Endpoints in the requested page.
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2100,6 +2106,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2291,6 +2299,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2907,7 +2917,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
diff --git a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
index a19f08ffba7..4f891b3ba45 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.featureOnlineStores.featureViews.html
@@ -570,6 +570,15 @@ Method Details
},
"entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.
"neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query.
+ "numericFilters": [ # Optional. The list of numeric filters.
+ { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1
+ "name": "A String", # Required. Column name in BigQuery that used as filters.
+ "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points.
+ "valueDouble": 3.14, # double value type.
+ "valueFloat": 3.14, # float value type.
+ "valueInt": "A String", # int value type.
+ },
+ ],
"parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly.
"approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
"leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
index db0bc1330e6..b6d1cb1a1cc 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.hyperparameterTuningJobs.html
@@ -276,6 +276,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -525,6 +526,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -816,6 +818,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1078,6 +1081,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
index 3b6a4c7c463..8c5da88f63b 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.nasJobs.html
@@ -231,6 +231,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -313,6 +314,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -481,6 +483,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -563,6 +566,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -773,6 +777,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -855,6 +860,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1036,6 +1042,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1118,6 +1125,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html
index d189511040c..e7e0fc42d12 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.persistentResources.html
@@ -138,6 +138,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -290,6 +293,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -383,6 +389,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -482,6 +491,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
index d9ee081c389..c249a2af3a6 100644
--- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html
@@ -299,7 +299,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -493,7 +493,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1071,7 +1071,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html
index f3d99435a73..6fa9fc561a1 100644
--- a/docs/dyn/aiplatform_v1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1.publishers.models.html
@@ -78,7 +78,7 @@ Instance Methods
close()
Close httplib2 connections.
- get(name, languageCode=None, view=None, x__xgafv=None)
+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
Method Details
@@ -87,12 +87,13 @@ Method Details
- get(name, languageCode=None, view=None, x__xgafv=None)
+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
Args:
name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
- languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+ isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
+ languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
view: string, Optional. PublisherModel view specifying which fields to read.
Allowed values
PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
diff --git a/docs/dyn/aiplatform_v1beta1.media.html b/docs/dyn/aiplatform_v1beta1.media.html
index 789f4350106..6eeaeafdb35 100644
--- a/docs/dyn/aiplatform_v1beta1.media.html
+++ b/docs/dyn/aiplatform_v1beta1.media.html
@@ -115,9 +115,42 @@ Method Details
},
],
},
+ "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
+ "jiraQueries": [ # Required. The Jira queries.
+ { # JiraQueries contains the Jira queries and corresponding authentication.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+ "A String",
+ ],
+ "email": "A String", # Required. The Jira email address.
+ "projects": [ # A list of Jira projects to import in their entirety.
+ "A String",
+ ],
+ "serverUri": "A String", # Required. The Jira server URI.
+ },
+ ],
+ },
"name": "A String", # Output only. The resource name of the RagFile.
"ragFileType": "A String", # Output only. The type of the RagFile.
"sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
+ "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
+ "channels": [ # Required. The Slack channels.
+ { # SlackChannels contains the Slack channels and corresponding access token.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "channels": [ # Required. The Slack channel IDs.
+ { # SlackChannel contains the Slack channel ID and the time range to import.
+ "channelId": "A String", # Required. The Slack channel ID.
+ "endTime": "A String", # Optional. The ending timestamp for messages to import.
+ "startTime": "A String", # Optional. The starting timestamp for messages to import.
+ },
+ ],
+ },
+ ],
+ },
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
},
"uploadRagFileConfig": { # Config for uploading RagFile. # Required. The config for the RagFiles to be uploaded into the RagCorpus. VertexRagDataService.UploadRagFile.
@@ -167,9 +200,42 @@ Method Details
},
],
},
+ "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
+ "jiraQueries": [ # Required. The Jira queries.
+ { # JiraQueries contains the Jira queries and corresponding authentication.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+ "A String",
+ ],
+ "email": "A String", # Required. The Jira email address.
+ "projects": [ # A list of Jira projects to import in their entirety.
+ "A String",
+ ],
+ "serverUri": "A String", # Required. The Jira server URI.
+ },
+ ],
+ },
"name": "A String", # Output only. The resource name of the RagFile.
"ragFileType": "A String", # Output only. The type of the RagFile.
"sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
+ "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
+ "channels": [ # Required. The Slack channels.
+ { # SlackChannels contains the Slack channels and corresponding access token.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "channels": [ # Required. The Slack channel IDs.
+ { # SlackChannel contains the Slack channel ID and the time range to import.
+ "channelId": "A String", # Required. The Slack channel ID.
+ "endTime": "A String", # Optional. The ending timestamp for messages to import.
+ "startTime": "A String", # Optional. The starting timestamp for messages to import.
+ },
+ ],
+ },
+ ],
+ },
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
},
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
index fc9ede35864..587346eeccb 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html
@@ -257,7 +257,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -438,7 +438,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -644,7 +644,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -836,7 +836,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1036,7 +1036,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1218,7 +1218,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html
index 2c923abb916..1bae8f70b91 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.customJobs.html
@@ -175,6 +175,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -289,6 +290,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -445,6 +447,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -572,6 +575,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
index 254b37f6acf..a2257cdcb87 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.datasetVersions.html
@@ -120,7 +120,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
@@ -210,7 +210,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
@@ -243,7 +243,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
},
],
@@ -270,7 +270,7 @@ Method Details
Updates a DatasetVersion.
Args:
- name: string, Output only. The resource name of the DatasetVersion. (required)
+ name: string, Output only. Identifier. The resource name of the DatasetVersion. (required)
body: object, The request body.
The object takes the form of:
@@ -281,7 +281,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
@@ -301,7 +301,7 @@ Method Details
"etag": "A String", # Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
"metadata": "", # Required. Output only. Additional information about the DatasetVersion.
"modelReference": "A String", # Output only. Reference to the public base model last used by the dataset version. Only set for prompt dataset versions.
- "name": "A String", # Output only. The resource name of the DatasetVersion.
+ "name": "A String", # Output only. Identifier. The resource name of the DatasetVersion.
"updateTime": "A String", # Output only. Timestamp when this DatasetVersion was last updated.
}
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
index 9f4aba83646..d4c893e3801 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html
@@ -163,7 +163,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -328,7 +328,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -441,7 +441,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -482,7 +482,7 @@ Method Details
Updates a Dataset.
Args:
- name: string, Output only. The resource name of the Dataset. (required)
+ name: string, Output only. Identifier. The resource name of the Dataset. (required)
body: object, The request body.
The object takes the form of:
@@ -502,7 +502,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
@@ -545,7 +545,7 @@ Method Details
"metadataArtifact": "A String", # Output only. The resource name of the Artifact that was created in MetadataStore when creating the Dataset. The Artifact resource name pattern is `projects/{project}/locations/{location}/metadataStores/{metadata_store}/artifacts/{artifact}`.
"metadataSchemaUri": "A String", # Required. Points to a YAML file stored on Google Cloud Storage describing additional information about the Dataset. The schema is defined as an OpenAPI 3.0.2 Schema Object. The schema files that can be used here are found in gs://google-cloud-aiplatform/schema/dataset/metadata/.
"modelReference": "A String", # Optional. Reference to the public base model last used by the dataset. Only set for prompt datasets.
- "name": "A String", # Output only. The resource name of the Dataset.
+ "name": "A String", # Output only. Identifier. The resource name of the Dataset.
"savedQueries": [ # All SavedQueries belong to the Dataset will be returned in List/Get Dataset response. The annotation_specs field will not be populated except for UI cases which will only use annotation_spec_count. In CreateDataset request, a SavedQuery is created together if this field is set, up to one SavedQuery can be set in CreateDatasetRequest. The SavedQuery should not contain any AnnotationSpec.
{ # A SavedQuery is a view of the dataset. It references a subset of annotations by problem type and filters.
"annotationFilter": "A String", # Output only. Filters on the Annotations in the dataset.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
index 9b5142c348c..9264e906835 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html
@@ -382,7 +382,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -431,6 +431,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1564,7 +1566,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1741,6 +1743,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -1984,6 +1988,8 @@ Method Details
"endpoints": [ # List of Endpoints in the requested page.
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2391,6 +2397,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -2587,6 +2595,8 @@ Method Details
{ # Models are deployed into it, and afterwards Endpoint is called to obtain predictions and explanations.
"createTime": "A String", # Output only. Timestamp when this Endpoint was created.
+ "dedicatedEndpointDns": "A String", # Output only. DNS of the dedicated endpoint. Will only be populated if dedicated_endpoint_enabled is true. Format: `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+ "dedicatedEndpointEnabled": True or False, # If true, the endpoint will be exposed through a dedicated DNS [Endpoint.dedicated_endpoint_dns]. Your request to the dedicated DNS will be isolated from other users' traffic and will have better performance and reliability. Note: Once you enabled dedicated endpoint, you won't be able to send request to the shared DNS {region}-aiplatform.googleapis.com. The limitation will be removed soon.
"deployedModels": [ # Output only. The models deployed in this Endpoint. To add or remove DeployedModels use EndpointService.DeployModel and EndpointService.UndeployModel respectively.
{ # A deployment of a Model. Endpoints contain one or more DeployedModels.
"automaticResources": { # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration. Each Model supporting these resources documents its specific guidelines. # A description of resources that to large degree are decided by Vertex AI, and require only a modest additional configuration.
@@ -3295,7 +3305,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html
index 6bdbea60ea3..f65bfb6047b 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.featureOnlineStores.featureViews.html
@@ -683,6 +683,15 @@ Method Details
},
"entityId": "A String", # Optional. The entity id whose similar entities should be searched for. If embedding is set, search will use embedding instead of entity_id.
"neighborCount": 42, # Optional. The number of similar entities to be retrieved from feature view for each query.
+ "numericFilters": [ # Optional. The list of numeric filters.
+ { # Numeric filter is used to search a subset of the entities by using boolean rules on numeric columns. For example: Database Point 0: {name: “a” value_int: 42} {name: “b” value_float: 1.0} Database Point 1: {name: “a” value_int: 10} {name: “b” value_float: 2.0} Database Point 2: {name: “a” value_int: -1} {name: “b” value_float: 3.0} Query: {name: “a” value_int: 12 operator: LESS} // Matches Point 1, 2 {name: “b” value_float: 2.0 operator: EQUAL} // Matches Point 1
+ "name": "A String", # Required. Column name in BigQuery that used as filters.
+ "op": "A String", # Optional. This MUST be specified for queries and must NOT be specified for database points.
+ "valueDouble": 3.14, # double value type.
+ "valueFloat": 3.14, # float value type.
+ "valueInt": "A String", # int value type.
+ },
+ ],
"parameters": { # Parameters that can be overrided in each query to tune query latency and recall. # Optional. Parameters that can be set to tune query on the fly.
"approximateNeighborCandidates": 42, # Optional. The number of neighbors to find via approximate search before exact reordering is performed; if set, this value must be > neighbor_count.
"leafNodesSearchFraction": 3.14, # Optional. The fraction of the number of leaves to search, set at query time allows user to tune search performance. This value increase result in both search accuracy and latency increase. The value should be between 0.0 and 1.0.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
index 2d9ce0d3080..d1c0026b8bd 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.hyperparameterTuningJobs.html
@@ -289,6 +289,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -551,6 +552,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -855,6 +857,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1130,6 +1133,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
index c8be57a2d1b..464be714079 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.modelMonitors.html
@@ -296,6 +296,8 @@ Method Details
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
@@ -634,6 +636,8 @@ Method Details
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
@@ -913,6 +917,8 @@ Method Details
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
@@ -1198,6 +1204,8 @@ Method Details
"outputUriPrefix": "A String", # Required. Google Cloud Storage URI to output directory. If the uri doesn't end with '/', a '/' will be automatically appended. The directory is created if it doesn't exist.
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"tabularObjective": { # Tabular monitoring objective. # Optional default tabular model monitoring objective.
"featureAttributionSpec": { # Feature attribution monitoring spec. # Feature attribution monitoring spec.
"batchExplanationDedicatedResources": { # A description of resources that are used for performing batch operations, are dedicated to a Model, and need manual configuration. # The config of resources used by the Model Monitoring during the batch explanation for non-AutoML models. If not set, `n1-standard-2` machine type will be used by default.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html
index f39f32c153c..45ec1d19b02 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.nasJobs.html
@@ -231,6 +231,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -313,6 +314,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -481,6 +483,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -563,6 +566,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -773,6 +777,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -855,6 +860,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1036,6 +1042,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
@@ -1118,6 +1125,7 @@ Method Details
"scheduling": { # All parameters related to queuing and scheduling of custom jobs. # Scheduling options for a CustomJob.
"disableRetries": True or False, # Optional. Indicates if the job should retry for internal errors after the job starts running. If true, overrides `Scheduling.restart_job_on_worker_restart` to false.
"restartJobOnWorkerRestart": True or False, # Restarts the entire CustomJob if a worker gets restarted. This feature can be used by distributed training jobs that are not resilient to workers leaving and joining a job.
+ "strategy": "A String", # Optional. This determines which type of scheduling strategy to use.
"timeout": "A String", # The maximum job running time. The default is 7 days.
},
"serviceAccount": "A String", # Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the [Vertex AI Custom Code Service Agent](https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) for the CustomJob's project is used.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html
index d00fd6e9c86..576dbd4d5e0 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.persistentResources.html
@@ -138,6 +138,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -291,6 +294,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -385,6 +391,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
@@ -485,6 +494,9 @@ Method Details
},
"name": "A String", # Immutable. Resource name of a PersistentResource.
"network": "A String", # Optional. The full name of the Compute Engine [network](/compute/docs/networks-and-firewalls#networks) to peered with Vertex AI to host the persistent resources. For example, `projects/12345/global/networks/myVPC`. [Format](/compute/docs/reference/rest/v1/networks/insert) is of the form `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in `12345`, and {network} is a network name. To specify this field, you must have already [configured VPC Network Peering for Vertex AI](https://cloud.google.com/vertex-ai/docs/general/vpc-peering). If this field is left unspecified, the resources aren't peered with any network.
+ "pscInterfaceConfig": { # Configuration for PSC-I. # Optional. Configuration for PSC-I for PersistentResource.
+ "networkAttachment": "A String", # Optional. The full name of the Compute Engine [network attachment](https://cloud.google.com/vpc/docs/about-network-attachments) to attach to the resource. For example, `projects/12345/regions/us-central1/networkAttachments/myNA`. is of the form `projects/{project}/regions/{region}/networkAttachments/{networkAttachment}`. Where {project} is a project number, as in `12345`, and {networkAttachment} is a network attachment name. To specify this field, you must have already [created a network attachment] (https://cloud.google.com/vpc/docs/create-manage-network-attachments#create-network-attachments). This field is only used for resources using PSC-I.
+ },
"reservedIpRanges": [ # Optional. A list of names for the reserved IP ranges under the VPC network that can be used for this persistent resource. If set, we will deploy the persistent resource within the provided IP ranges. Otherwise, the persistent resource is deployed to any IP ranges under the provided VPC network. Example: ['vertex-ai-ip-range'].
"A String",
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
index 44dc124addf..c16eeb2c6c1 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.pipelineJobs.html
@@ -438,6 +438,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -663,6 +665,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -929,6 +933,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -1168,6 +1174,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
index c8a82f10756..0d4ece94d7a 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html
@@ -330,7 +330,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -568,7 +568,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
@@ -1228,7 +1228,7 @@ Method Details
"googleSearchRetrieval": { # Tool to retrieve public web data for grounding, powered by Google. # Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
},
"retrieval": { # Defines a retrieval tool that model can call to access external knowledge. # Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.
- "disableAttribution": True or False, # Optional. Disable using the result from this tool in detecting grounding attribution. This does not affect how the result is given to the model for generation.
+ "disableAttribution": True or False, # Optional. Deprecated. This option is no longer supported.
"vertexAiSearch": { # Retrieve from Vertex AI Search datastore for grounding. See https://cloud.google.com/vertex-ai-search-and-conversation # Set to use data source powered by Vertex AI Search.
"datastore": "A String", # Required. Fully-qualified Vertex AI Search's datastore resource ID. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}`
},
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html
index 62ebe65c71b..fe542508d91 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.ragCorpora.ragFiles.html
@@ -171,9 +171,42 @@ Method Details
},
],
},
+ "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
+ "jiraQueries": [ # Required. The Jira queries.
+ { # JiraQueries contains the Jira queries and corresponding authentication.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+ "A String",
+ ],
+ "email": "A String", # Required. The Jira email address.
+ "projects": [ # A list of Jira projects to import in their entirety.
+ "A String",
+ ],
+ "serverUri": "A String", # Required. The Jira server URI.
+ },
+ ],
+ },
"name": "A String", # Output only. The resource name of the RagFile.
"ragFileType": "A String", # Output only. The type of the RagFile.
"sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
+ "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
+ "channels": [ # Required. The Slack channels.
+ { # SlackChannels contains the Slack channels and corresponding access token.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "channels": [ # Required. The Slack channel IDs.
+ { # SlackChannel contains the Slack channel ID and the time range to import.
+ "channelId": "A String", # Required. The Slack channel ID.
+ "endTime": "A String", # Optional. The ending timestamp for messages to import.
+ "startTime": "A String", # Optional. The starting timestamp for messages to import.
+ },
+ ],
+ },
+ ],
+ },
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
}
@@ -202,11 +235,44 @@ Method Details
},
],
},
+ "jiraSource": { # The Jira source for the ImportRagFilesRequest. # Jira queries with their corresponding authentication.
+ "jiraQueries": [ # Required. The Jira queries.
+ { # JiraQueries contains the Jira queries and corresponding authentication.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+ "A String",
+ ],
+ "email": "A String", # Required. The Jira email address.
+ "projects": [ # A list of Jira projects to import in their entirety.
+ "A String",
+ ],
+ "serverUri": "A String", # Required. The Jira server URI.
+ },
+ ],
+ },
"maxEmbeddingRequestsPerMin": 42, # Optional. The max number of queries per minute that this job is allowed to make to the embedding model specified on the corpus. This value is specific to this job and not shared across other import jobs. Consult the Quotas page on the project to set an appropriate value here. If unspecified, a default value of 1,000 QPM would be used.
"ragFileChunkingConfig": { # Specifies the size and overlap of chunks for RagFiles. # Specifies the size and overlap of chunks after importing RagFiles.
"chunkOverlap": 42, # The overlap between chunks.
"chunkSize": 42, # The size of the chunks.
},
+ "slackSource": { # The Slack source for the ImportRagFilesRequest. # Slack channels with their corresponding access tokens.
+ "channels": [ # Required. The Slack channels.
+ { # SlackChannels contains the Slack channels and corresponding access token.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "channels": [ # Required. The Slack channel IDs.
+ { # SlackChannel contains the Slack channel ID and the time range to import.
+ "channelId": "A String", # Required. The Slack channel ID.
+ "endTime": "A String", # Optional. The ending timestamp for messages to import.
+ "startTime": "A String", # Optional. The starting timestamp for messages to import.
+ },
+ ],
+ },
+ ],
+ },
},
}
@@ -277,9 +343,42 @@ Method Details
},
],
},
+ "jiraSource": { # The Jira source for the ImportRagFilesRequest. # The RagFile is imported from a Jira query.
+ "jiraQueries": [ # Required. The Jira queries.
+ { # JiraQueries contains the Jira queries and corresponding authentication.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Jira API key (https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "customQueries": [ # A list of custom Jira queries to import. For information about JQL (Jira Query Language), see https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+ "A String",
+ ],
+ "email": "A String", # Required. The Jira email address.
+ "projects": [ # A list of Jira projects to import in their entirety.
+ "A String",
+ ],
+ "serverUri": "A String", # Required. The Jira server URI.
+ },
+ ],
+ },
"name": "A String", # Output only. The resource name of the RagFile.
"ragFileType": "A String", # Output only. The type of the RagFile.
"sizeBytes": "A String", # Output only. The size of the RagFile in bytes.
+ "slackSource": { # The Slack source for the ImportRagFilesRequest. # The RagFile is imported from a Slack channel.
+ "channels": [ # Required. The Slack channels.
+ { # SlackChannels contains the Slack channels and corresponding access token.
+ "apiKeyConfig": { # The API secret. # Required. The SecretManager secret version resource name (e.g. projects/{project}/secrets/{secret}/versions/{version}) storing the Slack channel access token that has access to the slack channel IDs. See: https://api.slack.com/tutorials/tracks/getting-a-token.
+ "apiKeySecretVersion": "A String", # Required. The SecretManager secret version resource name storing API key. e.g. projects/{project}/secrets/{secret}/versions/{version}
+ },
+ "channels": [ # Required. The Slack channel IDs.
+ { # SlackChannel contains the Slack channel ID and the time range to import.
+ "channelId": "A String", # Required. The Slack channel ID.
+ "endTime": "A String", # Optional. The ending timestamp for messages to import.
+ "startTime": "A String", # Optional. The starting timestamp for messages to import.
+ },
+ ],
+ },
+ ],
+ },
"updateTime": "A String", # Output only. Timestamp when this RagFile was last updated.
},
],
diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
index 3b47bbc3a91..1b7bdb0ff45 100644
--- a/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
+++ b/docs/dyn/aiplatform_v1beta1.projects.locations.schedules.html
@@ -680,6 +680,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -1279,6 +1281,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -1920,6 +1924,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -2533,6 +2539,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -3150,6 +3158,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
@@ -3750,6 +3760,8 @@ Method Details
},
},
},
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
+ "satisfiesPzs": True or False, # Output only. Reserved for future use.
"scheduleName": "A String", # Output only. The schedule resource name. Only returned if the Pipeline is created by Schedule API.
"serviceAccount": "A String", # The service account that the pipeline workload runs as. If not specified, the Compute Engine default service account in the project will be used. See https://cloud.google.com/compute/docs/access/service-accounts#default_service_account Users starting the pipeline must have the `iam.serviceAccounts.actAs` permission on this service account.
"startTime": "A String", # Output only. Pipeline start time.
diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html
index f4b7e8076e0..06a848f6991 100644
--- a/docs/dyn/aiplatform_v1beta1.publishers.models.html
+++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html
@@ -78,7 +78,7 @@ Instance Methods
close()
Close httplib2 connections.
- get(name, languageCode=None, view=None, x__xgafv=None)
+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
@@ -93,12 +93,13 @@ Method Details
- get(name, languageCode=None, view=None, x__xgafv=None)
+ get(name, isHuggingFaceModel=None, languageCode=None, view=None, x__xgafv=None)
Gets a Model Garden publisher model.
Args:
name: string, Required. The name of the PublisherModel resource. Format: `publishers/{publisher}/models/{publisher_model}` (required)
- languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in (see go/bcp47).
+ isHuggingFaceModel: boolean, Optional. Boolean indicates whether the requested model is a Hugging Face model.
+ languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher model's text information should be written in.
view: string, Optional. PublisherModel view specifying which fields to read.
Allowed values
PUBLISHER_MODEL_VIEW_UNSPECIFIED - The default / unset value. The API will default to the BASIC view.
@@ -394,7 +395,7 @@ Method Details
Args:
parent: string, Required. The name of the Publisher from which to list the PublisherModels. Format: `publishers/{publisher}` (required)
filter: string, Optional. The standard list filter.
- languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in (see go/bcp47). If not set, by default English (en).
+ languageCode: string, Optional. The IETF BCP-47 language code representing the language in which the publisher models' text information should be written in. If not set, by default English (en).
orderBy: string, Optional. A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending.
pageSize: integer, Optional. The standard list page size.
pageToken: string, Optional. The standard list page token. Typically obtained via ListPublisherModelsResponse.next_page_token of the previous ModelGardenService.ListPublisherModels call.
diff --git a/docs/dyn/analyticsadmin_v1alpha.accounts.html b/docs/dyn/analyticsadmin_v1alpha.accounts.html
index e8b0bc7d2b8..15cb1feda2f 100644
--- a/docs/dyn/analyticsadmin_v1alpha.accounts.html
+++ b/docs/dyn/analyticsadmin_v1alpha.accounts.html
@@ -166,7 +166,7 @@ Method Details
Get data sharing settings on an account. Data sharing settings are singletons.
Args:
- name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+ name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -502,7 +502,7 @@ Method Details
Searches through all changes to an account or its children given the specified set of filters.
Args:
- account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+ account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
body: object, The request body.
The object takes the form of:
@@ -517,7 +517,7 @@ Method Details
"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
"pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
"pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.
- "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100"
+ "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`
"resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
"A String",
],
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html
index 94c5e06a8c9..2fe1b64766b 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.conversionEvents.html
@@ -79,22 +79,22 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
-Creates a conversion event with the specified attributes.
+Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
-Deletes a conversion event in a property.
+Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
-Retrieve a single conversion event.
+Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
-Updates a conversion event with the specified attributes.
+Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
Method Details
close()
@@ -103,7 +103,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Creates a conversion event with the specified attributes.
+ Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
Args:
parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ Method Details
delete(name, x__xgafv=None)
- Deletes a conversion event in a property.
+ Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
Args:
name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ Method Details
get(name, x__xgafv=None)
- Retrieve a single conversion event.
+ Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
Args:
name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+ Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Args:
parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
- Updates a conversion event with the specified attributes.
+ Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
Args:
name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
index 3beb3dcec17..397abbaef32 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.dataStreams.html
@@ -303,7 +303,7 @@ Method Details
Returns the Site Tag for the specified web stream. Site Tags are immutable singletons.
Args:
- name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: "properties/123/dataStreams/456/globalSiteTag" (required)
+ name: string, Required. The name of the site tag to lookup. Note that site tags are singletons and do not have unique IDs. Format: properties/{property_id}/dataStreams/{stream_id}/globalSiteTag Example: `properties/123/dataStreams/456/globalSiteTag` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
diff --git a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
index ceb2fd7c37c..5df2bec7b91 100644
--- a/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
+++ b/docs/dyn/analyticsadmin_v1alpha.properties.firebaseLinks.html
@@ -100,7 +100,7 @@ Method Details
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
Args:
- parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+ parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
body: object, The request body.
The object takes the form of:
@@ -130,7 +130,7 @@ Method Details
Deletes a FirebaseLink on a property
Args:
- name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+ name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -148,7 +148,7 @@ Method Details
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Args:
- parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+ parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/analyticsadmin_v1beta.accounts.html b/docs/dyn/analyticsadmin_v1beta.accounts.html
index fe5ed33c84b..fce75e43add 100644
--- a/docs/dyn/analyticsadmin_v1beta.accounts.html
+++ b/docs/dyn/analyticsadmin_v1beta.accounts.html
@@ -161,7 +161,7 @@ Method Details
Get data sharing settings on an account. Data sharing settings are singletons.
Args:
- name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: "accounts/1000/dataSharingSettings" (required)
+ name: string, Required. The name of the settings to lookup. Format: accounts/{account}/dataSharingSettings Example: `accounts/1000/dataSharingSettings` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -497,7 +497,7 @@ Method Details
Searches through all changes to an account or its children given the specified set of filters.
Args:
- account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: "accounts/100" (required)
+ account: string, Required. The account resource for which to return change history resources. Format: accounts/{account} Example: `accounts/100` (required)
body: object, The request body.
The object takes the form of:
@@ -512,7 +512,7 @@ Method Details
"latestChangeTime": "A String", # Optional. If set, only return changes made before this time (inclusive).
"pageSize": 42, # Optional. The maximum number of ChangeHistoryEvent items to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 items will be returned. The maximum value is 200 (higher values will be coerced to the maximum).
"pageToken": "A String", # Optional. A page token, received from a previous `SearchChangeHistoryEvents` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchChangeHistoryEvents` must match the call that provided the page token.
- "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: "properties/100"
+ "property": "A String", # Optional. Resource name for a child property. If set, only return changes made to this property or its child resources. Format: properties/{propertyId} Example: `properties/100`
"resourceType": [ # Optional. If set, only return changes if they are for a resource that matches at least one of these types.
"A String",
],
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html
index cf252513141..042317e3ef5 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.conversionEvents.html
@@ -79,22 +79,22 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
-Creates a conversion event with the specified attributes.
+Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
-Deletes a conversion event in a property.
+Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
-Retrieve a single conversion event.
+Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Retrieves the next page of results.
patch(name, body=None, updateMask=None, x__xgafv=None)
-Updates a conversion event with the specified attributes.
+Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
Method Details
close()
@@ -103,7 +103,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Creates a conversion event with the specified attributes.
+ Deprecated: Use `CreateKeyEvent` instead. Creates a conversion event with the specified attributes.
Args:
parent: string, Required. The resource name of the parent property where this conversion event will be created. Format: properties/123 (required)
@@ -147,7 +147,7 @@ Method Details
delete(name, x__xgafv=None)
- Deletes a conversion event in a property.
+ Deprecated: Use `DeleteKeyEvent` instead. Deletes a conversion event in a property.
Args:
name: string, Required. The resource name of the conversion event to delete. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -165,7 +165,7 @@ Method Details
get(name, x__xgafv=None)
- Retrieve a single conversion event.
+ Deprecated: Use `GetKeyEvent` instead. Retrieve a single conversion event.
Args:
name: string, Required. The resource name of the conversion event to retrieve. Format: properties/{property}/conversionEvents/{conversion_event} Example: "properties/123/conversionEvents/456" (required)
@@ -193,7 +193,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
+ Deprecated: Use `ListKeyEvents` instead. Returns a list of conversion events in the specified parent property. Returns an empty list if no conversion events are found.
Args:
parent: string, Required. The resource name of the parent property. Example: 'properties/123' (required)
@@ -242,7 +242,7 @@ Method Details
patch(name, body=None, updateMask=None, x__xgafv=None)
- Updates a conversion event with the specified attributes.
+ Deprecated: Use `UpdateKeyEvent` instead. Updates a conversion event with the specified attributes.
Args:
name: string, Output only. Resource name of this conversion event. Format: properties/{property}/conversionEvents/{conversion_event} (required)
diff --git a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html
index 939d87d0477..77cae83ee4a 100644
--- a/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html
+++ b/docs/dyn/analyticsadmin_v1beta.properties.firebaseLinks.html
@@ -100,7 +100,7 @@ Method Details
Creates a FirebaseLink. Properties can have at most one FirebaseLink.
Args:
- parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+ parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
body: object, The request body.
The object takes the form of:
@@ -130,7 +130,7 @@ Method Details
Deletes a FirebaseLink on a property
Args:
- name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: properties/1234/firebaseLinks/5678 (required)
+ name: string, Required. Format: properties/{property_id}/firebaseLinks/{firebase_link_id} Example: `properties/1234/firebaseLinks/5678` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
@@ -148,7 +148,7 @@ Method Details
Lists FirebaseLinks on a property. Properties can have at most one FirebaseLink.
Args:
- parent: string, Required. Format: properties/{property_id} Example: properties/1234 (required)
+ parent: string, Required. Format: properties/{property_id} Example: `properties/1234` (required)
pageSize: integer, The maximum number of resources to return. The service may return fewer than this value, even if there are additional pages. If unspecified, at most 50 resources will be returned. The maximum value is 200; (higher values will be coerced to the maximum)
pageToken: string, A page token, received from a previous `ListFirebaseLinks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListFirebaseLinks` must match the call that provided the page token.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
index b8872a9b411..24b8bd34281 100644
--- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
+++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.html
@@ -114,7 +114,7 @@ Instance Methods
Sets the IAM policy.
subscribe(name, body=None, x__xgafv=None)
-Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
+Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
testIamPermissions(resource, body=None, x__xgafv=None)
Returns the permissions that a caller has.
@@ -552,7 +552,7 @@ Method Details
subscribe(name, body=None, x__xgafv=None)
- Creates a Subscription to a Data Exchange. This is a long-running operation as it will create one or more linked datasets.
+ Creates a Subscription to a Data Clean Room. This is a long-running operation as it will create one or more linked datasets.
Args:
name: string, Required. Resource name of the Data Exchange. e.g. `projects/publisherproject/locations/US/dataExchanges/123` (required)
diff --git a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
index 11d52e788a4..9fb2dd67e3e 100644
--- a/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
+++ b/docs/dyn/androidmanagement_v1.enterprises.enrollmentTokens.html
@@ -79,7 +79,7 @@ Instance Methods
Close httplib2 connections.
create(parent, body=None, x__xgafv=None)
-Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.
+Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.
Deletes an enrollment token. This operation invalidates the token, preventing its future use.
@@ -100,7 +100,7 @@ Method Details
create(parent, body=None, x__xgafv=None)
- Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore. Once an enrollment token has been created, it's not possible to retrieve the token's content anymore using AM API. It is recommended for EMMs to securely store the token if it's intended to be reused.
+ Creates an enrollment token for a given enterprise. It's up to the caller's responsibility to manage the lifecycle of newly created tokens and deleting them when they're not intended to be used anymore.
Args:
parent: string, The name of the enterprise in the form enterprises/{enterpriseId}. (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.html b/docs/dyn/apim_v1alpha.projects.locations.html
index 804b5f88be2..7c0dbb7de19 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.html
@@ -98,6 +98,12 @@ Instance Methods
list(name, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists information about the supported locations for this service.
+
+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ListApiObservationTags lists all extant tags on any observation in the given project.
+
+ listApiObservationTags_next()
+Retrieves the next page of results.
Retrieves the next page of results.
@@ -169,6 +175,44 @@ Method Details
}
+
+ listApiObservationTags(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ ListApiObservationTags lists all extant tags on any observation in the given project.
+
+Args:
+ parent: string, Required. The parent, which owns this collection of tags. Format: projects/{project}/locations/{location} (required)
+ pageSize: integer, Optional. The maximum number of tags to return. The service may return fewer than this value. If unspecified, at most 10 tags will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
+ pageToken: string, Optional. A page token, received from a previous `ListApiObservationTags` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListApiObservationTags` must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to listing tags
+ "apiObservationTags": [ # The tags from the specified project
+ "A String",
+ ],
+ "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
+}
+
+
+
+ listApiObservationTags_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/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
index 358500ee4a6..e4eec036770 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.apiOperations.html
@@ -82,7 +82,7 @@ Instance Methods
GetApiOperation retrieves a single ApiOperation by name.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
+ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
Retrieves the next page of results.
@@ -154,7 +154,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation
+ ListApiOperations gets all ApiOperations for a given project and location and ObservationJob and ApiObservation.
Args:
parent: string, Required. The parent, which owns this collection of ApiOperations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job}/apiObservations/{api_observation} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
index 95b3e84f734..3712e36d21a 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.apiObservations.html
@@ -79,6 +79,9 @@ Instance Methods
Returns the apiOperations Resource.
+
+ batchEditTags(parent, body=None, x__xgafv=None)
+BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
Close httplib2 connections.
@@ -87,11 +90,66 @@ Instance Methods
GetApiObservation retrieves a single ApiObservation by name.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
+ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
Retrieves the next page of results.
Method Details
+
+ batchEditTags(parent, body=None, x__xgafv=None)
+ BatchEditTagsApiObservations adds or removes Tags for ApiObservations.
+
+Args:
+ parent: string, Required. The parent resource shared by all ApiObservations being edited. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Message for requesting batch edit tags for ApiObservations
+ "requests": [ # Required. The request message specifying the resources to update. A maximum of 1000 apiObservations can be modified in a batch.
+ { # Message for requesting edit tags for ApiObservation
+ "apiObservationId": "A String", # Required. Identifier of ApiObservation need to be edit tags Format example: "apigee.googleapis.com|us-west1|443"
+ "tagActions": [ # Required. Tag actions to be applied
+ { # Message for edit tag action
+ "action": "A String", # Required. Action to be applied
+ "tag": "A String", # Required. Tag to be added or removed
+ },
+ ],
+ },
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Message for response to edit Tags for ApiObservations
+ "apiObservations": [ # ApiObservations that were changed
+ { # Message describing ApiObservation object
+ "apiOperationCount": "A String", # The number of observed API Operations.
+ "createTime": "A String", # Create time stamp
+ "hostname": "A String", # The hostname of requests processed for this Observation.
+ "lastEventDetectedTime": "A String", # Last event detected time stamp
+ "name": "A String", # Identifier. Name of resource
+ "serverIps": [ # The IP address (IPv4 or IPv6) of the origin server that the request was sent to. This field can include port information. Examples: `"192.168.1.1"`, `"10.0.0.1:80"`, `"FE80::0202:B3FF:FE1E:8329"`.
+ "A String",
+ ],
+ "sourceLocations": [ # Location of the Observation Source, for example "us-central1" or "europe-west1."
+ "A String",
+ ],
+ "style": "A String", # Style of ApiObservation
+ "tags": [ # User-defined tags to organize and sort
+ "A String",
+ ],
+ "updateTime": "A String", # Update time stamp
+ },
+ ],
+}
+
+
close()
Close httplib2 connections.
@@ -133,7 +191,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- ListApiObservations gets all ApiObservations for a given project and location and ObservationJob
+ ListApiObservations gets all ApiObservations for a given project and location and ObservationJob.
Args:
parent: string, Required. The parent, which owns this collection of ApiObservations. Format: projects/{project}/locations/{location}/observationJobs/{observation_job} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
index 13878a4ac0e..b8008fb41a7 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationJobs.html
@@ -99,7 +99,7 @@ Instance Methods
GetObservationJob retrieves a single ObservationJob by name.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListObservationJobs gets all ObservationJobs for a given project and location
+ListObservationJobs gets all ObservationJobs for a given project and location.
Retrieves the next page of results.
@@ -303,7 +303,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- ListObservationJobs gets all ObservationJobs for a given project and location
+ ListObservationJobs gets all ObservationJobs for a given project and location.
Args:
parent: string, Required. The parent, which owns this collection of ObservationJobs. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
index 2bc60f346a2..da4f26b7893 100644
--- a/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
+++ b/docs/dyn/apim_v1alpha.projects.locations.observationSources.html
@@ -88,7 +88,7 @@ Instance Methods
GetObservationSource retrieves a single ObservationSource by name.
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
-ListObservationSources gets all ObservationSources for a given project and location
+ListObservationSources gets all ObservationSources for a given project and location.
Retrieves the next page of results.
@@ -220,7 +220,7 @@ Method Details
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
- ListObservationSources gets all ObservationSources for a given project and location
+ ListObservationSources gets all ObservationSources for a given project and location.
Args:
parent: string, Required. The parent, which owns this collection of ObservationSources. Format: projects/{project}/locations/{location} (required)
diff --git a/docs/dyn/appengine_v1.apps.services.html b/docs/dyn/appengine_v1.apps.services.html
index 1c690d7fcf0..0bb7c7d5c39 100644
--- a/docs/dyn/appengine_v1.apps.services.html
+++ b/docs/dyn/appengine_v1.apps.services.html
@@ -158,11 +158,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
@@ -198,11 +198,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
@@ -245,11 +245,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
diff --git a/docs/dyn/appengine_v1.apps.services.versions.html b/docs/dyn/appengine_v1.apps.services.versions.html
index 331b993d366..586d897c199 100644
--- a/docs/dyn/appengine_v1.apps.services.versions.html
+++ b/docs/dyn/appengine_v1.apps.services.versions.html
@@ -172,7 +172,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
@@ -194,7 +194,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -280,7 +280,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -321,7 +321,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -474,7 +474,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
@@ -496,7 +496,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -582,7 +582,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -623,7 +623,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -715,7 +715,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
@@ -737,7 +737,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -823,7 +823,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -864,7 +864,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -959,7 +959,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"cloudBuildOptions": { # Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly. # Options for any Google Cloud Build builds created as a part of this deployment.These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip.
@@ -981,7 +981,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -1067,7 +1067,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -1108,7 +1108,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
diff --git a/docs/dyn/appengine_v1beta.apps.services.html b/docs/dyn/appengine_v1beta.apps.services.html
index 234387a72ad..97ddc0d7179 100644
--- a/docs/dyn/appengine_v1beta.apps.services.html
+++ b/docs/dyn/appengine_v1beta.apps.services.html
@@ -163,11 +163,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
@@ -203,11 +203,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
@@ -250,11 +250,11 @@ Method Details
"generatedCustomerMetadata": { # Additional Google Generated Customer Metadata, this field won't be provided by default and can be requested by setting the IncludeExtraData field in GetServiceRequest
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
- "id": "A String", # Relative name of the service within the application. Example: default.@OutputOnly
+ "id": "A String", # Output only. Relative name of the service within the application. Example: default.@OutputOnly
"labels": { # A set of labels to apply to this service. Labels are key/value pairs that describe the service and all resources that belong to it (e.g., versions). The labels can be used to search and group resources, and are propagated to the usage and billing reports, enabling fine-grain analysis of costs. An example of using labels is to tag resources belonging to different environments (e.g., "env=prod", "env=qa"). Label keys and values can be no longer than 63 characters and can only contain lowercase letters, numeric characters, underscores, dashes, and international characters. Label keys must start with a lowercase letter or an international character. Each service can have at most 32 labels.
"a_key": "A String",
},
- "name": "A String", # Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
+ "name": "A String", # Output only. Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly
"networkSettings": { # A NetworkSettings resource is a container for ingress settings for a version or service. # Ingress settings for this service. Will apply to all versions.
"ingressTrafficAllowed": "A String", # The ingress settings for version or service.
},
diff --git a/docs/dyn/appengine_v1beta.apps.services.versions.html b/docs/dyn/appengine_v1beta.apps.services.versions.html
index 1ff75a9a68d..50bde5b5b09 100644
--- a/docs/dyn/appengine_v1beta.apps.services.versions.html
+++ b/docs/dyn/appengine_v1beta.apps.services.versions.html
@@ -181,7 +181,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
@@ -206,7 +206,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -292,7 +292,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -333,7 +333,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -500,7 +500,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
@@ -525,7 +525,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -611,7 +611,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -652,7 +652,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -753,7 +753,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
@@ -778,7 +778,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -864,7 +864,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -905,7 +905,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
@@ -1009,7 +1009,7 @@ Method Details
"a_key": "A String",
},
"createTime": "A String", # Time that this version was created.@OutputOnly
- "createdBy": "A String", # Email address of the user who created this version.@OutputOnly
+ "createdBy": "A String", # Output only. Email address of the user who created this version.@OutputOnly
"defaultExpiration": "A String", # Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#StaticFilesHandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.
"deployment": { # Code and application artifacts used to deploy a version to App Engine. # Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.
"build": { # Google Cloud Build information. # Google Cloud Build build information. Only applicable for instances running in the App Engine flexible environment.
@@ -1034,7 +1034,7 @@ Method Details
"sourceUrl": "A String", # URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com//'.
},
},
- "diskUsageBytes": "A String", # Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
+ "diskUsageBytes": "A String", # Output only. Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly
"endpointsApiService": { # Google Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy. Only valid for App Engine Flexible environment deployments.The fields here refer to the name and configuration ID of a "service" resource in the Service Management API (https://cloud.google.com/service-management/overview). # Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.
"configId": "A String", # Endpoints service configuration ID as specified by the Service Management API. For example "2016-09-19r1".By default, the rollout strategy for Endpoints is RolloutStrategy.FIXED. This means that Endpoints starts up with a particular configuration ID. When a new configuration is rolled out, Endpoints must be given the new configuration ID. The config_id field is used to give the configuration ID and is required in this case.Endpoints also has a rollout strategy called RolloutStrategy.MANAGED. When using this, Endpoints fetches the latest configuration and does not need the configuration ID. In this case, config_id must be omitted.
"disableTraceSampling": True or False, # Enable or disable trace sampling. By default, this is set to false for enabled.
@@ -1120,7 +1120,7 @@ Method Details
"manualScaling": { # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. # A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time. Manually scaled versions are sometimes referred to as "backends".
"instances": 42, # Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.
},
- "name": "A String", # Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
+ "name": "A String", # Output only. Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly
"network": { # Extra network settings. Only applicable in the App Engine flexible environment. # Extra network settings. Only applicable in the App Engine flexible environment.
"forwardedPorts": [ # List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.
"A String",
@@ -1161,7 +1161,7 @@ Method Details
"serviceAccount": "A String", # The identity that the deployed version will run as. Admin API will use the App Engine Appspot service account as default if this field is neither provided in app.yaml file nor through CLI flag.
"servingStatus": "A String", # Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.
"threadsafe": True or False, # Whether multiple requests can be dispatched to this version at once.
- "versionUrl": "A String", # Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
+ "versionUrl": "A String", # Output only. Serving URL for this version. Example: "https://myversion-dot-myservice-dot-myapp.appspot.com"@OutputOnly
"vm": True or False, # Whether to deploy this version in a container on a virtual machine.
"vpcAccessConnector": { # VPC access connector specification. # Enables VPC connectivity for standard apps.
"egressSetting": "A String", # The egress setting for the connector, controlling what traffic is diverted through it.
diff --git a/docs/dyn/artifactregistry_v1.projects.html b/docs/dyn/artifactregistry_v1.projects.html
index 2640ccae90e..492035a1368 100644
--- a/docs/dyn/artifactregistry_v1.projects.html
+++ b/docs/dyn/artifactregistry_v1.projects.html
@@ -111,6 +111,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
@@ -126,6 +127,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
updateMask: string, Field mask to support partial updates.
@@ -140,6 +142,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
diff --git a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
index 3cc9134b797..1521c991c93 100644
--- a/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1.projects.locations.repositories.packages.tags.html
@@ -174,7 +174,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
- filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/".
+ filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
index 4b0a215dc27..1196c545954 100644
--- a/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1beta1.projects.locations.repositories.packages.tags.html
@@ -174,7 +174,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
- filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/".
+ filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.html b/docs/dyn/artifactregistry_v1beta2.projects.html
index dca13789dfb..e077a698a58 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.html
@@ -111,6 +111,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
@@ -126,6 +127,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
updateMask: string, Field mask to support partial updates.
@@ -140,6 +142,7 @@ Method Details
{ # The Artifact Registry settings that apply to a Project.
"legacyRedirectionState": "A String", # The redirection state of the legacy repositories in this project.
"name": "A String", # The name of the project's settings. Always of the form: projects/{project-id}/projectSettings In update request: never set In response: always set
+ "pullPercent": 42, # The percentage of pull traffic to redirect from GCR to AR when using partial redirection.
}
diff --git a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
index 3863f6760ef..eb11fde56e6 100644
--- a/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
+++ b/docs/dyn/artifactregistry_v1beta2.projects.locations.repositories.packages.tags.html
@@ -174,7 +174,7 @@ Method Details
Args:
parent: string, The name of the parent package whose tags will be listed. For example: `projects/p1/locations/us-central1/repositories/repo1/packages/pkg1`. (required)
- filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`. * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/a%2Fb%2F*"` --> tags with an ID starting with "a/b/". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2Fc"` --> tags with an ID ending with "/b/c". * `name="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/tags/*%2Fb%2F*"` --> tags with an ID containing "/b/".
+ filter: string, An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are: * `version` An example of using a filter: * `version="projects/p1/locations/us-central1/repositories/repo1/packages/pkg1/versions/1.0"` --> Tags that are applied to the version `1.0` in package `pkg1`.
pageSize: integer, The maximum number of tags to return. Maximum page size is 1,000.
pageToken: string, The next_page_token value returned from a previous list request, if any.
x__xgafv: string, V1 error format.
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html
new file mode 100644
index 00000000000..ce09eeb54af
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.auctionPackages.html
@@ -0,0 +1,153 @@
+
+
+
+Authorized Buyers Marketplace API . bidders . auctionPackages
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+ parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+ filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+ orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+ pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+ pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+ 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 listing auction packages.
+ "auctionPackages": [ # The list of auction packages.
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+
+
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html
new file mode 100644
index 00000000000..4cb42775a21
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.finalizedDeals.html
@@ -0,0 +1,370 @@
+
+
+
+Authorized Buyers Marketplace API . bidders . finalizedDeals
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+ parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+ filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+ orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+ pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+ 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 listing finalized deals.
+ "finalizedDeals": [ # The list of finalized deals.
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+
+
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html
new file mode 100644
index 00000000000..48973331492
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.bidders.html
@@ -0,0 +1,96 @@
+
+
+
+Authorized Buyers Marketplace API . bidders
+Instance Methods
+
+Returns the auctionPackages Resource.
+
+
+ finalizedDeals()
+
+Returns the finalizedDeals Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html
new file mode 100644
index 00000000000..6e169cf72c4
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.auctionPackages.html
@@ -0,0 +1,388 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . auctionPackages
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets an auction package given its name.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Retrieves the next page of results.
+
+ subscribe(name, body=None, x__xgafv=None)
+Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.
+
+ subscribeClients(auctionPackage, body=None, x__xgafv=None)
+Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
+
+ unsubscribe(name, body=None, x__xgafv=None)
+Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.
+
+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None)
+Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets an auction package given its name.
+
+Args:
+ name: string, Required. Name of auction package to get. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ List the auction packages. Buyers can use the URL path "/v1alpha/buyers/{accountId}/auctionPackages" to list auction packages for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/auctionPackages" to list auction packages for the bidder, its media planners, its buyers, and all their clients.
+
+Args:
+ parent: string, Required. Name of the parent buyer that can access the auction package. Format: `buyers/{accountId}`. When used with a bidder account, the auction packages that the bidder, its media planners, its buyers and clients are subscribed to will be listed, in the format `bidders/{accountId}`. (required)
+ filter: string, Optional. Optional query string using the [Cloud API list filtering syntax](/authorized-buyers/apis/guides/list-filters). Only supported when parent is bidder. Supported columns for filtering are: * displayName * createTime * updateTime * eligibleSeatIds
+ orderBy: string, Optional. An optional query string to sort auction packages using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Only supported when parent is bidder. Supported columns for sorting are: * displayName * createTime * updateTime
+ pageSize: integer, Requested page size. The server may return fewer results than requested. Max allowed page size is 500.
+ pageToken: string, The page token as returned. ListAuctionPackagesResponse.nextPageToken
+ 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 listing auction packages.
+ "auctionPackages": [ # The list of auction packages.
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListAuctionPackagesRequest.pageToken field in the subsequent call to the `ListAuctionPackages` method to retrieve the next page of results.
+}
+
+
+
+ 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.
+
+
+
+
+ subscribe(name, body=None, x__xgafv=None)
+ Subscribe to the auction package for the specified buyer. Once subscribed, the bidder will receive a call out for inventory matching the auction package targeting criteria with the auction package deal ID and the specified buyer.
+
+Args:
+ name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackage.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+
+
+ subscribeClients(auctionPackage, body=None, x__xgafv=None)
+ Subscribe the specified clients of the buyer to the auction package. If a client in the list does not belong to the buyer, an error response will be returned, and all of the following clients in the list will not be subscribed. Subscribing an already subscribed client will have no effect.
+
+Args:
+ auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SubscribeAuctionPackageClients.
+ "clients": [ # Optional. A list of client buyers to subscribe to the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`. The current buyer will be subscribed to the auction package regardless of the list contents if not already.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+
+
+ unsubscribe(name, body=None, x__xgafv=None)
+ Unsubscribe from the auction package for the specified buyer. Once unsubscribed, the bidder will no longer receive a call out for the auction package deal ID and the specified buyer.
+
+Args:
+ name: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+
+
+ unsubscribeClients(auctionPackage, body=None, x__xgafv=None)
+ Unsubscribe from the auction package for the specified clients of the buyer. Unsubscribing a client that is not subscribed will have no effect.
+
+Args:
+ auctionPackage: string, Required. Name of the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for UnsubscribeAuctionPackage.
+ "clients": [ # Optional. A list of client buyers to unsubscribe from the auction package, with client buyer in the format `buyers/{accountId}/clients/{clientAccountId}`.
+ "A String",
+ ],
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines a segment of inventory that buyer wants to buy. It's created by buyer and could be shared with multiple buyers.
+ "createTime": "A String", # Output only. Time the auction package was created.
+ "creator": "A String", # Output only. The buyer that created this auction package. Format: `buyers/{buyerAccountId}`
+ "description": "A String", # Output only. A description of the auction package.
+ "displayName": "A String", # The display_name assigned to the auction package.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "name": "A String", # Immutable. The unique identifier for the auction package. Format: `buyers/{accountId}/auctionPackages/{auctionPackageId}` The auction_package_id part of name is sent in the BidRequest to all RTB bidders and is returned as deal_id by the bidder in the BidResponse.
+ "subscribedBuyers": [ # Output only. The list of buyers that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder. Format: `buyers/{buyerAccountId}`
+ "A String",
+ ],
+ "subscribedClients": [ # Output only. When calling as a buyer, the list of clients of the current buyer that are subscribed to the AuctionPackage. When calling as a bidder, the list of clients that are subscribed to the AuctionPackage owned by the bidder or its buyers. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}`
+ "A String",
+ ],
+ "subscribedMediaPlanners": [ # Output only. The list of media planners that are subscribed to the AuctionPackage. This field is only populated when calling as a bidder.
+ { # Describes a single Media Planner account.
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ ],
+ "updateTime": "A String", # Output only. Time the auction package was last updated. This value is only increased when this auction package is updated but never when a buyer subscribed.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html
new file mode 100644
index 00000000000..76696aa4535
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.html
@@ -0,0 +1,315 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . clients
+Instance Methods
+
+ users()
+
+Returns the users Resource.
+
+
+ activate(name, body=None, x__xgafv=None)
+Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a new client.
+
+ deactivate(name, body=None, x__xgafv=None)
+Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+
+Gets a client with a given resource name.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all the clients for the current buyer.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates an existing client.
+Method Details
+
+ activate(name, body=None, x__xgafv=None)
+ Activates an existing client. The state of the client will be updated to "ACTIVE". This method has no effect if the client is already in "ACTIVE" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for activating a client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a new client.
+
+Args:
+ parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+
+
+ deactivate(name, body=None, x__xgafv=None)
+ Deactivates an existing client. The state of the client will be updated to "INACTIVE". This method has no effect if the client is already in "INACTIVE" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for disabling a client.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a client with a given resource name.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all the clients for the current buyer.
+
+Args:
+ parent: string, Required. The name of the buyer. Format: `buyers/{accountId}` (required)
+ filter: string, Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: * partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be `partnerClientId = "1234"`, in order to get only the client whose partnerClientId is "1234" in the response.
+ pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+ pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientsResponse.nextPageToken returned from the previous call to the list method.
+ 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 the list method.
+ "clients": [ # The returned list of clients.
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+
+
+ 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, updateMask=None, x__xgafv=None)
+ Updates an existing client.
+
+Args:
+ name: string, Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A client represents an agency, a brand, or an advertiser customer of the buyer. Based on the client's role, its client users will have varying levels of restricted access to the Marketplace and certain other sections of the Authorized Buyers UI.
+ "displayName": "A String", # Required. Display name shown to publishers. Must be unique for clients without partnerClientId specified. Maximum length of 255 characters is allowed.
+ "name": "A String", # Output only. The resource name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}`
+ "partnerClientId": "A String", # Arbitrary unique identifier provided by the buyer. This field can be used to associate a client with an identifier in the namespace of the buyer, lookup clients by that identifier and verify whether an Authorized Buyers account of the client already exists. If present, must be unique across all the clients.
+ "role": "A String", # Required. The role assigned to the client. Each role implies a set of permissions granted to the client.
+ "sellerVisible": True or False, # Whether the client will be visible to sellers.
+ "state": "A String", # Output only. The state of the client.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html
new file mode 100644
index 00000000000..6d95bba3457
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.clients.users.html
@@ -0,0 +1,272 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . clients . users
+Instance Methods
+
+ activate(name, body=None, x__xgafv=None)
+Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+ deactivate(name, body=None, x__xgafv=None)
+Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+
+Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+
+Retrieves an existing client user.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all client users for a specified client.
+
+Retrieves the next page of results.
+Method Details
+
+ activate(name, body=None, x__xgafv=None)
+ Activates an existing client user. The state of the client user will be updated from "INACTIVE" to "ACTIVE". This method has no effect if the client user is already in "ACTIVE" state. An error will be returned if the client user to activate is still in "INVITED" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for activating a client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a new client user in "INVITED" state. An email invitation will be sent to the new user, once accepted the user will become active.
+
+Args:
+ parent: string, Required. The name of the client. Format: `buyers/{accountId}/clients/{clientAccountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+
+
+ deactivate(name, body=None, x__xgafv=None)
+ Deactivates an existing client user. The state of the client user will be updated from "ACTIVE" to "INACTIVE". This method has no effect if the client user is already in "INACTIVE" state. An error will be returned if the client user to deactivate is still in "INVITED" state.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for deactivating a client user.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+
+
+ delete(name, x__xgafv=None)
+ Deletes an existing client user. The client user will lose access to the Authorized Buyers UI. Note that if a client user is deleted, the user's access to the UI can't be restored unless a new client user is created and activated.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (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)
+ Retrieves an existing client user.
+
+Args:
+ name: string, Required. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}/clientUsers/{userId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all client users for a specified client.
+
+Args:
+ parent: string, Required. The name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` (required)
+ pageSize: integer, Requested page size. If left blank, a default page size of 500 will be applied.
+ pageToken: string, A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the list method.
+ 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 the list method.
+ "clientUsers": [ # The returned list of client users.
+ { # A user of a client who has restricted access to the Marketplace and certain other sections of the Authorized Buyers UI based on the role granted to the associated client.
+ "email": "A String", # Required. The client user's email address that has to be unique across all users for the same client.
+ "name": "A String", # Output only. The resource name of the client user. Format: `buyers/{accountId}/clients/{clientAccountId}/users/{userId}`
+ "state": "A String", # Output only. The state of the client user.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the list method to retrieve the next page of results.
+}
+
+
+
+ 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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html
new file mode 100644
index 00000000000..20c834f345c
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.dataSegments.html
@@ -0,0 +1,333 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . dataSegments
+Instance Methods
+
+ activate(name, body=None, x__xgafv=None)
+Activates a data segment.
+
+ close()
+Close httplib2 connections.
+
+ create(parent, body=None, x__xgafv=None)
+Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.
+
+ deactivate(name, body=None, x__xgafv=None)
+Deactivates a data segment.
+
+Gets a data segment given its name.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+List the data segments owned by a curator.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates a data segment.
+Method Details
+
+ activate(name, body=None, x__xgafv=None)
+ Activates a data segment.
+
+Args:
+ name: string, Required. Name of data segment to activate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for activating a data segment
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ create(parent, body=None, x__xgafv=None)
+ Creates a data segment owned by the listed curator. The data segment will be created in the `ACTIVE` state, meaning it will be immediately available for buyers to use in preferred deals, private auction deals, and auction packages.
+
+Args:
+ parent: string, Required. The parent resource where this data segment will be created. Format: `buyers/{accountId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+
+
+ deactivate(name, body=None, x__xgafv=None)
+ Deactivates a data segment.
+
+Args:
+ name: string, Required. Name of data segment to deactivate. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for deactivating a data segment
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+
+
+ get(name, x__xgafv=None)
+ Gets a data segment given its name.
+
+Args:
+ name: string, Required. Name of data segment to get. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ List the data segments owned by a curator.
+
+Args:
+ parent: string, Required. Name of the parent buyer that can access the data segment. Format: `buyers/{accountId}` (required)
+ pageSize: integer, Optional. Requested page size. The server may return fewer results than requested. Max allowed page size is 500. If unspecified, the server will default to 500.
+ pageToken: string, Optional. The page token as returned. ListDataSegmentsResponse.nextPageToken
+ 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 listing data segments.
+ "dataSegments": [ # The list of data segments.
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results. Pass this value in the ListDataSegmentsRequest.pageToken field in the subsequent call to the `ListDataSegments` method to retrieve the next page of results.
+}
+
+
+
+ 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, updateMask=None, x__xgafv=None)
+ Updates a data segment.
+
+Args:
+ name: string, Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+ updateMask: string, Optional. List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Defines an identifier for a segment of inventory that can be targeted by curators or media planners in the deals or auction packages UI. Curation of inventory is done by curators on external platforms.
+ "cpmFee": { # Represents an amount of money with its currency type. # Optional. This will be charged when other accounts use this data segment. For example, when other accounts add this data segment to a deal or auction package.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "createTime": "A String", # Output only. Time the data segment was created.
+ "name": "A String", # Immutable. Identifier. The unique identifier for the data segment. Account ID corresponds to the account ID that created the segment. Format: `buyers/{accountId}/dataSegments/{curatorDataSegmentId}`
+ "state": "A String", # Output only. The state of the data segment.
+ "updateTime": "A String", # Output only. Time the data segment was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html
new file mode 100644
index 00000000000..e491e3c0a1e
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.finalizedDeals.html
@@ -0,0 +1,1686 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . finalizedDeals
+Instance Methods
+
+ addCreative(deal, body=None, x__xgafv=None)
+Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+ close()
+Close httplib2 connections.
+
+Gets a finalized deal given its name.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Retrieves the next page of results.
+
+ pause(name, body=None, x__xgafv=None)
+Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
+
+ resume(name, body=None, x__xgafv=None)
+Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
+
+ setReadyToServe(deal, body=None, x__xgafv=None)
+Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+Method Details
+
+ addCreative(deal, body=None, x__xgafv=None)
+ Add creative to be used in the bidding process for a finalized deal. For programmatic guaranteed deals, it's recommended that you associate at least one approved creative with the deal before calling SetReadyToServe, to help reduce the number of bid responses filtered because they don't contain approved creatives. Creatives successfully added to a deal can be found in the Realtime-bidding Creatives API creative.deal_ids. This method only applies to programmatic guaranteed deals. Maximum number of 1000 creatives can be added to a finalized deal.
+
+Args:
+ deal: string, Required. Name of the finalized deal in the format of: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for adding creative to be used in the bidding process for the finalized deal.
+ "creative": "A String", # Name of the creative to add to the finalized deal, in the format `buyers/{buyerAccountId}/creatives/{creativeId}`. See creative.name.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a finalized deal given its name.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+
+
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists finalized deals. Use the URL path "/v1alpha/buyers/{accountId}/finalizedDeals" to list finalized deals for the current buyer and its clients. Bidders can use the URL path "/v1alpha/bidders/{accountId}/finalizedDeals" to list finalized deals for the bidder, its buyers and all their clients.
+
+Args:
+ parent: string, Required. The buyer to list the finalized deals for, in the format: `buyers/{accountId}`. When used to list finalized deals for a bidder, its buyers and clients, in the format `bidders/{accountId}`. (required)
+ filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * deal.displayName * deal.dealType * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * deal.eligibleSeatIds * dealServingStatus
+ orderBy: string, An optional query string to sort finalized deals using the [Cloud API sorting syntax](https://cloud.google.com/apis/design/design_patterns#sorting_order). If no sort order is specified, results will be returned in an arbitrary order. Supported columns for sorting are: * deal.displayName * deal.createTime * deal.updateTime * deal.flightStartTime * deal.flightEndTime * rtbMetrics.bidRequests7Days * rtbMetrics.bids7Days * rtbMetrics.adImpressions7Days * rtbMetrics.bidRate7Days * rtbMetrics.filteredBidRate7Days * rtbMetrics.mustBidRateCurrentMonth
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+ pageToken: string, The page token as returned from ListFinalizedDealsResponse.
+ 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 listing finalized deals.
+ "finalizedDeals": [ # The list of finalized deals.
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+
+
+ 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.
+
+
+
+
+ pause(name, body=None, x__xgafv=None)
+ Pauses serving of the given finalized deal. This call only pauses the serving status, and does not affect other fields of the finalized deal. Calling this method for an already paused deal has no effect. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for pausing a finalized deal.
+ "reason": "A String", # The reason to pause the finalized deal, will be displayed to the seller. Maximum length is 1000 characters.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+
+
+
+ resume(name, body=None, x__xgafv=None)
+ Resumes serving of the given finalized deal. Calling this method for an running deal has no effect. If a deal is initially paused by the seller, calling this method will not resume serving of the deal until the seller also resumes the deal. This method only applies to programmatic guaranteed deals and preferred deals.
+
+Args:
+ name: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for resuming a finalized deal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+
+
+
+ setReadyToServe(deal, body=None, x__xgafv=None)
+ Sets the given finalized deal as ready to serve. By default, deals are set as ready to serve as soon as they're finalized. If you want to opt out of the default behavior, and manually indicate that deals are ready to serve, ask your Technical Account Manager to add you to the allowlist. If you choose to use this method, finalized deals belonging to the bidder and its child seats don't start serving until after you call `setReadyToServe`, and after the deals become active. For example, you can use this method to delay receiving bid requests until your creative is ready. This method only applies to programmatic guaranteed deals.
+
+Args:
+ deal: string, Required. Format: `buyers/{accountId}/finalizedDeals/{dealId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for setting ready to serve for a finalized deal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A finalized deal is a snapshot of the deal when both buyer and seller accept the deal. The buyer or seller can update the deal after it's been finalized and renegotiate on the deal targeting, terms and other fields, while at the same time the finalized snapshot of the deal can still be retrieved using this API. The finalized deal contains a copy of the deal as it existed when most recently finalized, as well as fields related to deal serving such as pause/resume status, RTB metrics, and more.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # A copy of the Deal made upon finalization. During renegotiation, this will reflect the last finalized deal before renegotiation was initiated.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "dealPausingInfo": { # Information related to deal pausing. # Information related to deal pausing for the deal.
+ "pauseReason": "A String", # The reason for the pausing of the deal; empty for active deals.
+ "pauseRole": "A String", # The party that first paused the deal; unspecified for active deals.
+ "pausingConsented": True or False, # Whether pausing is consented between buyer and seller for the deal.
+ },
+ "dealServingStatus": "A String", # Serving status of the deal.
+ "name": "A String", # The resource name of the finalized deal. Format: `buyers/{accountId}/finalizedDeals/{finalizedDealId}`
+ "readyToServe": True or False, # Whether the Programmatic Guaranteed deal is ready for serving.
+ "rtbMetrics": { # Real-time bidding metrics. For what each metric means refer to [Report metrics](https://support.google.com/adxbuyer/answer/6115195#report-metrics) # Real-time bidding metrics for this deal.
+ "adImpressions7Days": "A String", # Ad impressions in last 7 days.
+ "bidRate7Days": 3.14, # Bid rate in last 7 days, calculated by (bids / bid requests).
+ "bidRequests7Days": "A String", # Bid requests in last 7 days.
+ "bids7Days": "A String", # Bids in last 7 days.
+ "filteredBidRate7Days": 3.14, # Filtered bid rate in last 7 days, calculated by (filtered bids / bids).
+ "mustBidRateCurrentMonth": 3.14, # Must bid rate for current month.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html
new file mode 100644
index 00000000000..0780b4d9f13
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.html
@@ -0,0 +1,116 @@
+
+
+
+Authorized Buyers Marketplace API . buyers
+Instance Methods
+
+Returns the auctionPackages Resource.
+
+
+ clients()
+
+Returns the clients Resource.
+
+
+ dataSegments()
+
+Returns the dataSegments Resource.
+
+
+ finalizedDeals()
+
+Returns the finalizedDeals Resource.
+
+
+ proposals()
+
+Returns the proposals Resource.
+
+
+Returns the publisherProfiles Resource.
+
+
+ close()
+Close httplib2 connections.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html
new file mode 100644
index 00000000000..1268be967fd
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.deals.html
@@ -0,0 +1,1532 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . proposals . deals
+Instance Methods
+
+ batchUpdate(parent, body=None, x__xgafv=None)
+Batch updates multiple deals in the same proposal.
+
+ close()
+Close httplib2 connections.
+
+Gets a deal given its name. The deal is returned at its head revision.
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
+Method Details
+
+ batchUpdate(parent, body=None, x__xgafv=None)
+ Batch updates multiple deals in the same proposal.
+
+Args:
+ parent: string, Required. The name of the proposal containing the deals to batch update. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for batch updating deals.
+ "requests": [ # Required. List of request messages to update deals.
+ { # Request message for updating the deal at the given revision number.
+ "deal": { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals. # Required. The deal to update. The deal's `name` field is used to identify the deal to be updated. Note: proposal_revision will have to be provided within the resource or else an error will be thrown. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ "updateMask": "A String", # List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ },
+ ],
+}
+
+ 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 batch updating deals.
+ "deals": [ # Deals updated.
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ ],
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a deal given its name. The deal is returned at its head revision.
+
+Args:
+ name: string, Required. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+
+
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists all deals in a proposal. To retrieve only the finalized revision deals regardless if a deal is being renegotiated, see the FinalizedDeals resource.
+
+Args:
+ parent: string, Required. The name of the proposal containing the deals to retrieve. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+ pageToken: string, The page token as returned from ListDealsResponse.
+ 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 listing deals in a proposal.
+ "deals": [ # The list of deals.
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+ },
+ ],
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+}
+
+
+
+ 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, updateMask=None, x__xgafv=None)
+ Updates the given deal at the buyer known revision number. If the server revision has advanced since the passed-in proposal.proposal_revision an ABORTED error message will be returned. The revision number is incremented by the server whenever the proposal or its constituent deals are updated. Note: The revision number is kept at a proposal level. The buyer of the API is expected to keep track of the revision number after the last update operation and send it in as part of the next update request. This way, if there are further changes on the server (for example, seller making new updates), then the server can detect conflicts and reject the proposed changes.
+
+Args:
+ name: string, Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A deal represents a segment of inventory for displaying ads that contains the terms and targeting information that is used for serving as well as the deal stats and status. Note: A proposal may contain multiple deals.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer; when the deal belongs to a media planner account, this field will be empty. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. Format: `buyers/{buyerAccountId}`
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "createTime": "A String", # Output only. The time of the deal creation.
+ "creativeRequirements": { # Message captures data about the creatives in the deal. # Output only. Metadata about the creatives of this deal.
+ "creativeFormat": "A String", # Output only. The format of the creative, only applicable for programmatic guaranteed and preferred deals.
+ "creativePreApprovalPolicy": "A String", # Output only. Specifies the creative pre-approval policy.
+ "creativeSafeFrameCompatibility": "A String", # Output only. Specifies whether the creative is safeFrame compatible.
+ "maxAdDurationMs": "A String", # Output only. The max duration of the video creative in milliseconds. only applicable for deals with video creatives.
+ "programmaticCreativeSource": "A String", # Output only. Specifies the creative source for programmatic deals. PUBLISHER means creative is provided by seller and ADVERTISER means creative is provided by the buyer.
+ "skippableAdType": "A String", # Output only. Skippable video ads allow viewers to skip ads after 5 seconds. Only applicable for deals with video creatives.
+ },
+ "dealType": "A String", # Output only. Type of deal.
+ "deliveryControl": { # Message contains details about how the deal will be paced. # Output only. Specifies the pacing set by the publisher.
+ "companionDeliveryType": "A String", # Output only. Specifies roadblocking in a main companion lineitem.
+ "creativeRotationType": "A String", # Output only. Specifies strategy to use for selecting a creative when multiple creatives of the same size are available.
+ "deliveryRateType": "A String", # Output only. Specifies how the impression delivery will be paced.
+ "frequencyCap": [ # Output only. Specifies any frequency caps. Cannot be filtered within ListDealsRequest.
+ { # Message contains details about publisher-set frequency caps of the delivery.
+ "maxImpressions": 42, # The maximum number of impressions that can be served to a user within the specified time period.
+ "timeUnitType": "A String", # The time unit. Along with num_time_units defines the amount of time over which impressions per user are counted and capped.
+ "timeUnitsCount": 42, # The amount of time, in the units specified by time_unit_type. Defines the amount of time over which impressions per user are counted and capped.
+ },
+ ],
+ "roadblockingType": "A String", # Output only. Specifies the roadblocking type in display creatives.
+ },
+ "description": "A String", # Output only. Free text description for the deal terms.
+ "displayName": "A String", # Output only. The name of the deal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the deal.
+ "eligibleSeatIds": [ # Output only. If set, this field contains the list of DSP specific seat ids set by media planners that are eligible to transact on this deal. The seat ID is in the calling DSP's namespace.
+ "A String",
+ ],
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Proposed flight end time of the deal. This will generally be stored in a granularity of a second. A value is not necessary for Private Auction deals.
+ "flightStartTime": "A String", # Proposed flight start time of the deal. This will generally be stored in the granularity of one second since deal serving starts at seconds boundary. Any time specified with more granularity (for example, in milliseconds) will be truncated towards the start of time in seconds.
+ "mediaPlanner": { # Describes a single Media Planner account. # Output only. Refers to a buyer in Real-time Bidding API's Buyer resource. This field represents a media planner (For example, agency or big advertiser).
+ "accountId": "A String", # Output only. Account ID of the media planner.
+ },
+ "name": "A String", # Immutable. The unique identifier of the deal. Auto-generated by the server when a deal is created. Format: buyers/{accountId}/proposals/{proposalId}/deals/{dealId}
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "privateAuctionTerms": { # Pricing terms for Private Auctions. # The terms for private auction deals.
+ "floorPrice": { # Represents a price and a pricing type for a deal. # The minimum price buyer has to bid to compete in the private auction.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "openAuctionAllowed": True or False, # Output only. True if open auction buyers are allowed to compete with invited buyers in this private auction.
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "proposalRevision": "A String", # Output only. The revision number for the proposal and is the same value as proposal.proposal_revision. Each update to deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the deal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}`
+ "sellerTimeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Output only. Time zone of the seller used to mark the boundaries of a day for daypart targeting and CPD billing.
+ "id": "A String", # IANA Time Zone Database time zone, e.g. "America/New_York".
+ "version": "A String", # Optional. IANA Time Zone Database version number, e.g. "2019a".
+ },
+ "targeting": { # Targeting represents different criteria that can be used to target deals or auction packages. For example, they can choose to target inventory only if the user is in the US. Multiple types of targeting are always applied as a logical AND, unless noted otherwise. # Specifies the subset of inventory targeted by the deal. Can be updated by the buyer before the deal is finalized.
+ "daypartTargeting": { # Represents Daypart targeting. # Daypart targeting information.
+ "dayParts": [ # The targeted weekdays and times
+ { # Defines targeting for a period of time on a specific week day.
+ "dayOfWeek": "A String", # Day of week for the period.
+ "endTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ "startTime": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Hours in 24 hour time between 0 and 24, inclusive. Note: 24 is logically equivalent to 0, but is supported since in some cases there may need to be differentiation made between midnight on one day and midnight on the next day. Accepted values for minutes are [0, 15, 30, 45]. 0 is the only acceptable minute value for hour 24. Seconds and nanos are ignored.
+ "hours": 42, # Hours of day in 24 hour format. Should be from 0 to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time.
+ "minutes": 42, # Minutes of hour of day. Must be from 0 to 59.
+ "nanos": 42, # Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.
+ "seconds": 42, # Seconds of minutes of the time. Must normally be from 0 to 59. An API may allow the value 60 if it allows leap-seconds.
+ },
+ },
+ ],
+ "timeZoneType": "A String", # The time zone type of the day parts
+ },
+ "excludedSensitiveCategoryIds": [ # Output only. The sensitive content category label IDs excluded. Refer to this file https://storage.googleapis.com/adx-rtb-dictionaries/content-labels.txt for category IDs.
+ "A String",
+ ],
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. Geo criteria IDs to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Output only. Inventory sizes to be included/excluded.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "inventoryTypeTargeting": { # Targeting of the inventory types a bid request can originate from. # Output only. Inventory type targeting information.
+ "inventoryTypes": [ # The list of targeted inventory types for the bid request.
+ "A String",
+ ],
+ },
+ "placementTargeting": { # Represents targeting about where the ads can appear, for example, certain sites or mobile applications. Different placement targeting types will be logically OR'ed. # Output only. Placement targeting information, for example, URL, mobile applications.
+ "mobileApplicationTargeting": { # Mobile application targeting settings. # Mobile application targeting information in a deal. This doesn't apply to Auction Packages.
+ "firstPartyTargeting": { # Represents a list of targeted and excluded mobile application IDs that publishers own. Android App ID, for example, com.google.android.apps.maps, can be found in Google Play Store URL. iOS App ID (which is a number) can be found at the end of iTunes store URL. First party mobile applications is either included or excluded. # Publisher owned apps to be targeted or excluded by the publisher to display the ads in.
+ "excludedAppIds": [ # A list of application IDs to be excluded.
+ "A String",
+ ],
+ "targetedAppIds": [ # A list of application IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ "uriTargeting": { # Represents a list of targeted and excluded URLs (for example, google.com). For Private Auction Deals, URLs are either included or excluded. For Programmatic Guaranteed and Preferred Deals, this doesn't apply. # URLs to be included/excluded.
+ "excludedUris": [ # A list of URLs to be excluded.
+ "A String",
+ ],
+ "targetedUris": [ # A list of URLs to be included.
+ "A String",
+ ],
+ },
+ },
+ "technologyTargeting": { # Represents targeting about various types of technology. # Output only. Technology targeting information, for example, operating system, device category.
+ "deviceCapabilityTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device capabilities to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "deviceCategoryTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of device categories to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemTargeting": { # Represents targeting information for operating systems. # Operating system related targeting information.
+ "operatingSystemCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating systems to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "operatingSystemVersionCriteria": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # IDs of operating system versions to be included/excluded.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ },
+ },
+ "userListTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Buyer user list targeting information. User lists can be uploaded using https://developers.google.com/authorized-buyers/rtb/bulk-uploader.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "verticalTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Output only. The verticals included or excluded as defined in https://developers.google.com/authorized-buyers/rtb/downloads/publisher-verticals
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "videoTargeting": { # Represents targeting information about video. # Output only. Video targeting information.
+ "excludedPositionTypes": [ # A list of video positions to be excluded. When this field is populated, the targeted_position_types field must be empty.
+ "A String",
+ ],
+ "targetedPositionTypes": [ # A list of video positions to be included. When this field is populated, the excluded_position_types field must be empty.
+ "A String",
+ ],
+ },
+ },
+ "updateTime": "A String", # Output only. The time when the deal was last updated.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html
new file mode 100644
index 00000000000..ab878fd59cf
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.proposals.html
@@ -0,0 +1,662 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . proposals
+Instance Methods
+
+ deals()
+
+Returns the deals Resource.
+
+
+ accept(name, body=None, x__xgafv=None)
+Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+ addNote(proposal, body=None, x__xgafv=None)
+Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
+
+ cancelNegotiation(proposal, body=None, x__xgafv=None)
+Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+ close()
+Close httplib2 connections.
+
+Gets a proposal using its resource name. The proposal is returned at the latest revision.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.
+
+Retrieves the next page of results.
+
+ patch(name, body=None, updateMask=None, x__xgafv=None)
+Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+ sendRfp(buyer, body=None, x__xgafv=None)
+Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+Method Details
+
+ accept(name, body=None, x__xgafv=None)
+ Accepts the proposal at the given revision number. If the revision number in the request is behind the latest from the server, an error message will be returned. This call updates the Proposal.state from `BUYER_ACCEPTANCE_REQUESTED` to `FINALIZED`; it has no side effect if the Proposal.state is already `FINALIZED` and throws exception if the Proposal.state is not either `BUYER_ACCEPTANCE_REQUESTED` or `FINALIZED`. Accepting a proposal means the buyer understands and accepts the Proposal.terms_and_conditions proposed by the seller.
+
+Args:
+ name: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to accept a proposal. Accepting a proposal implies acceptance of the publisher terms_and_conditions, if any.
+ "proposalRevision": "A String", # The last known client revision number of the proposal.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
+ addNote(proposal, body=None, x__xgafv=None)
+ Creates a note for this proposal and sends to the seller. This method is not supported for proposals with DealType set to 'PRIVATE_AUCTION'.
+
+Args:
+ proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to add a note.
+ "note": { # A text note attached to the proposal to facilitate the communication between buyers and sellers. # The note to add.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
+ cancelNegotiation(proposal, body=None, x__xgafv=None)
+ Cancels an ongoing negotiation on a proposal. This does not cancel or end serving for the deals if the proposal has been finalized. If the proposal has not been finalized before, calling this method will set the Proposal.state to `TERMINATED` and increment the Proposal.proposal_revision. If the proposal has been finalized before and is under renegotiation now, calling this method will reset the Proposal.state to `FINALIZED` and increment the Proposal.proposal_revision. This method does not support private auction proposals whose Proposal.deal_type is 'PRIVATE_AUCTION'.
+
+Args:
+ proposal: string, Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to cancel an ongoing negotiation.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets a proposal using its resource name. The proposal is returned at the latest revision.
+
+Args:
+ name: string, Required. Name of the proposal. Format: `buyers/{accountId}/proposals/{proposalId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.
+
+Args:
+ parent: string, Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` (required)
+ filter: string, Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: * displayName * dealType * updateTime * state
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
+ pageToken: string, The page token as returned from ListProposalsResponse.
+ 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 listing proposals.
+ "nextPageToken": "A String", # Continuation token for fetching the next page of results.
+ "proposals": [ # The list of proposals.
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+ },
+ ],
+}
+
+
+
+ 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, updateMask=None, x__xgafv=None)
+ Updates the proposal at the given revision number. If the revision number in the request is behind the latest one kept in the server, an error message will be returned. See FieldMask for how to use FieldMask. Only fields specified in the UpdateProposalRequest.update_mask will be updated; Fields noted as 'Immutable' or 'Output only' yet specified in the UpdateProposalRequest.update_mask will be ignored and left unchanged. Updating a private auction proposal is not allowed and will result in an error.
+
+Args:
+ name: string, Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+ updateMask: string, List of fields to be updated. If empty or unspecified, the service will update all fields populated in the update request excluding the output only fields and primitive fields with default value. Note that explicit field mask is required in order to reset a primitive field back to its default value, for example, false for boolean fields, 0 for integer fields. A special field mask consisting of a single path "*" can be used to indicate full replacement(the equivalent of PUT method), updatable fields unset or unspecified in the input will be cleared or set to default value. Output only fields will be ignored regardless of the value of updateMask.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
+ sendRfp(buyer, body=None, x__xgafv=None)
+ Sends a request for proposal (RFP) to a publisher to initiate the negotiation regarding certain inventory. In the RFP, buyers can specify the deal type, deal terms, start and end dates, targeting, and a message to the publisher. Once the RFP is sent, a proposal in `SELLER_REVIEW_REQUESTED` state will be created and returned in the response. The publisher may review your request and respond with detailed deals in the proposal.
+
+Args:
+ buyer: string, Required. The current buyer who is sending the RFP in the format: `buyers/{accountId}`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request to send an RFP. All fields in this request are proposed to publisher and subject to changes by publisher during later negotiation.
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "client": "A String", # If the current buyer is sending the RFP on behalf of its client, use this field to specify the name of the client in the format: `buyers/{accountId}/clients/{clientAccountid}`.
+ "displayName": "A String", # Required. The display name of the proposal being created by this RFP.
+ "estimatedGrossSpend": { # Represents an amount of money with its currency type. # Specified by buyers in request for proposal (RFP) to notify publisher the total estimated spend for the proposal. Publishers will receive this information and send back proposed deals accordingly.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "flightEndTime": "A String", # Required. Proposed flight end time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+ "flightStartTime": "A String", # Required. Proposed flight start time of the RFP. A timestamp in RFC3339 UTC "Zulu" format. Note that the specified value will be truncated to a granularity of one second.
+ "geoTargeting": { # Generic targeting used for targeting dimensions that contains a list of included and excluded numeric IDs. This cannot be filtered using list filter syntax. # Geo criteria IDs to be targeted. Refer to Geo tables.
+ "excludedCriteriaIds": [ # A list of numeric IDs to be excluded.
+ "A String",
+ ],
+ "targetedCriteriaIds": [ # A list of numeric IDs to be included.
+ "A String",
+ ],
+ },
+ "inventorySizeTargeting": { # Represents the size of an ad unit that can be targeted on a bid request. # Inventory sizes to be targeted.
+ "excludedInventorySizes": [ # A list of inventory sizes to be excluded.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ "targetedInventorySizes": [ # A list of inventory sizes to be included.
+ { # Represents size of a single ad slot, or a creative.
+ "height": "A String", # The height of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ "type": "A String", # The type of the ad slot size.
+ "width": "A String", # The width of the ad slot in pixels. This field will be present only when size type is `PIXEL`.
+ },
+ ],
+ },
+ "note": "A String", # A message that is sent to the publisher. Maximum length is 1024 characters.
+ "preferredDealTerms": { # Pricing terms for Preferred Deals. # The terms for preferred deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ },
+ "programmaticGuaranteedTerms": { # Pricing terms for Programmatic Guaranteed Deals. # The terms for programmatic guaranteed deals.
+ "fixedPrice": { # Represents a price and a pricing type for a deal. # Fixed price for the deal.
+ "amount": { # Represents an amount of money with its currency type. # The actual price with currency specified.
+ "currencyCode": "A String", # The three-letter currency code defined in ISO 4217.
+ "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.
+ "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar.
+ },
+ "type": "A String", # The pricing type for the deal.
+ },
+ "guaranteedLooks": "A String", # Count of guaranteed looks. For CPD deals, buyer changes to guaranteed_looks will be ignored.
+ "impressionCap": "A String", # The lifetime impression cap for CPM Sponsorship deals. Deal will stop serving when cap is reached.
+ "minimumDailyLooks": "A String", # Daily minimum looks for CPD deal types. For CPD deals, buyer should negotiate on this field instead of guaranteed_looks.
+ "percentShareOfVoice": "A String", # For sponsorship deals, this is the percentage of the seller's eligible impressions that the deal will serve until the cap is reached. Valid value is within range 0~100.
+ "reservationType": "A String", # The reservation type for a Programmatic Guaranteed deal. This indicates whether the number of impressions is fixed, or a percent of available impressions. If not specified, the default reservation type is STANDARD.
+ },
+ "publisherProfile": "A String", # Required. The profile of the publisher who will receive this RFP in the format: `buyers/{accountId}/publisherProfiles/{publisherProfileId}`.
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # Represents a proposal in the Marketplace. A proposal is the unit of negotiation between a seller and a buyer.
+ "billedBuyer": "A String", # Output only. When the client field is populated, this field refers to the buyer who creates and manages the client buyer and gets billed on behalf of the client buyer; when the buyer field is populated, this field is the same value as buyer. Format : `buyers/{buyerAccountId}`
+ "buyer": "A String", # Output only. Refers to a buyer in The Realtime-bidding API. Format: `buyers/{buyerAccountId}`
+ "buyerContacts": [ # Contact information for the buyer.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "buyerPrivateData": { # Buyers are allowed to store certain types of private data in a proposal or deal. # Buyer private data (hidden from seller).
+ "referenceId": "A String", # A buyer specified reference ID. This can be queried in the list operations (max-length: 1024 unicode code units).
+ },
+ "client": "A String", # Output only. Refers to a Client. Format: `buyers/{buyerAccountId}/clients/{clientAccountid}`
+ "dealType": "A String", # Output only. Type of deal the proposal contains.
+ "displayName": "A String", # Output only. The descriptive name for the proposal. Maximum length of 255 unicode characters is allowed. Control characters are not allowed. Buyers cannot update this field. Note: Not to be confused with name, which is a unique identifier of the proposal.
+ "isRenegotiating": True or False, # Output only. True if the proposal was previously finalized and is now being renegotiated.
+ "lastUpdaterOrCommentorRole": "A String", # Output only. The role of the last user that either updated the proposal or left a comment.
+ "name": "A String", # Immutable. The name of the proposal serving as a unique identifier. Format: buyers/{accountId}/proposals/{proposalId}
+ "notes": [ # A list of notes from the buyer and the seller attached to this proposal.
+ { # A text note attached to the proposal to facilitate the communication between buyers and sellers.
+ "createTime": "A String", # Output only. When this note was created.
+ "creatorRole": "A String", # Output only. The role who created the note.
+ "note": "A String", # The text of the note. Maximum length is 1024 characters.
+ },
+ ],
+ "originatorRole": "A String", # Output only. Indicates whether the buyer/seller created the proposal.
+ "pausingConsented": True or False, # Whether pausing is allowed for the proposal. This is a negotiable term between buyers and publishers.
+ "proposalRevision": "A String", # Output only. The revision number for the proposal. Each update to the proposal or deal causes the proposal revision number to auto-increment. The buyer keeps track of the last revision number they know of and pass it in when making an update. If the head revision number on the server has since incremented, then an ABORTED error is returned during the update operation to let the buyer know that a subsequent update was made.
+ "publisherProfile": "A String", # Immutable. Reference to the seller on the proposal. Format: `buyers/{buyerAccountId}/publisherProfiles/{publisherProfileId}` Note: This field may be set only when creating the resource. Modifying this field while updating the resource will result in an error.
+ "sellerContacts": [ # Output only. Contact information for the seller.
+ { # Contains information on how a buyer or seller can be reached.
+ "displayName": "A String", # The display_name of the contact.
+ "email": "A String", # Email address for the contact.
+ },
+ ],
+ "state": "A String", # Output only. Indicates the state of the proposal.
+ "termsAndConditions": "A String", # Output only. The terms and conditions associated with this proposal. Accepting a proposal implies acceptance of this field. This is created by the seller, the buyer can only view it.
+ "updateTime": "A String", # Output only. The time when the proposal was last revised.
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html
new file mode 100644
index 00000000000..f81b3defa29
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.buyers.publisherProfiles.html
@@ -0,0 +1,203 @@
+
+
+
+Authorized Buyers Marketplace API . buyers . publisherProfiles
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+Gets the requested publisher profile by name.
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
+
+Retrieves the next page of results.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ get(name, x__xgafv=None)
+ Gets the requested publisher profile by name.
+
+Args:
+ name: string, Required. Name of the publisher profile. Format: `buyers/{buyerId}/publisherProfiles/{publisherProfileId}` (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+ "audienceDescription": "A String", # Description on the publisher's audience.
+ "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+ "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+ "A String",
+ ],
+ "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+ "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+ "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+ "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+ { # A mobile application that contains a external app ID, name, and app store.
+ "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+ "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+ "name": "A String", # The name of the app.
+ },
+ ],
+ "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+ "overview": "A String", # Overview of the publisher.
+ "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+ "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+ "samplePageUrl": "A String", # URL to a sample content page.
+ "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+ "A String",
+ ],
+}
+
+
+
+ list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists publisher profiles. The returned publisher profiles aren't in any defined order. The order of the results might change. A new publisher profile can appear in any place in the list of returned results.
+
+Args:
+ parent: string, Required. Parent that owns the collection of publisher profiles Format: `buyers/{buyerId}` (required)
+ filter: string, Optional query string using the [Cloud API list filtering] (https://developers.google.com/authorized-buyers/apis/guides/list-filters) syntax.
+ pageSize: integer, Requested page size. The server may return fewer results than requested. If requested more than 500, the server will return 500 results per page. If unspecified, the server will pick a default page size of 100.
+ pageToken: string, The page token as returned from a previous ListPublisherProfilesResponse.
+ 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 profiles visible to the buyer.
+ "nextPageToken": "A String", # Token to fetch the next page of results.
+ "publisherProfiles": [ # The list of matching publisher profiles.
+ { # The values in the publisher profile are supplied by the publisher. All fields are not filterable unless stated otherwise.
+ "audienceDescription": "A String", # Description on the publisher's audience.
+ "directDealsContact": "A String", # Contact information for direct reservation deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "displayName": "A String", # Display name of the publisher profile. Can be used to filter the response of the publisherProfiles.list method.
+ "domains": [ # The list of domains represented in this publisher profile. Empty if this is a parent profile. These are top private domains, meaning that these will not contain a string like "photos.google.co.uk/123", but will instead contain "google.co.uk". Can be used to filter the response of the publisherProfiles.list method.
+ "A String",
+ ],
+ "isParent": True or False, # Indicates if this profile is the parent profile of the seller. A parent profile represents all the inventory from the seller, as opposed to child profile that is created to brand a portion of inventory. One seller has only one parent publisher profile, and can have multiple child profiles. See https://support.google.com/admanager/answer/6035806 for details. Can be used to filter the response of the publisherProfiles.list method by setting the filter to "is_parent: true".
+ "logoUrl": "A String", # A Google public URL to the logo for this publisher profile. The logo is stored as a PNG, JPG, or GIF image.
+ "mediaKitUrl": "A String", # URL to additional marketing and sales materials.
+ "mobileApps": [ # The list of apps represented in this publisher profile. Empty if this is a parent profile.
+ { # A mobile application that contains a external app ID, name, and app store.
+ "appStore": "A String", # The app store the app belongs to. Can be used to filter the response of the publisherProfiles.list method.
+ "externalAppId": "A String", # The external ID for the app from its app store. Can be used to filter the response of the publisherProfiles.list method.
+ "name": "A String", # The name of the app.
+ },
+ ],
+ "name": "A String", # Name of the publisher profile. Format: `buyers/{buyer}/publisherProfiles/{publisher_profile}`
+ "overview": "A String", # Overview of the publisher.
+ "pitchStatement": "A String", # Statement explaining what's unique about publisher's business, and why buyers should partner with the publisher.
+ "programmaticDealsContact": "A String", # Contact information for programmatic deals. This is free text entered by the publisher and may include information like names, phone numbers and email addresses.
+ "publisherCode": "A String", # A unique identifying code for the seller. This value is the same for all of the seller's parent and child publisher profiles. Can be used to filter the response of the publisherProfiles.list method.
+ "samplePageUrl": "A String", # URL to a sample content page.
+ "topHeadlines": [ # Up to three key metrics and rankings. For example, "#1 Mobile News Site for 20 Straight Months".
+ "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.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/authorizedbuyersmarketplace_v1alpha.html b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html
new file mode 100644
index 00000000000..b2211770e4b
--- /dev/null
+++ b/docs/dyn/authorizedbuyersmarketplace_v1alpha.html
@@ -0,0 +1,116 @@
+
+
+
+Authorized Buyers Marketplace API
+Instance Methods
+
+ bidders()
+
+Returns the bidders Resource.
+
+
+ buyers()
+
+Returns the buyers Resource.
+
+
+ close()
+Close httplib2 connections.
+
+Create a BatchHttpRequest object based on the discovery document.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ new_batch_http_request()
+ Create a BatchHttpRequest object based on the discovery document.
+
+ Args:
+ callback: callable, A callback to be called for each response, of the
+ form callback(id, response, exception). The first parameter is the
+ request id, and the second is the deserialized response object. The
+ third is an apiclient.errors.HttpError exception object if an HTTP
+ error occurred while processing the request, or None if no error
+ occurred.
+
+ Returns:
+ A BatchHttpRequest object based on the discovery document.
+
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
index 744d6089bfd..9eb2465f3d8 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.dataSources.backups.html
@@ -189,6 +189,7 @@ Method Details
"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
"diskSizeGb": "A String", # Optional. The size of the disk in GB.
"diskType": "A String", # Optional. Specifies the type of the disk.
+ "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
"guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
{ # Feature type of the Guest OS.
"type": "A String", # The ID of a supported feature.
@@ -301,7 +302,7 @@ Method Details
],
},
],
- "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.
+ "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
"items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
@@ -405,6 +406,7 @@ Method Details
"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
"diskSizeGb": "A String", # Optional. The size of the disk in GB.
"diskType": "A String", # Optional. Specifies the type of the disk.
+ "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
"guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
{ # Feature type of the Guest OS.
"type": "A String", # The ID of a supported feature.
@@ -517,7 +519,7 @@ Method Details
],
},
],
- "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.
+ "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
"items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
@@ -630,6 +632,7 @@ Method Details
"diskInterface": "A String", # Optional. Specifies the disk interface to use for attaching this disk.
"diskSizeGb": "A String", # Optional. The size of the disk in GB.
"diskType": "A String", # Optional. Specifies the type of the disk.
+ "diskTypeUri": "A String", # Optional. Output only. The URI of the disk type resource. For example: projects/project/zones/zone/diskTypes/pd-standard or pd-ssd
"guestOsFeature": [ # Optional. A list of features to enable on the guest operating system. Applicable only for bootable images.
{ # Feature type of the Guest OS.
"type": "A String", # The ID of a supported feature.
@@ -742,7 +745,7 @@ Method Details
],
},
],
- "sourceInstanceName": "A String", # Name of the source instance at the time of backup. The name is 1-63 characters long, and complies with RFC1035.
+ "sourceInstance": "A String", # The source instance used to create this backup. This can be a partial or full URL to the resource. For example, the following are valid values: -https://www.googleapis.com/compute/v1/projects/project/zones/zone/instances/instance -projects/project/zones/zone/instances/instance
"tags": { # A set of instance tags. # A list of tags to apply to the instances that are created from these properties. The tags identify valid sources or targets for network firewalls. The setTags method can modify this list of tags. Each tag within the list must comply with RFC1035 (https://www.ietf.org/rfc/rfc1035.txt).
"items": [ # Optional. An array of tags. Each tag must be 1-63 characters long, and comply with RFC1035.
"A String",
diff --git a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
index 8245ff0edeb..b79c4ff9268 100644
--- a/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
+++ b/docs/dyn/backupdr_v1.projects.locations.backupVaults.html
@@ -104,7 +104,7 @@ Instance Methods
list_next()
Retrieves the next page of results.
- patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the settings of a BackupVault.
testIamPermissions(resource, body=None, x__xgafv=None)
@@ -386,7 +386,7 @@ Method Details
- patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
+ patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the settings of a BackupVault.
Args:
@@ -417,6 +417,7 @@ Method Details
"updateTime": "A String", # Output only. The time when the instance was updated.
}
+ force: boolean, Optional. If set to true, will not check plan duration against backup vault enforcement duration. Non-standard field.
requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the BackupVault resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then the request will fail.
validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is 'false'.
diff --git a/docs/dyn/bigquery_v2.datasets.html b/docs/dyn/bigquery_v2.datasets.html
index 6a341c28e0d..c52ead555ab 100644
--- a/docs/dyn/bigquery_v2.datasets.html
+++ b/docs/dyn/bigquery_v2.datasets.html
@@ -144,7 +144,7 @@ Method Details
An object of the form:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -226,7 +226,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -246,7 +246,7 @@ Method Details
The object takes the form of:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -328,7 +328,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -346,7 +346,7 @@ Method Details
An object of the form:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -428,7 +428,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -506,7 +506,7 @@ Method Details
The object takes the form of:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -588,7 +588,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -606,7 +606,7 @@ Method Details
An object of the form:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -688,7 +688,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -721,7 +721,7 @@ Method Details
An object of the form:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -803,7 +803,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -824,7 +824,7 @@ Method Details
The object takes the form of:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -906,7 +906,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
@@ -924,7 +924,7 @@ Method Details
An object of the form:
{ # Represents a BigQuery dataset.
- "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER;
+ "access": [ # Optional. An array of objects that define dataset access for one or more entities. You can set this property when inserting or updating a dataset in order to control who is allowed to access the data. If unspecified at dataset creation time, BigQuery adds default dataset access for the following entities: access.specialGroup: projectReaders; access.role: READER; access.specialGroup: projectWriters; access.role: WRITER; access.specialGroup: projectOwners; access.role: OWNER; access.userByEmail: [dataset creator email]; access.role: OWNER; If you patch a dataset, then this field is overwritten by the patched dataset's access field. To add entities, you must supply the entire existing access array in addition to any new entities that you want to add.
{ # An object that defines dataset access for an entity.
"dataset": { # Grants all resources of particular types in a particular dataset read access to the current dataset. Similar to how individually authorized views work, updates to any resource granted through its dataset (including creation of new resources) requires read permission to referenced resources, plus write permission to the authorizing dataset. # [Pick one] A grant authorizing all resources of a particular type in a particular dataset access to this dataset. Only views are supported for now. The role field is not required when this field is set. If that dataset is deleted and re-created, its access needs to be granted again via an update operation.
"dataset": { # Identifier for a dataset. # The dataset this entry applies to
@@ -1006,7 +1006,7 @@ Method Details
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"selfLink": "A String", # Output only. A URL that can be used to access the resource again. You can use this URL in Get or Update requests to the resource.
"storageBillingModel": "A String", # Optional. Updates storage_billing_model for the dataset.
- "tags": [ # Output only. Tags for the Dataset.
+ "tags": [ # Output only. Tags for the dataset. To provide tags as inputs, use the `resourceTags` field.
{ # A global tag managed by Resource Manager. https://cloud.google.com/iam/docs/tags-access-control#definitions
"tagKey": "A String", # Required. The namespaced friendly name of the tag key, e.g. "12345/environment" where 12345 is org id.
"tagValue": "A String", # Required. The friendly short name of the tag value, e.g. "production".
diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html
index 72773ff7108..b4ee3177c07 100644
--- a/docs/dyn/bigquery_v2.jobs.html
+++ b/docs/dyn/bigquery_v2.jobs.html
@@ -561,6 +561,7 @@ Method Details
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
+ "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update.
"endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
"extract": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
@@ -1959,6 +1960,7 @@ Method Details
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
+ "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update.
"endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
"extract": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
@@ -3433,6 +3435,7 @@ Method Details
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
+ "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update.
"endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
"extract": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
@@ -4802,6 +4805,7 @@ Method Details
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
+ "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update.
"endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
"extract": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
@@ -6196,6 +6200,7 @@ Method Details
"dataMaskingStatistics": { # Statistics for data-masking. # Output only. Statistics for data-masking. Present only for query and extract jobs.
"dataMaskingApplied": True or False, # Whether any accessed data was protected by the data masking.
},
+ "edition": "A String", # Output only. Name of edition corresponding to the reservation for this job at the time of this update.
"endTime": "A String", # Output only. End time of this job, in milliseconds since the epoch. This field will be present whenever a job is in the DONE state.
"extract": { # Statistics for an extract job. # Output only. Statistics for an extract job.
"destinationUriFileCounts": [ # Output only. Number of files per destination URI or URI pattern specified in the extract configuration. These values will be in the same order as the URIs specified in the 'destinationUris' field.
diff --git a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
index 0929888f0a9..0034491c9b0 100644
--- a/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
+++ b/docs/dyn/bigtableadmin_v2.projects.instances.tables.html
@@ -227,7 +227,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -277,6 +277,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -372,7 +374,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -422,6 +424,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -600,7 +604,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -650,6 +654,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -820,7 +826,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -870,6 +876,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -956,7 +964,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -1006,6 +1014,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -1042,7 +1052,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -1092,6 +1102,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -1168,7 +1180,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -1218,6 +1230,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
@@ -1313,7 +1327,7 @@ Method Details
"averageColumnsPerRow": 3.14, # How many column qualifiers are present in this column family, averaged over all rows in the table. e.g. For column family "family" in a table with 3 rows: * A row with cells in "family:col" and "other:col" (1 column in "family") * A row with cells in "family:col", "family:other_col", and "other:data" (2 columns in "family") * A row with cells in "other:col" (0 columns in "family", "family" not present) would report (1 + 2 + 0)/3 = 1.5 in this field.
"logicalDataBytes": "A String", # How much space the data in the column family occupies. This is roughly how many bytes would be needed to read the contents of the entire column family (e.g. by streaming all contents out).
},
- "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. INT64(1) > INT64(-1), but STRING("-00001") > STRING("00001). * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
+ "valueType": { # `Type` represents the type of data that is written to, read from, or stored in Bigtable. It is heavily based on the GoogleSQL standard to help maintain familiarity and consistency across products and features. For compatibility with Bigtable's existing untyped APIs, each `Type` includes an `Encoding` which describes how to convert to/from the underlying data. Each encoding also defines the following properties: * Order-preserving: Does the encoded value sort consistently with the original typed value? Note that Bigtable will always sort data based on the raw encoded value, *not* the decoded type. - Example: BYTES values sort in the same order as their raw encodings. - Counterexample: Encoding INT64 as a fixed-width decimal string does *not* preserve sort order when dealing with negative numbers. `INT64(1) > INT64(-1)`, but `STRING("-00001") > STRING("00001)`. * Self-delimiting: If we concatenate two encoded values, can we always tell where the first one ends and the second one begins? - Example: If we encode INT64s to fixed-width STRINGs, the first value will always contain exactly N digits, possibly preceded by a sign. - Counterexample: If we concatenate two UTF-8 encoded STRINGs, we have no way to tell where the first one ends. * Compatibility: Which other systems have matching encoding schemes? For example, does this encoding have a GoogleSQL equivalent? HBase? Java? # The type of data stored in each of this family's cell values, including its full encoding. If omitted, the family only serves raw untyped bytes. For now, only the `Aggregate` type is supported. `Aggregate` can only be set at family creation and is immutable afterwards. If `value_type` is `Aggregate`, written data must be compatible with: * `value_type.input_type` for `AddInput` mutations
"aggregateType": { # A value that combines incremental updates into a summarized value. Data is never directly written or read using type `Aggregate`. Writes will provide either the `input_type` or `state_type`, and reads will always return the `state_type` . # Aggregate
"hllppUniqueCount": { # Computes an approximate unique count over the input values. When using raw data as input, be careful to use a consistent encoding. Otherwise the same value encoded differently could count more than once, or two distinct values could count as identical. Input: Any, or omit for Raw State: TBD Special state conversions: `Int64` (the unique count estimate) # HyperLogLogPlusPlusUniqueCount aggregator.
},
@@ -1363,6 +1377,8 @@ Method Details
"encoding": { # Rules used to convert to/from lower level types. # The encoding to use when converting to/from lower level types.
"utf8Bytes": { # UTF-8 encoding * Order-preserving? Yes (code point order) * Self-delimiting? No * Compatibility? - BigQuery Federation `TEXT` encoding - HBase `Bytes.toBytes` - Java `String#getBytes(StandardCharsets.UTF_8)` # Use `Utf8Bytes` encoding.
},
+ "utf8Raw": { # Deprecated: prefer the equivalent `Utf8Bytes`. # Deprecated: if set, converts to an empty `utf8_bytes`.
+ },
},
},
"structType": { # A structured data value, consisting of fields which map to dynamically typed values. Values of type `Struct` are stored in `Value.array_value` where entries are in the same order and number as `field_types`. # Struct
diff --git a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html
index 9b951663993..f12d788cc46 100644
--- a/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html
+++ b/docs/dyn/certificatemanager_v1.projects.locations.dnsAuthorizations.html
@@ -123,7 +123,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
- "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.
+ "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
"updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization.
}
@@ -219,7 +219,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
- "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.
+ "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
"updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization.
}
@@ -257,7 +257,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
- "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.
+ "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
"updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization.
},
],
@@ -304,7 +304,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # A user-defined name of the dns authorization. DnsAuthorization names must be unique globally and match pattern `projects/*/locations/*/dnsAuthorizations/*`.
- "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location global: FIXED_RECORD.
+ "type": "A String", # Immutable. Type of DnsAuthorization. If unset during resource creation the following default will be used: - in location `global`: FIXED_RECORD, - in other locations: PER_PROJECT_RECORD.
"updateTime": "A String", # Output only. The last update timestamp of a DnsAuthorization.
}
diff --git a/docs/dyn/classroom_v1.courses.announcements.html b/docs/dyn/classroom_v1.courses.announcements.html
index 0d8b5afa2f9..a2858be0b3d 100644
--- a/docs/dyn/classroom_v1.courses.announcements.html
+++ b/docs/dyn/classroom_v1.courses.announcements.html
@@ -317,7 +317,7 @@ Method Details
courseId: string, Required. Identifier of the course. (required)
itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
- attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
+ attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
postId: string, Optional. Deprecated, use item_id instead.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/classroom_v1.courses.courseWork.html b/docs/dyn/classroom_v1.courses.courseWork.html
index f772b9376fa..cb566efb8b4 100644
--- a/docs/dyn/classroom_v1.courses.courseWork.html
+++ b/docs/dyn/classroom_v1.courses.courseWork.html
@@ -427,7 +427,7 @@ Method Details
courseId: string, Required. Identifier of the course. (required)
itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
- attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
+ attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
postId: string, Optional. Deprecated, use item_id instead.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html
index 60dc67f5b2e..db4cef97d3e 100644
--- a/docs/dyn/classroom_v1.courses.courseWorkMaterials.html
+++ b/docs/dyn/classroom_v1.courses.courseWorkMaterials.html
@@ -320,7 +320,7 @@ Method Details
courseId: string, Required. Identifier of the course. (required)
itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id. (required)
addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
- attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
+ attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
postId: string, Optional. Deprecated, use item_id instead.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/classroom_v1.courses.posts.html b/docs/dyn/classroom_v1.courses.posts.html
index ce6012db225..69854c1fe07 100644
--- a/docs/dyn/classroom_v1.courses.posts.html
+++ b/docs/dyn/classroom_v1.courses.posts.html
@@ -99,7 +99,7 @@ Method Details
courseId: string, Required. Identifier of the course. (required)
postId: string, Optional. Deprecated, use item_id instead. (required)
addOnToken: string, Optional. Token that authorizes the request. The token is passed as a query parameter when the user is redirected from Classroom to the add-on's URL. The authorization token is required when neither of the following is true: * The add-on has attachments on the post. * The developer project issuing the request is the same project that created the post.
- attachmentId: string, Optional. The identifier of the attachment. This field is required for student users and optional for teacher users. If not provided in the student case, an error is returned.
+ attachmentId: string, Optional. The identifier of the attachment. This field is required for all requests except when the user is in the [Attachment Discovery iframe](https://developers.google.com/classroom/add-ons/get-started/iframes/attachment-discovery-iframe).
itemId: string, Identifier of the announcement, courseWork, or courseWorkMaterial under which the attachment is attached. This field is required, but is not marked as such while we are migrating from post_id.
x__xgafv: string, V1 error format.
Allowed values
diff --git a/docs/dyn/cloudasset_v1.assets.html b/docs/dyn/cloudasset_v1.assets.html
index e8682327109..74785f6737d 100644
--- a/docs/dyn/cloudasset_v1.assets.html
+++ b/docs/dyn/cloudasset_v1.assets.html
@@ -158,7 +158,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -466,9 +466,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -550,9 +550,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
diff --git a/docs/dyn/cloudasset_v1.v1.html b/docs/dyn/cloudasset_v1.v1.html
index eda1a58ed4b..61088d6130c 100644
--- a/docs/dyn/cloudasset_v1.v1.html
+++ b/docs/dyn/cloudasset_v1.v1.html
@@ -1046,7 +1046,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -1354,9 +1354,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -1438,9 +1438,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -1555,7 +1555,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -1863,9 +1863,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -1947,9 +1947,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
diff --git a/docs/dyn/cloudasset_v1beta1.organizations.html b/docs/dyn/cloudasset_v1beta1.organizations.html
index 00d3ecdd0e0..a26d702ee7d 100644
--- a/docs/dyn/cloudasset_v1beta1.organizations.html
+++ b/docs/dyn/cloudasset_v1beta1.organizations.html
@@ -153,7 +153,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -268,9 +268,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -352,9 +352,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
diff --git a/docs/dyn/cloudasset_v1beta1.projects.html b/docs/dyn/cloudasset_v1beta1.projects.html
index 1ff73a11d59..9c99f0d09c9 100644
--- a/docs/dyn/cloudasset_v1beta1.projects.html
+++ b/docs/dyn/cloudasset_v1beta1.projects.html
@@ -153,7 +153,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -268,9 +268,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -352,9 +352,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
diff --git a/docs/dyn/cloudasset_v1p5beta1.assets.html b/docs/dyn/cloudasset_v1p5beta1.assets.html
index 12bef1eaf69..eca1de91d8e 100644
--- a/docs/dyn/cloudasset_v1p5beta1.assets.html
+++ b/docs/dyn/cloudasset_v1p5beta1.assets.html
@@ -155,7 +155,7 @@ Method Details
],
"vpcNetworkSources": [ # The request must originate from one of the provided VPC networks in Google Cloud. Cannot specify this field together with `ip_subnetworks`.
{ # The originating network source in Google Cloud.
- "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "vpcSubnetwork": { # Sub-segment ranges inside of a VPC Network. # Sub-segment ranges of a VPC network.
"network": "A String", # Required. Network name. If the network is not part of the organization, the `compute.network.get` permission must be granted to the caller. Format: `//compute.googleapis.com/projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}` Example: `//compute.googleapis.com/projects/my-project/global/networks/network-1`
"vpcIpSubnetworks": [ # CIDR block IP subnetwork specification. The IP address must be an IPv4 address and can be a public or private IP address. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. If empty, all IP addresses are allowed.
"A String",
@@ -273,9 +273,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
@@ -357,9 +357,9 @@ Method Details
],
"identityType": "A String", # Specifies the type of identities that are allowed access to outside the perimeter. If left unspecified, then members of `identities` field will be allowed access.
"sourceRestriction": "A String", # Whether to enforce traffic restrictions based on `sources` field. If the `sources` fields is non-empty, then this field must be set to `SOURCE_RESTRICTION_ENABLED`.
- "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "sources": [ # Sources that this EgressPolicy authorizes access from. If this field is not empty, then `source_restriction` must be set to `SOURCE_RESTRICTION_ENABLED`.
{ # The source that EgressPolicy authorizes access from inside the ServicePerimeter to somewhere outside the ServicePerimeter boundaries.
- "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed. TODO (b/332744441): annotate this field with custom_org_policy_accessibility when cl/640698580 will be rolled out.
+ "accessLevel": "A String", # An AccessLevel resource name that allows protected resources inside the ServicePerimeters to access outside the ServicePerimeter boundaries. AccessLevels listed must be in the same policy as this ServicePerimeter. Referencing a nonexistent AccessLevel will cause an error. If an AccessLevel name is not specified, only resources within the perimeter can be accessed through Google Cloud calls with request origins within the perimeter. Example: `accessPolicies/MY_POLICY/accessLevels/MY_LEVEL`. If a single `*` is specified for `access_level`, then all EgressSources will be allowed.
},
],
},
diff --git a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
index a53b33136d5..d0450779025 100644
--- a/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
+++ b/docs/dyn/cloudcontrolspartner_v1.organizations.locations.customers.html
@@ -112,7 +112,7 @@ Method Details
An object of the form:
{ # Contains metadata around a Cloud Controls Partner Customer
- "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps
+ "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
@@ -122,8 +122,8 @@ Method Details
},
],
},
- "displayName": "A String", # The customer organization's display name. E.g. "google.com".
- "isOnboarded": True or False, # Indicates whether a customer is fully onboarded
+ "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com".
+ "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
}
@@ -149,7 +149,7 @@ Method Details
{ # Response message for list customer Customers requests
"customers": [ # List of customers
{ # Contains metadata around a Cloud Controls Partner Customer
- "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps
+ "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
@@ -159,8 +159,8 @@ Method Details
},
],
},
- "displayName": "A String", # The customer organization's display name. E.g. "google.com".
- "isOnboarded": True or False, # Indicates whether a customer is fully onboarded
+ "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com".
+ "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
},
],
diff --git a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html
index eb0754056d8..0a8609c2d8f 100644
--- a/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html
+++ b/docs/dyn/cloudcontrolspartner_v1beta.organizations.locations.customers.html
@@ -112,7 +112,7 @@ Method Details
An object of the form:
{ # Contains metadata around a Cloud Controls Partner Customer
- "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps
+ "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
@@ -122,8 +122,8 @@ Method Details
},
],
},
- "displayName": "A String", # The customer organization's display name. E.g. "google.com".
- "isOnboarded": True or False, # Indicates whether a customer is fully onboarded
+ "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com".
+ "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
}
@@ -149,7 +149,7 @@ Method Details
{ # Response message for list customer Customers requests
"customers": [ # List of customers
{ # Contains metadata around a Cloud Controls Partner Customer
- "customerOnboardingState": { # Container for customer onboarding steps # Container for customer onboarding steps
+ "customerOnboardingState": { # Container for customer onboarding steps # Output only. Container for customer onboarding steps
"onboardingSteps": [ # List of customer onboarding steps
{ # Container for customer onboarding information
"completionState": "A String", # Output only. Current state of the step
@@ -159,8 +159,8 @@ Method Details
},
],
},
- "displayName": "A String", # The customer organization's display name. E.g. "google.com".
- "isOnboarded": True or False, # Indicates whether a customer is fully onboarded
+ "displayName": "A String", # Output only. The customer organization's display name. E.g. "google.com".
+ "isOnboarded": True or False, # Output only. Indicates whether a customer is fully onboarded
"name": "A String", # Identifier. Format: `organizations/{organization}/locations/{location}/customers/{customer}`
},
],
diff --git a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
index 0400c19df2d..b66c01228d6 100644
--- a/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
+++ b/docs/dyn/clouderrorreporting_v1beta1.projects.events.html
@@ -206,7 +206,7 @@ Method Details
"user": "A String", # The user who caused or was affected by the crash. This can be a user ID, an email address, or an arbitrary token that uniquely identifies the user. When sending an error report, leave this field empty if the user was not logged in. In this case the Error Reporting system will use other data, such as remote IP address, to distinguish affected users. See `affected_users_count` in `ErrorGroupStats`.
},
"eventTime": "A String", # Optional. Time when the event occurred. If not provided, the time when the event was received by the Error Reporting system is used. If provided, the time must not exceed the [logs retention period](https://cloud.google.com/logging/quotas#logs_retention_periods) in the past, or be more than 24 hours in the future. If an invalid time is provided, then an error is returned.
- "message": "A String", # Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).
+ "message": "A String", # Required. The error message. If no `context.reportLocation` is provided, the message must contain a header (typically consisting of the exception type name and an error message) and an exception stack trace in one of the supported programming languages and formats. Supported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go. Supported stack trace formats are: * **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29). * **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc). * **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API) as returned by V8. * **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace). * **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx). * **PHP**: Must be prefixed with `"PHP (Notice|Parse error|Fatal error|Warning): "` and contain the result of [`(string)$exception`](https://php.net/manual/en/exception.tostring.php). * **Go**: Must be the return value of [`debug.Stack()`](https://pkg.go.dev/runtime/debug#Stack).
"serviceContext": { # Describes a running service that sends errors. Its version changes over time and multiple versions can run in parallel. # Required. The service context in which this error has occurred.
"resourceType": "A String", # Type of the MonitoredResource. List of possible values: https://cloud.google.com/monitoring/api/resources Value is set automatically for incoming errors and must not be set when reporting errors.
"service": "A String", # An identifier of the service, such as the name of the executable, job, or Google App Engine service name. This field is expected to have a low number of values that are relatively stable over time, as opposed to `version`, which can be changed whenever new code is deployed. Contains the service name for error reports extracted from Google App Engine logs or `default` if the App Engine default service is used.
diff --git a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
index 5a3b311fea1..f0f796c78a6 100644
--- a/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
+++ b/docs/dyn/cloudfunctions_v1.projects.locations.functions.html
@@ -225,7 +225,7 @@ Method Details
"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted.
"deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.
+ "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.
},
"sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
@@ -437,7 +437,7 @@ Method Details
"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted.
"deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.
+ "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.
},
"sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
@@ -585,7 +585,7 @@ Method Details
"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted.
"deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.
+ "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.
},
"sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
@@ -696,7 +696,7 @@ Method Details
"sourceArchiveUrl": "A String", # The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function.
"sourceRepository": { # Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. # **Beta Feature** The source repository where a function is hosted.
"deployedUrl": "A String", # Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.
- "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory.
+ "url": "A String", # The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: `https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*` To refer to a moveable alias (branch): `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` In particular, to refer to HEAD use `master` moveable alias. To refer to a specific fixed alias (tag): `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` You may omit `paths/*` if you want to use the main directory. The function response may add an empty `/paths/` to the URL.
},
"sourceToken": "A String", # Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
"sourceUploadUrl": "A String", # The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl]. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
diff --git a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html
index 8792212b774..1967ebdddc2 100644
--- a/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html
+++ b/docs/dyn/cloudtrace_v2beta1.projects.traceSinks.html
@@ -111,9 +111,9 @@ Method Details
The object takes the form of:
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
}
@@ -127,9 +127,9 @@ Method Details
An object of the form:
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
}
@@ -168,9 +168,9 @@ Method Details
An object of the form:
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
}
@@ -196,9 +196,9 @@ Method Details
"nextPageToken": "A String", # A paginated response where more pages might be available has `next_page_token` set. To get the next set of results, call the same method again using the value of `next_page_token` as `page_token`.
"sinks": [ # A list of sinks.
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
},
@@ -230,9 +230,9 @@ Method Details
The object takes the form of:
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
}
@@ -247,9 +247,9 @@ Method Details
An object of the form:
{ # Describes a sink used to export traces to a BigQuery dataset. The sink must be created within a project.
- "name": "A String", # Required. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
+ "name": "A String", # Identifier. The canonical sink resource name, unique within the project. Must be of the form: projects/[PROJECT_NUMBER]/traceSinks/[SINK_ID]. E.g.: `"projects/12345/traceSinks/my-project-trace-sink"`. Sink identifiers are limited to 256 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.
"outputConfig": { # OutputConfig contains a destination for writing trace data. # Required. The export destination.
- "destination": "A String", # The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
+ "destination": "A String", # Required. The destination for writing trace data. Supported formats include: "bigquery.googleapis.com/projects/[PROJECT_ID]/datasets/[DATASET]"
},
"writerIdentity": "A String", # Output only. A service account name for exporting the data. This field is set by sinks.create and sinks.update. The service account will need to be granted write access to the destination specified in the output configuration, see [Granting access for a resource](/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource). To create tables and to write data, this account needs the `dataEditor` role. Read more about roles in the [BigQuery documentation](https://cloud.google.com/bigquery/docs/access-control). E.g.: "service-00000001@00000002.iam.gserviceaccount.com"
}
diff --git a/docs/dyn/composer_v1.projects.locations.environments.html b/docs/dyn/composer_v1.projects.locations.environments.html
index 537fa162fd9..2a6e2251d38 100644
--- a/docs/dyn/composer_v1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1.projects.locations.environments.html
@@ -347,6 +347,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -685,6 +686,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -869,6 +871,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -1107,6 +1110,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
diff --git a/docs/dyn/composer_v1beta1.projects.locations.environments.html b/docs/dyn/composer_v1beta1.projects.locations.environments.html
index 518a43c16d8..82dd8d0b9b1 100644
--- a/docs/dyn/composer_v1beta1.projects.locations.environments.html
+++ b/docs/dyn/composer_v1beta1.projects.locations.environments.html
@@ -352,6 +352,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -692,6 +693,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -878,6 +880,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
@@ -1118,6 +1121,7 @@ Method Details
"a_key": "A String",
},
"name": "A String", # The resource name of the environment, in the form: "projects/{projectId}/locations/{locationId}/environments/{environmentId}" EnvironmentId must start with a lowercase letter followed by up to 63 lowercase letters, numbers, or hyphens, and cannot end with a hyphen.
+ "satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"state": "A String", # The current state of the environment.
"storageConfig": { # The configuration for data storage in the environment. # Optional. Storage configuration for this environment.
diff --git a/docs/dyn/config_v1.projects.locations.deployments.html b/docs/dyn/config_v1.projects.locations.deployments.html
index 3c7aab9d3ab..14453a45672 100644
--- a/docs/dyn/config_v1.projects.locations.deployments.html
+++ b/docs/dyn/config_v1.projects.locations.deployments.html
@@ -174,8 +174,8 @@ Method Details
"state": "A String", # Output only. Current state of the deployment.
"stateDetail": "A String", # Output only. Additional information regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -402,8 +402,8 @@ Method Details
"state": "A String", # Output only. Current state of the deployment.
"stateDetail": "A String", # Output only. Additional information regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -563,8 +563,8 @@ Method Details
"state": "A String", # Output only. Current state of the deployment.
"stateDetail": "A String", # Output only. Additional information regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -700,8 +700,8 @@ Method Details
"state": "A String", # Output only. Current state of the deployment.
"stateDetail": "A String", # Output only. Additional information regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
diff --git a/docs/dyn/config_v1.projects.locations.deployments.revisions.html b/docs/dyn/config_v1.projects.locations.deployments.revisions.html
index c3cb6a5a466..5e4a1798a03 100644
--- a/docs/dyn/config_v1.projects.locations.deployments.revisions.html
+++ b/docs/dyn/config_v1.projects.locations.deployments.revisions.html
@@ -164,8 +164,8 @@ Method Details
"state": "A String", # Output only. Current state of the revision.
"stateDetail": "A String", # Output only. Additional info regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -245,8 +245,8 @@ Method Details
"state": "A String", # Output only. Current state of the revision.
"stateDetail": "A String", # Output only. Additional info regarding the current state.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # Output only. A blueprint described using Terraform's HashiCorp Configuration Language as a root module.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
diff --git a/docs/dyn/config_v1.projects.locations.previews.html b/docs/dyn/config_v1.projects.locations.previews.html
index 176959165a6..44d4ac2ed8a 100644
--- a/docs/dyn/config_v1.projects.locations.previews.html
+++ b/docs/dyn/config_v1.projects.locations.previews.html
@@ -142,8 +142,8 @@ Method Details
"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
"state": "A String", # Output only. Current state of the preview.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -316,8 +316,8 @@ Method Details
"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
"state": "A String", # Output only. Current state of the preview.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
@@ -403,8 +403,8 @@ Method Details
"serviceAccount": "A String", # Optional. User-specified Service Account (SA) credentials to be used when previewing resources. Format: `projects/{projectID}/serviceAccounts/{serviceAccount}`
"state": "A String", # Output only. Current state of the preview.
"terraformBlueprint": { # TerraformBlueprint describes the source of a Terraform root module which describes the resources and configs to be deployed. # The terraform blueprint to preview.
- "gcsSource": "A String", # Required. URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
- "gitSource": { # A set of files in a Git repository. # Required. URI of a public Git repo.
+ "gcsSource": "A String", # URI of an object in Google Cloud Storage. Format: `gs://{bucket}/{object}` URI may also specify an object version for zipped objects. Format: `gs://{bucket}/{object}#{version}`
+ "gitSource": { # A set of files in a Git repository. # URI of a public Git repo.
"directory": "A String", # Optional. Subdirectory inside the repository. Example: 'staging/my-package'
"ref": "A String", # Optional. Git reference (e.g. branch or tag).
"repo": "A String", # Optional. Repository URL. Example: 'https://github.com/kubernetes/examples.git'
diff --git a/docs/dyn/connectors_v1.projects.locations.connections.html b/docs/dyn/connectors_v1.projects.locations.connections.html
index 0739667e877..495752c1f73 100644
--- a/docs/dyn/connectors_v1.projects.locations.connections.html
+++ b/docs/dyn/connectors_v1.projects.locations.connections.html
@@ -155,6 +155,7 @@ Method Details
The object takes the form of:
{ # Connection represents an instance of connector.
+ "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
@@ -243,6 +244,7 @@ Method Details
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
+ "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
@@ -629,6 +631,7 @@ Method Details
An object of the form:
{ # Connection represents an instance of connector.
+ "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
@@ -717,6 +720,7 @@ Method Details
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
+ "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
@@ -1122,6 +1126,7 @@ Method Details
{ # Response message for ConnectorsService.ListConnections
"connections": [ # Connections.
{ # Connection represents an instance of connector.
+ "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
@@ -1210,6 +1215,7 @@ Method Details
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
+ "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
@@ -1569,6 +1575,7 @@ Method Details
The object takes the form of:
{ # Connection represents an instance of connector.
+ "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
@@ -1657,6 +1664,7 @@ Method Details
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
+ "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
@@ -2149,6 +2157,7 @@ Method Details
],
},
"connection": { # Connection represents an instance of connector. # Output only. Connection details
+ "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.
"authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system.
"additionalVariables": [ # List containing additional auth configs.
{ # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig.
@@ -2237,6 +2246,7 @@ Method Details
"connectorVersionInfraConfig": { # This cofiguration provides infra configs like rate limit threshold which need to be configurable for every connector version # Output only. Infra configs supported by Connector Version.
"connectionRatelimitWindowSeconds": "A String", # Output only. The window used for ratelimiting runtime requests to connections.
"deploymentModel": "A String", # Optional. Indicates whether connector is deployed on GKE/CloudRun
+ "deploymentModelMigrationState": "A String", # Output only. Status of the deployment model migration.
"hpaConfig": { # Autoscaling config for connector deployment system metrics. # Output only. HPA autoscaling config.
"cpuUtilizationThreshold": "A String", # Output only. Percent CPU utilization where HPA triggers autoscaling.
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
diff --git a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
index c098918d86e..677f038795c 100644
--- a/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
+++ b/docs/dyn/connectors_v1.projects.locations.providers.connectors.versions.html
@@ -268,6 +268,7 @@ Method Details
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd.
+ "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model.
"ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits.
"cpu": "A String", # Output only. CPU limit.
@@ -993,6 +994,7 @@ Method Details
"memoryUtilizationThreshold": "A String", # Output only. Percent Memory utilization where HPA triggers autoscaling.
},
"internalclientRatelimitThreshold": "A String", # Max QPS supported for internal requests originating from Connd.
+ "migrateDeploymentModel": True or False, # Indicate whether connector is being migrated to cloud run deployment model.
"ratelimitThreshold": "A String", # Max QPS supported by the connector version before throttling of requests.
"resourceLimits": { # Resource limits defined for connection pods of a given connector type. # System resource limits.
"cpu": "A String", # Output only. CPU limit.
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html
new file mode 100644
index 00000000000..f874c27c39f
--- /dev/null
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html
@@ -0,0 +1,134 @@
+
+
+
+Contact Center AI Insights API . projects . locations . encryptionSpec
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ initialize(name, body=None, x__xgafv=None)
+Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ initialize(name, body=None, x__xgafv=None)
+ Initializes a location-level encryption key specification. An error will be thrown if the location has resources already created before the initialization. Once the encryption specification is initialized at a location, it is immutable and all newly created resources under the location will be encrypted with the existing specification.
+
+Args:
+ name: string, Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # The request to initialize a location-level encryption specification.
+ "encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the kms_key_name is left empty, no encryption will be enforced.
+ "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+ "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+ },
+}
+
+ 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.
+ },
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html
index c702c0ed4fa..5df61e2297b 100644
--- a/docs/dyn/contactcenterinsights_v1.projects.locations.html
+++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html
@@ -79,6 +79,11 @@ Instance Methods
Returns the conversations Resource.
+
+ encryptionSpec()
+
+Returns the encryptionSpec Resource.
+
@@ -107,6 +112,9 @@ Instance Methods
Close httplib2 connections.
+
+ getEncryptionSpec(name, x__xgafv=None)
+Gets location-level encryption key specification.
getSettings(name, x__xgafv=None)
Gets project-level settings.
@@ -119,6 +127,26 @@ Method Details
Close httplib2 connections.
+
+ getEncryptionSpec(name, x__xgafv=None)
+ Gets location-level encryption key specification.
+
+Args:
+ name: string, Required. The name of the encryption spec resource to get. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A customer-managed encryption key specification that can be applied to all created resources (e.g. Conversation).
+ "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by the default Google encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}`
+ "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec
+}
+
+
getSettings(name, x__xgafv=None)
Gets project-level settings.
diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html
index b3502ea1674..fddc1650534 100644
--- a/docs/dyn/container_v1.projects.locations.clusters.html
+++ b/docs/dyn/container_v1.projects.locations.clusters.html
@@ -213,8 +213,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -224,8 +224,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -233,8 +233,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -249,12 +249,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -341,8 +341,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
@@ -396,10 +396,10 @@ Method Details
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
- "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
- "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
- "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+ "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
+ "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
+ "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -426,15 +426,15 @@ Method Details
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
- "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
+ "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
- "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster.
+ "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster.
},
"etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
- "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
- "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
- "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API.
+ "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
+ "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.
},
"id": "A String", # Output only. Unique id for the cluster.
@@ -443,15 +443,15 @@ Method Details
},
"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
- "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
+ "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
- "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
- "podRangeInfo": [ # Output only. [Output only] Information for additional pod range.
+ "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
+ "podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
- "rangeName": "A String", # Output only. [Output only] Name of a range.
- "utilization": 3.14, # Output only. [Output only] The utilization of the range.
+ "rangeName": "A String", # Output only. Name of a range.
+ "utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
@@ -462,7 +462,7 @@ Method Details
"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
- "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
@@ -471,10 +471,10 @@ Method Details
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
- "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster.
+ "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"stackType": "A String", # The IP stack type of the cluster
- "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
+ "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
@@ -484,7 +484,7 @@ Method Details
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
@@ -500,7 +500,7 @@ Method Details
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
- "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
+ "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
@@ -525,12 +525,12 @@ Method Details
},
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.
- "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
+ "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
- "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
+ "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
+ "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
},
@@ -752,7 +752,7 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
- "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
+ "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035.
"tags": [ # List of network tags.
@@ -983,7 +983,7 @@ Method Details
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
- "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+ "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
@@ -993,8 +993,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
@@ -1026,7 +1026,7 @@ Method Details
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -1034,14 +1034,14 @@ Method Details
"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
- "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
+ "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "status": "A String", # [Output only] The status of the nodes in this pool instance.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
- "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "status": "A String", # Output only. The status of the nodes in this pool instance.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
+ "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
@@ -1120,22 +1120,22 @@ Method Details
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
- "status": "A String", # [Output only] The current status of this cluster.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
+ "status": "A String", # Output only. The current status of this cluster.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
- "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
+ "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
- "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
},
"parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
@@ -1158,8 +1158,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -1169,8 +1169,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -1178,8 +1178,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -1194,12 +1194,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -1228,8 +1228,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -1239,8 +1239,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -1248,8 +1248,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -1264,12 +1264,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -1363,8 +1363,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
@@ -1418,10 +1418,10 @@ Method Details
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
- "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
- "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
- "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+ "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
+ "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
+ "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -1448,15 +1448,15 @@ Method Details
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
- "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
+ "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
- "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster.
+ "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster.
},
"etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
- "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
- "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
- "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API.
+ "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
+ "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.
},
"id": "A String", # Output only. Unique id for the cluster.
@@ -1465,15 +1465,15 @@ Method Details
},
"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
- "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
+ "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
- "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
- "podRangeInfo": [ # Output only. [Output only] Information for additional pod range.
+ "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
+ "podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
- "rangeName": "A String", # Output only. [Output only] Name of a range.
- "utilization": 3.14, # Output only. [Output only] The utilization of the range.
+ "rangeName": "A String", # Output only. Name of a range.
+ "utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
@@ -1484,7 +1484,7 @@ Method Details
"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
- "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
@@ -1493,10 +1493,10 @@ Method Details
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
- "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster.
+ "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"stackType": "A String", # The IP stack type of the cluster
- "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
+ "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
@@ -1506,7 +1506,7 @@ Method Details
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
@@ -1522,7 +1522,7 @@ Method Details
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
- "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
+ "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
@@ -1547,12 +1547,12 @@ Method Details
},
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.
- "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
+ "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
- "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
+ "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
+ "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
},
@@ -1774,7 +1774,7 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
- "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
+ "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035.
"tags": [ # List of network tags.
@@ -2005,7 +2005,7 @@ Method Details
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
- "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+ "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
@@ -2015,8 +2015,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
@@ -2048,7 +2048,7 @@ Method Details
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2056,14 +2056,14 @@ Method Details
"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
- "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
+ "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "status": "A String", # [Output only] The status of the nodes in this pool instance.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
- "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "status": "A String", # Output only. The status of the nodes in this pool instance.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
+ "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
@@ -2142,22 +2142,22 @@ Method Details
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
- "status": "A String", # [Output only] The current status of this cluster.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
+ "status": "A String", # Output only. The current status of this cluster.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
- "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
+ "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
- "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
}
@@ -2288,8 +2288,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform). This field is deprecated, min_cpu_platform should be specified using `cloud.google.com/requested-min-cpu-platform` label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
@@ -2343,10 +2343,10 @@ Method Details
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
- "createTime": "A String", # [Output only] The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "currentMasterVersion": "A String", # [Output only] The current software version of the master endpoint.
- "currentNodeCount": 42, # [Output only] The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
- "currentNodeVersion": "A String", # [Output only] Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
+ "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
+ "currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
+ "currentNodeVersion": "A String", # Output only. Deprecated, use [NodePools.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools) instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in `key_name`. Each item is a CloudKMS key resource.
@@ -2373,15 +2373,15 @@ Method Details
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster.
- "endpoint": "A String", # [Output only] The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
+ "endpoint": "A String", # Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at `https://username:password@endpoint/`. See the `masterAuth` property of this resource for username and password information.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
- "clusterTier": "A String", # Output only. [Output only] cluster_tier specifies the premium tier of the cluster.
+ "clusterTier": "A String", # Output only. cluster_tier specifies the premium tier of the cluster.
},
"etag": "A String", # This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
- "expireTime": "A String", # [Output only] The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
- "membership": "A String", # [Output only] The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
- "preRegistered": True or False, # [Output only] Whether the cluster has been registered through the fleet API.
+ "membership": "A String", # Output only. The full resource name of the registered fleet membership of the cluster, in the format `//gkehub.googleapis.com/projects/*/locations/*/memberships/*`.
+ "preRegistered": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A String", # The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.
},
"id": "A String", # Output only. Unique id for the cluster.
@@ -2390,15 +2390,15 @@ Method Details
},
"initialClusterVersion": "A String", # The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "","-": picks the default Kubernetes version
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
- "instanceGroupUrls": [ # Deprecated. Use node_pools.instance_group_urls.
+ "instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
- "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. [Output only] The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
- "podRangeInfo": [ # Output only. [Output only] Information for additional pod range.
+ "additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
+ "podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
- "rangeName": "A String", # Output only. [Output only] Name of a range.
- "utilization": 3.14, # Output only. [Output only] The utilization of the range.
+ "rangeName": "A String", # Output only. Name of a range.
+ "utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
@@ -2409,7 +2409,7 @@ Method Details
"clusterIpv4CidrBlock": "A String", # The IP address range for the cluster pod IPs. If this field is set, then `cluster.cluster_ipv4_cidr` must be left blank. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"clusterSecondaryRangeName": "A String", # The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
- "defaultPodIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "defaultPodIpv4RangeUtilization": 3.14, # Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A String", # The IP address range of the instance IPs in this cluster. This is applicable only if `create_subnetwork` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
@@ -2418,10 +2418,10 @@ Method Details
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A String", # The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
- "servicesIpv6CidrBlock": "A String", # Output only. [Output only] The services IPv6 CIDR block for the cluster.
+ "servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A String", # The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
"stackType": "A String", # The IP stack type of the cluster
- "subnetIpv6CidrBlock": "A String", # Output only. [Output only] The subnet's IPv6 CIDR block used by nodes and pods.
+ "subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A String", # A custom subnetwork name to be used if `create_subnetwork` is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
"tpuIpv4CidrBlock": "A String", # The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when `use_ip_aliases` is true. If unspecified, the range will use the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g. `10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range to use.
"useIpAliases": True or False, # Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
@@ -2431,7 +2431,7 @@ Method Details
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
@@ -2447,7 +2447,7 @@ Method Details
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
- "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
+ "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
@@ -2472,12 +2472,12 @@ Method Details
},
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, `username` will be set to "admin", a random password will be generated, and a client certificate will be issued.
- "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
+ "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
- "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
+ "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
+ "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
},
@@ -2699,7 +2699,7 @@ Method Details
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
},
},
- "nodeIpv4CidrSize": 42, # [Output only] The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
+ "nodeIpv4CidrSize": 42, # Output only. The size of the address space on each node for hosting containers. This is provisioned from within the `container_ipv4_cidr` range. This field will only be set when cluster is in route-based network mode.
"nodePoolAutoConfig": { # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. # The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035.
"tags": [ # List of network tags.
@@ -2930,7 +2930,7 @@ Method Details
},
"etag": "A String", # This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
- "instanceGroupUrls": [ # [Output only] The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
+ "instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
@@ -2940,8 +2940,8 @@ Method Details
"autoRepair": True or False, # A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
"autoUpgrade": True or False, # A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
- "autoUpgradeStartTime": "A String", # [Output only] This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "description": "A String", # [Output only] This field is set when upgrades are about to commence with the description of the upgrade.
+ "autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
@@ -2973,7 +2973,7 @@ Method Details
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A String", # The IP address range for pod IPs in this node pool. Only applicable if `create_pod_range` is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. `/14`) to have a range chosen with a specific netmask. Set to a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `10.96.0.0/14`) to pick a specific range to use. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
- "podIpv4RangeUtilization": 3.14, # Output only. [Output only] The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
+ "podIpv4RangeUtilization": 3.14, # Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
"podRange": "A String", # The ID of the secondary range for pod IPs. If `create_pod_range` is true, this ID is used for the new range. If `create_pod_range` is false, uses an existing secondary range with this ID. Only applicable if `ip_allocation_policy.use_ip_aliases` is true. This field cannot be changed after the node pool has been created.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
@@ -2981,14 +2981,14 @@ Method Details
"tpuTopology": "A String", # Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
- "podIpv4CidrSize": 42, # [Output only] The pod CIDR block size per node in this node pool.
+ "podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "status": "A String", # [Output only] The status of the nodes in this pool instance.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
- "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. [Output only] Update info contains relevant information during a node pool update.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "status": "A String", # Output only. The status of the nodes in this pool instance.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
+ "updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
@@ -3067,22 +3067,22 @@ Method Details
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
- "selfLink": "A String", # [Output only] Server-defined URL for the resource.
- "servicesIpv4Cidr": "A String", # [Output only] The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
+ "selfLink": "A String", # Output only. Server-defined URL for the resource.
+ "servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
- "status": "A String", # [Output only] The current status of this cluster.
- "statusMessage": "A String", # [Output only] Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
+ "status": "A String", # Output only. The current status of this cluster.
+ "statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected.
- "tpuIpv4CidrBlock": "A String", # [Output only] The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
+ "tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
- "zone": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
},
],
"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
@@ -3171,8 +3171,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3182,8 +3182,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3191,8 +3191,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3207,12 +3207,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3249,8 +3249,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3260,8 +3260,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3269,8 +3269,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3285,12 +3285,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3329,8 +3329,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3340,8 +3340,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3349,8 +3349,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3365,12 +3365,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3407,8 +3407,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3418,8 +3418,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3427,8 +3427,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3443,12 +3443,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3467,7 +3467,7 @@ Method Details
"resourceVersion": "A String", # A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a `get()` request to the cluster to get the current resource version and include it with requests to set the policy.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
- "duration": "A String", # [Output only] Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
+ "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "PTnHnMnS".
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. Time format should be in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
@@ -3512,8 +3512,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3523,8 +3523,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3532,8 +3532,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3548,12 +3548,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3572,12 +3572,12 @@ Method Details
"name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
"projectId": "A String", # Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
"update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
- "clientCertificate": "A String", # [Output only] Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
+ "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
- "clientKey": "A String", # [Output only] Base64-encoded private key used by clients to authenticate to the cluster endpoint.
- "clusterCaCertificate": "A String", # [Output only] Base64-encoded public certificate that is the root of trust for the cluster.
+ "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
+ "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
"username": "A String", # The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
},
@@ -3600,8 +3600,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3611,8 +3611,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3620,8 +3620,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3636,12 +3636,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3678,8 +3678,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3689,8 +3689,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3698,8 +3698,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3714,12 +3714,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3759,8 +3759,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3770,8 +3770,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3779,8 +3779,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3795,12 +3795,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3840,8 +3840,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3851,8 +3851,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3860,8 +3860,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3876,12 +3876,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3918,8 +3918,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "detail": "A String", # Detailed operation progress, if available.
- "endTime": "A String", # [Output only] The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "detail": "A String", # Output only. Detailed operation progress, if available.
+ "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"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.
"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.
@@ -3929,8 +3929,8 @@ 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.
},
- "location": "A String", # [Output only] The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
- "name": "A String", # The server-assigned ID for the operation.
+ "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
+ "name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
@@ -3938,8 +3938,8 @@ Method Details
"message": "A String", # Human-friendly representation of the condition
},
],
- "operationType": "A String", # The operation type.
- "progress": { # Information about operation (or operation stage) progress. # Output only. [Output only] Progress information for an operation.
+ "operationType": "A String", # Output only. The operation type.
+ "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
@@ -3954,12 +3954,12 @@ Method Details
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
- "selfLink": "A String", # Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
- "startTime": "A String", # [Output only] The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
- "status": "A String", # The current status of the operation.
+ "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
+ "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
+ "status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use the field error instead.
- "targetLink": "A String", # Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
- "zone": "A String", # The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
+ "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
+ "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}
@@ -3978,10 +3978,10 @@
+ organizations()
+
Returns the organizations Resource.
+ diff --git a/docs/dyn/dataplex_v1.organizations.html b/docs/dyn/dataplex_v1.organizations.html new file mode 100644 index 00000000000..6291692ce3e --- /dev/null +++ b/docs/dyn/dataplex_v1.organizations.html @@ -0,0 +1,91 @@ + + + +
+ locations()
+
Returns the locations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
+ close()
Close httplib2 connections.
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+close()
+ Close httplib2 connections.+
getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+setIamPolicy(resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+testIamPermissions(resource, body=None, x__xgafv=None)
+ Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+ "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ 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 TestIamPermissions method.
+ "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+ "A String",
+ ],
+}
+Returns the encryptionConfigs Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
Updates an Entry.
Args:
- name: string, Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}. (required)
+ name: string, Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}. (required)
body: object, The request body.
The object takes the form of:
-{ # An entry is a representation of a data asset which can be described by various metadata.
- "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
+{ # An entry is a representation of a data resource that can be described by various metadata.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
- "aspectSource": { # AspectSource contains information related to the source system of the Aspect.
- "createTime": "A String", # The create time of the aspect in the source system.
- "updateTime": "A String", # The update time of the aspect in the source system.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
@@ -436,31 +436,31 @@ Method Details
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
- "createTime": "A String", # Output only. The time when the Entry was created.
- "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry.
- "ancestors": [ # Immutable. The ancestors of the Entry in the source system.
- { # Ancestor contains information about individual items in the hierarchy of an Entry.
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
- "createTime": "A String", # The create time of the resource in the source system.
- "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters.
- "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters.
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
- "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.
- "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters.
- "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters.
- "system": "A String", # The name of the source system. The maximum size of the field is 64 characters.
- "updateTime": "A String", # The update time of the resource in the source system.
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
- "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry.
- "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.
- "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
- "updateTime": "A String", # Output only. The time when the Entry was last updated.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
}
allowMissing: boolean, Optional. If set to true and the entry doesn't exist, the service will create it.
@@ -475,12 +475,12 @@ Method Details
Returns:
An object of the form:
- { # An entry is a representation of a data asset which can be described by various metadata.
- "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
+ { # An entry is a representation of a data resource that can be described by various metadata.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
- "aspectSource": { # AspectSource contains information related to the source system of the Aspect.
- "createTime": "A String", # The create time of the aspect in the source system.
- "updateTime": "A String", # The update time of the aspect in the source system.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
@@ -491,31 +491,31 @@ Method Details
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
- "createTime": "A String", # Output only. The time when the Entry was created.
- "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry.
- "ancestors": [ # Immutable. The ancestors of the Entry in the source system.
- { # Ancestor contains information about individual items in the hierarchy of an Entry.
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
- "createTime": "A String", # The create time of the resource in the source system.
- "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters.
- "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters.
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
- "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.
- "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters.
- "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters.
- "system": "A String", # The name of the source system. The maximum size of the field is 64 characters.
- "updateTime": "A String", # The update time of the resource in the source system.
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
- "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry.
- "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.
- "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
- "updateTime": "A String", # Output only. The time when the Entry was last updated.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
}
diff --git a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html
index 6b749d83fed..55d4294c5dc 100644
--- a/docs/dyn/dataplex_v1.projects.locations.entryGroups.html
+++ b/docs/dyn/dataplex_v1.projects.locations.entryGroups.html
@@ -132,7 +132,7 @@ Updates an EntryGroup.
Args:
- name: string, Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
+ name: string, Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}. (required)
body: object, The request body.
The object takes the form of:
@@ -351,7 +351,7 @@ Method Details
"labels": { # Optional. User-defined labels for the EntryGroup.
"a_key": "A String",
},
- "name": "A String", # Output only. The relative resource name of the EntryGroup, of the form: projects/{project_number}/locations/{location_id}/entryGroups/{entry_group_id}.
+ "name": "A String", # Output only. The relative resource name of the EntryGroup, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}.
"uid": "A String", # Output only. System generated globally unique ID for the EntryGroup. If you delete and recreate the EntryGroup with the same name, this ID will be different.
"updateTime": "A String", # Output only. The time when the EntryGroup was last updated.
}
diff --git a/docs/dyn/dataplex_v1.projects.locations.glossaries.html b/docs/dyn/dataplex_v1.projects.locations.glossaries.html
new file mode 100644
index 00000000000..ee78e79fada
--- /dev/null
+++ b/docs/dyn/dataplex_v1.projects.locations.glossaries.html
@@ -0,0 +1,258 @@
+
+
+
+Cloud Dataplex API . projects . locations . glossaries
+Instance Methods
+
+ close()
+Close httplib2 connections.
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+Method Details
+
+ close()
+ Close httplib2 connections.
+
+
+
+ getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)
+ Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ options_requestedPolicyVersion: integer, Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ setIamPolicy(resource, body=None, x__xgafv=None)
+ Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SetIamPolicy method.
+ "policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/). # REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them.
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ },
+ "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used:paths: "bindings, etag"
+}
+
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.A Policy is a collection of bindings. A binding binds one or more members, or principals, to a single role. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role.For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation (https://cloud.google.com/iam/docs/).
+ "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
+ { # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
+ "auditLogConfigs": [ # The configuration for logging of each type of permission.
+ { # Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
+ "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
+ "A String",
+ ],
+ "logType": "A String", # The log type that this config enables.
+ },
+ ],
+ "service": "A String", # Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.
+ },
+ ],
+ "bindings": [ # Associates a list of members, or principals, with a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one principal.The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.
+ { # Associates members, or principals, with a role.
+ "condition": { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec.Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # The condition that is associated with this binding.If the condition evaluates to true, then this binding applies to the current request.If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+ "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
+ "expression": "A String", # Textual representation of an expression in Common Expression Language syntax.
+ "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
+ "title": "A String", # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
+ },
+ "members": [ # Specifies the principals requesting access for a Google Cloud resource. members can have the following values: allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account (https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. group:{emailid}: An email address that represents a Google group. For example, admins@example.com. domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com. principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workforce identity pool. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}: All workforce identities in a group. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All workforce identities with a specific attribute value. principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*: All identities in a workforce identity pool. principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}: A single identity in a workload identity pool. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}: A workload identity pool group. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}: All identities in a workload identity pool with a certain attribute. principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*: All identities in a workload identity pool. deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}: Deleted single identity in a workforce identity pool. For example, deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value.
+ "A String",
+ ],
+ "role": "A String", # Role that is assigned to the list of members, or principals. For example, roles/viewer, roles/editor, or roles/owner.For an overview of the IAM roles and permissions, see the IAM documentation (https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see here (https://cloud.google.com/iam/docs/understanding-roles).
+ },
+ ],
+ "etag": "A String", # etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.
+ "version": 42, # Specifies the format of the policy.Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected.Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: Getting a policy that includes a conditional role binding Adding a conditional role binding to a policy Changing a conditional role binding in a policy Removing any role binding, with or without a condition, from a policy that includes conditionsImportant: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).
+}
+
+
+
+ testIamPermissions(resource, body=None, x__xgafv=None)
+ Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may "fail open" without warning.
+
+Args:
+ resource: string, REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for TestIamPermissions method.
+ "permissions": [ # The set of permissions to check for the resource. Permissions with wildcards (such as * or storage.*) are not allowed. For more information see IAM Overview (https://cloud.google.com/iam/docs/overview#permissions).
+ "A String",
+ ],
+}
+
+ 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 TestIamPermissions method.
+ "permissions": [ # A subset of TestPermissionsRequest.permissions that the caller is allowed.
+ "A String",
+ ],
+}
+
+
+
\ No newline at end of file
diff --git a/docs/dyn/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index ff23ad9057c..e89f7bfd0fb 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -104,6 +104,11 @@ Instance Methods
Returns the entryTypes Resource.
+
+ glossaries()
+
+Returns the glossaries Resource.
+
@@ -114,6 +119,11 @@ Instance Methods
Returns the lakes Resource.
+
+ metadataJobs()
+
+Returns the metadataJobs Resource.
+
@@ -246,12 +256,12 @@ Method Details
Returns:
An object of the form:
- { # An entry is a representation of a data asset which can be described by various metadata.
- "aspects": { # Optional. The Aspects attached to the Entry. The format for the key can be one of the following: {projectId}.{locationId}.{aspectTypeId} (if the aspect is attached directly to the entry) {projectId}.{locationId}.{aspectTypeId}@{path} (if the aspect is attached to an entry's path)
+ { # An entry is a representation of a data resource that can be described by various metadata.
+ "aspects": { # Optional. The aspects that are attached to the entry. Depending on how the aspect is attached to the entry, the format of the aspect key can be one of the following: If the aspect is attached directly to the entry: {project_id_or_number}.{location_id}.{aspect_type_id} If the aspect is attached to an entry's path: {project_id_or_number}.{location_id}.{aspect_type_id}@{path}
"a_key": { # An aspect is a single piece of metadata describing an entry.
- "aspectSource": { # AspectSource contains information related to the source system of the Aspect.
- "createTime": "A String", # The create time of the aspect in the source system.
- "updateTime": "A String", # The update time of the aspect in the source system.
+ "aspectSource": { # Information related to the source system of the aspect. # Optional. Information related to the source system of the aspect.
+ "createTime": "A String", # The time the aspect was created in the source system.
+ "updateTime": "A String", # The time the aspect was last updated in the source system.
},
"aspectType": "A String", # Output only. The resource name of the type used to create this Aspect.
"createTime": "A String", # Output only. The time when the Aspect was created.
@@ -262,31 +272,31 @@ Method Details
"updateTime": "A String", # Output only. The time when the Aspect was last updated.
},
},
- "createTime": "A String", # Output only. The time when the Entry was created.
- "entrySource": { # EntrySource contains information related to the source system of the Entry. # Optional. Information related to the source system for an entry.
- "ancestors": [ # Immutable. The ancestors of the Entry in the source system.
- { # Ancestor contains information about individual items in the hierarchy of an Entry.
+ "createTime": "A String", # Output only. The time when the entry was created in Dataplex.
+ "entrySource": { # Information related to the source system of the data resource that is represented by the entry. # Optional. Information related to the source system of the data resource that is represented by the entry.
+ "ancestors": [ # Immutable. The entries representing the ancestors of the data resource in the source system.
+ { # Information about individual items in the hierarchy that is associated with the data resource.
"name": "A String", # Optional. The name of the ancestor resource.
"type": "A String", # Optional. The type of the ancestor resource.
},
],
- "createTime": "A String", # The create time of the resource in the source system.
- "description": "A String", # Description of the Entry. The maximum size of the field is 2000 characters.
- "displayName": "A String", # User friendly display name. The maximum size of the field is 500 characters.
+ "createTime": "A String", # The time when the resource was created in the source system.
+ "description": "A String", # A description of the data resource. Maximum length is 2,000 characters.
+ "displayName": "A String", # A user-friendly display name. Maximum length is 500 characters.
"labels": { # User-defined labels. The maximum size of keys and values is 128 characters each.
"a_key": "A String",
},
- "location": "A String", # Output only. Location of the resource in the source system. You can search the Entry by this location. By default, this should match the location of the EntryGroup containing this entry. A different value allows capturing the source location for data external to Google Cloud.
- "platform": "A String", # The platform containing the source system. The maximum size of the field is 64 characters.
- "resource": "A String", # The name of the resource in the source system. The maximum size of the field is 4000 characters.
- "system": "A String", # The name of the source system. The maximum size of the field is 64 characters.
- "updateTime": "A String", # The update time of the resource in the source system.
+ "location": "A String", # Output only. Location of the resource in the source system. You can search the entry by this location. By default, this should match the location of the entry group containing this entry. A different value allows capturing the source location for data external to Google Cloud.
+ "platform": "A String", # The platform containing the source system. Maximum length is 64 characters.
+ "resource": "A String", # The name of the resource in the source system. Maximum length is 4,000 characters.
+ "system": "A String", # The name of the source system. Maximum length is 64 characters.
+ "updateTime": "A String", # The time when the resource was last updated in the source system. If the entry exists in the system and its EntrySource has update_time populated, further updates to the EntrySource of the entry must provide incremental updates to its update_time.
},
- "entryType": "A String", # Required. Immutable. The resource name of the EntryType used to create this Entry.
- "fullyQualifiedName": "A String", # Optional. A name for the entry that can reference it in an external system. The maximum size of the field is 4000 characters.
- "name": "A String", # Identifier. The relative resource name of the Entry, of the form: projects/{project}/locations/{location}/entryGroups/{entry_group}/entries/{entry}.
+ "entryType": "A String", # Required. Immutable. The relative resource name of the entry type that was used to create this entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryTypes/{entry_type_id}.
+ "fullyQualifiedName": "A String", # Optional. A name for the entry that can be referenced by an external system. The maximum size of the field is 4000 characters.
+ "name": "A String", # Identifier. The relative resource name of the entry, in the format projects/{project_id_or_number}/locations/{location_id}/entryGroups/{entry_group_id}/entries/{entry_id}.
"parentEntry": "A String", # Optional. Immutable. The resource name of the parent entry.
- "updateTime": "A String", # Output only. The time when the Entry was last updated.
+ "updateTime": "A String", # Output only. The time when the entry was last updated in Dataplex.
}
@@ -313,12 +323,12 @@
+ cancel(name, body=None, x__xgafv=None)
Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
+
+ close()
Close httplib2 connections.
+
+ create(parent, body=None, metadataJobId=None, x__xgafv=None)
Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
+ +Gets a metadata job.
+
+ list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists metadata jobs.
+ +Retrieves the next page of results.
+cancel(name, body=None, x__xgafv=None)
+ Cancels a metadata job.If you cancel a metadata import job that is in progress, the changes in the job might be partially applied. We recommend that you reset the state of the entry groups in your project by running another metadata job that reverts the changes from the canceled job.
+
+Args:
+ name: string, Required. The resource name of the job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Cancel metadata job request.
+}
+
+ 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.+
create(parent, body=None, metadataJobId=None, x__xgafv=None)
+ Creates a metadata job. For example, use a metadata job to import Dataplex Catalog entries and aspects from a third-party system into Dataplex.
+
+Args:
+ parent: string, Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # A metadata job resource.
+ "createTime": "A String", # Output only. The time when the metadata job was created.
+ "importResult": { # Results from a metadata import job. # Output only. Import job result.
+ "createdEntries": "A String", # Output only. The total number of entries that were created.
+ "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+ "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+ "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+ },
+ "importSpec": { # Job specification for a metadata import job # Import job specification.
+ "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+ "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+ "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+ "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+ "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+ "A String",
+ ],
+ "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+ "A String",
+ ],
+ "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+ "A String",
+ ],
+ },
+ "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+ "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+ },
+ "labels": { # Optional. User-defined labels.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+ "status": { # Metadata job status.
+ "completionPercent": 42, # Output only. Progress tracking.
+ "message": "A String", # Output only. Message relating to the progression of a metadata job.
+ "state": "A String", # Output only. State of the metadata job.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ },
+ "type": "A String",
+ "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+ "updateTime": "A String", # Output only. The time when the metadata job was updated.
+}
+
+ metadataJobId: string, Optional. The metadata job ID. If not provided, a unique ID is generated with the prefix metadata-job-.
+ 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.
+ },
+}
+get(name, x__xgafv=None)
+ Gets a metadata job.
+
+Args:
+ name: string, Required. The resource name of the metadata job, in the format projects/{project_id_or_number}/locations/{location_id}/metadataJobs/{metadata_job_id}. (required)
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # A metadata job resource.
+ "createTime": "A String", # Output only. The time when the metadata job was created.
+ "importResult": { # Results from a metadata import job. # Output only. Import job result.
+ "createdEntries": "A String", # Output only. The total number of entries that were created.
+ "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+ "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+ "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+ },
+ "importSpec": { # Job specification for a metadata import job # Import job specification.
+ "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+ "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+ "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+ "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+ "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+ "A String",
+ ],
+ "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+ "A String",
+ ],
+ "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+ "A String",
+ ],
+ },
+ "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+ "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+ },
+ "labels": { # Optional. User-defined labels.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+ "status": { # Metadata job status.
+ "completionPercent": 42, # Output only. Progress tracking.
+ "message": "A String", # Output only. Message relating to the progression of a metadata job.
+ "state": "A String", # Output only. State of the metadata job.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ },
+ "type": "A String",
+ "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+ "updateTime": "A String", # Output only. The time when the metadata job was updated.
+}
+list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)
+ Lists metadata jobs.
+
+Args:
+ parent: string, Required. The resource name of the parent location, in the format projects/{project_id_or_number}/locations/{location_id} (required)
+ filter: string, Optional. Filter request. Filters are case-sensitive. The service supports the following formats: labels.key1 = "value1" labels:key1 name = "value"You can combine filters with AND, OR, and NOT operators.
+ orderBy: string, Optional. The field to sort the results by, either name or create_time. If not specified, the ordering is undefined.
+ pageSize: integer, Optional. The maximum number of metadata jobs to return. The service might return fewer jobs than this value. If unspecified, at most 10 jobs are returned. The maximum value is 1,000.
+ pageToken: string, Optional. The page token received from a previous ListMetadataJobs call. Provide this token to retrieve the subsequent page of results. When paginating, all other parameters that are provided to the ListMetadataJobs request must match the call that provided the page token.
+ x__xgafv: string, V1 error format.
+ Allowed values
+ 1 - v1 error format
+ 2 - v2 error format
+
+Returns:
+ An object of the form:
+
+ { # List metadata jobs response.
+ "metadataJobs": [ # Metadata jobs under the specified parent location.
+ { # A metadata job resource.
+ "createTime": "A String", # Output only. The time when the metadata job was created.
+ "importResult": { # Results from a metadata import job. # Output only. Import job result.
+ "createdEntries": "A String", # Output only. The total number of entries that were created.
+ "deletedEntries": "A String", # Output only. The total number of entries that were deleted.
+ "recreatedEntries": "A String", # Output only. The total number of entries that were recreated.
+ "unchangedEntries": "A String", # Output only. The total number of entries that were unchanged.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ "updatedEntries": "A String", # Output only. The total number of entries that were updated.
+ },
+ "importSpec": { # Job specification for a metadata import job # Import job specification.
+ "aspectSyncMode": "A String", # Required. The sync mode for aspects. Only INCREMENTAL mode is supported for aspects. An aspect is modified only if the metadata import file includes a reference to the aspect in the update_mask field and the aspect_keys field.
+ "entrySyncMode": "A String", # Required. The sync mode for entries. Only FULL mode is supported for entries. All entries in the job's scope are modified. If an entry exists in Dataplex but isn't included in the metadata import file, the entry is deleted when you run the metadata job.
+ "logLevel": "A String", # Optional. The level of logs to write to Cloud Logging for this job.Debug-level logs provide highly-detailed information for troubleshooting, but their increased verbosity could incur additional costs (https://cloud.google.com/stackdriver/pricing) that might not be merited for all jobs.If unspecified, defaults to INFO.
+ "scope": { # A boundary on the scope of impact that the metadata import job can have. # Required. A boundary on the scope of impact that the metadata import job can have.
+ "aspectTypes": [ # Optional. The aspect types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/aspectTypes/{aspect_type_id}. The job modifies only the aspects that belong to these aspect types.If the metadata import file attempts to modify an aspect whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an aspect type must either match the location of the job, or the aspect type must be global.
+ "A String",
+ ],
+ "entryGroups": [ # Required. The entry group that is in scope for the import job, specified as a relative resource name in the format projects/{project_number_or_id}/locations/{location_id}/entryGroups/{entry_group_id}. Only entries that belong to the specified entry group are affected by the job.Must contain exactly one element. The entry group and the job must be in the same location.
+ "A String",
+ ],
+ "entryTypes": [ # Required. The entry types that are in scope for the import job, specified as relative resource names in the format projects/{project_number_or_id}/locations/{location_id}/entryTypes/{entry_type_id}. The job modifies only the entries that belong to these entry types.If the metadata import file attempts to modify an entry whose type isn't included in this list, the import job is halted before modifying any entries or aspects.The location of an entry type must either match the location of the job, or the entry type must be global.
+ "A String",
+ ],
+ },
+ "sourceCreateTime": "A String", # Optional. The time when the process that created the metadata import files began.
+ "sourceStorageUri": "A String", # Optional. The URI of a Cloud Storage bucket or folder (beginning with gs:// and ending with /) that contains the metadata import files for this job.A metadata import file defines the values to set for each of the entries and aspects in a metadata job. For more information about how to create a metadata import file and the file requirements, see Metadata import file (https://cloud.google.com/dataplex/docs/import-metadata#metadata-import-file).You can provide multiple metadata import files in the same metadata job. The bucket or folder must contain at least one metadata import file, in JSON Lines format (either .json or .jsonl file extension).In FULL entry sync mode, don't save the metadata import file in a folder named SOURCE_STORAGE_URI/deletions/.Caution: If the metadata import file contains no data, all entries and aspects that belong to the job's scope are deleted.
+ },
+ "labels": { # Optional. User-defined labels.
+ "a_key": "A String",
+ },
+ "name": "A String", # Output only. The name of the resource that the configuration is applied to, in the format projects/{project_number}/locations/{location_id}/metadataJobs/{metadata_job_id}.
+ "status": { # Metadata job status.
+ "completionPercent": 42, # Output only. Progress tracking.
+ "message": "A String", # Output only. Message relating to the progression of a metadata job.
+ "state": "A String", # Output only. State of the metadata job.
+ "updateTime": "A String", # Output only. The time when the status was updated.
+ },
+ "type": "A String",
+ "uid": "A String", # Output only. A system-generated, globally unique ID for the metadata job. If the metadata job is deleted and then re-created with the same name, this ID is different.
+ "updateTime": "A String", # Output only. The time when the metadata job was updated.
+ },
+ ],
+ "nextPageToken": "A String", # A token to retrieve the next page of results. If there are no more results in the list, the value is empty.
+ "unreachableLocations": [ # Locations that the service couldn't reach.
+ "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. ++
Returns the groundingConfigs Resource.
+ +Returns the identity_mapping_stores Resource.
+ diff --git a/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html new file mode 100644 index 00000000000..2aebaab5a22 --- /dev/null +++ b/docs/dyn/discoveryengine_v1.projects.locations.identity_mapping_stores.html @@ -0,0 +1,91 @@ + + + +
+ operations()
+
Returns the operations Resource.
+ +
+ close()
Close httplib2 connections.
+close()
+ Close httplib2 connections.+
fetchDomainVerificationStatus_next()
Retrieves the next page of results.
+
+ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None)
Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
recrawlUris(siteSearchEngine, body=None, x__xgafv=None)
Request on-demand recrawl for a list of URIs.
+
+ setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None)
Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
batchVerifyTargetSites(parent, body=None, x__xgafv=None)
@@ -291,6 +297,29 @@ getUriPatternDocumentData(siteSearchEngine, x__xgafv=None)
+ Gets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+ siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+ 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 SiteSearchEngineService.GetUriPatternDocumentData method.
+ "documentDataMap": { # Document data keyed by URI pattern. For example: document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+}
+recrawlUris(siteSearchEngine, body=None, x__xgafv=None)
Request on-demand recrawl for a list of URIs. @@ -335,4 +364,54 @@Method Details
}
setUriPatternDocumentData(siteSearchEngine, body=None, x__xgafv=None)
+ Sets the URI Pattern to Document data mapping for an Advanced Site Search DataStore.
+
+Args:
+ siteSearchEngine: string, Required. Full resource name of the SiteSearchEngine, such as `projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine`. (required)
+ body: object, The request body.
+ The object takes the form of:
+
+{ # Request message for SiteSearchEngineService.SetUriPatternDocumentData method.
+ "documentDataMap": { # Document data keyed by URI pattern. Each entry must be consistent with the Schema. For example: Schema = { "type": "object", "properties": { "Categories": { "type": "array", "items": { "retrievable": true, "type": "string" } } } document_data_map = { "www.url1.com/*": { "Categories": ["category1", "category2"] }, "www.url2.com/*": { "Categories": ["category3"] } }
+ "a_key": {
+ "a_key": "", # Properties of the object.
+ },
+ },
+ "emptyDocumentDataMap": True or False, # If true, clears the document data map. If true, SetUriPatternDocumentDataRequest.document_data_map must be empty.
+ "schema": { # Optional. If not provided, the current Schema is used. If provided, validates and updates the Schema. If validation fails, an error is returned.
+ "a_key": "", # Properties of the object.
+ },
+}
+
+ 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.
+ },
+}
+