openapi-directory/api/googleapis.com/analyticshub.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://analyticshub.googleapis.com/"}],"x-hasEquivalentPaths":true,"info":{"contact":{"name":"Google","url":"https://google.com","x-twitter":"youtube"},"description":"Exchange data and analytics assets securely and efficiently.","license":{"name":"Creative Commons Attribution 3.0","url":"http://creativecommons.org/licenses/by/3.0/"},"termsOfService":"https://developers.google.com/terms/","title":"Analytics Hub API","version":"v1","x-apisguru-categories":["analytics","media"],"x-logo":{"url":"https://upload.wikimedia.org/wikipedia/commons/e/e1/YouTube_play_buttom_icon_%282013-2017%29.svg"},"x-origin":[{"format":"google","url":"https://analyticshub.googleapis.com/$discovery/rest?version=v1","version":"v1"}],"x-preferred":true,"x-providerName":"googleapis.com","x-serviceName":"analyticshub"},"externalDocs":{"url":"https://cloud.google.com/bigquery/docs/analytics-hub-introduction"},"tags":[{"name":"organizations"},{"name":"projects"}],"paths":{"/v1/{name}":{"delete":{"description":"Deletes a subscription.","operationId":"analyticshub.projects.locations.subscriptions.delete","parameters":[{"description":"Required. Resource name of the subscription to delete. e.g. projects/123/locations/US/subscriptions/456","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"get":{"description":"Gets the details of a Subscription.","operationId":"analyticshub.projects.locations.subscriptions.get","parameters":[{"description":"Required. Resource name of the subscription. e.g. projects/123/locations/US/subscriptions/456","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"patch":{"description":"Updates an existing listing.","operationId":"analyticshub.projects.locations.dataExchanges.listings.patch","parameters":[{"description":"Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Required. Field mask specifies the fields to update in the listing resource. The fields specified in the `updateMask` are relative to the resource and are not a full request.","in":"query","name":"updateMask","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:refresh":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Refreshes a Subscription to a Data Exchange. A Data Exchange can become stale when a publisher adds or removes data. This is a long-running operation as it may create many linked datasets.","operationId":"analyticshub.projects.locations.subscriptions.refresh","parameters":[{"description":"Required. Resource name of the Subscription to refresh. e.g. `projects/subscriberproject/locations/US/subscriptions/123`","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Operation"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:revoke":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Revokes a given subscription.","operationId":"analyticshub.projects.locations.subscriptions.revoke","parameters":[{"description":"Required. Resource name of the subscription to revoke. e.g. projects/123/locations/US/subscriptions/456","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeSubscriptionRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokeSubscriptionResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{name}:subscribe":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Subscribes to a listing. Currently, with Analytics Hub, you can create listings that reference only BigQuery datasets. Upon subscription to a listing for a BigQuery dataset, Analytics Hub creates a linked dataset in the subscriber's project.","operationId":"analyticshub.projects.locations.dataExchanges.listings.subscribe","parameters":[{"description":"Required. Resource name of the listing that you want to subscribe to. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`.","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeListingRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscribeListingResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{organization}/dataExchanges":{"get":{"description":"Lists all data exchanges from projects in a given organization and location.","operationId":"analyticshub.organizations.locations.dataExchanges.list","parameters":[{"description":"Required. The organization resource path of the projects containing DataExchanges. e.g. `organizations/myorg/locations/US`.","in":"path","name":"organization","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgDataExchangesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["organizations"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{parent}/dataExchanges":{"get":{"description":"Lists all data exchanges in a given project and location.","operationId":"analyticshub.projects.locations.dataExchanges.list","parameters":[{"description":"Required. The parent resource path of the data exchanges. e.g. `projects/myproject/locations/US`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDataExchangesResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new data exchange.","operationId":"analyticshub.projects.locations.dataExchanges.create","parameters":[{"description":"Required. The parent resource path of the data exchange. e.g. `projects/myproject/locations/US`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the data exchange. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.","in":"query","name":"dataExchangeId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataExchange"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DataExchange"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/listings":{"get":{"description":"Lists all listings in a given project and location.","operationId":"analyticshub.projects.locations.dataExchanges.listings.list","parameters":[{"description":"Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The maximum number of results to return in a single response page. Leverage the page tokens to iterate through the entire collection.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call, to request the next page of results.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListListingsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Creates a new listing.","operationId":"analyticshub.projects.locations.dataExchanges.listings.create","parameters":[{"description":"Required. The parent resource path of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123`.","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"Required. The ID of the listing to create. Must contain only Unicode letters, numbers (0-9), underscores (_). Should not use characters that require URL-escaping, or characters outside of ASCII, spaces. Max length: 100 bytes.","in":"query","name":"listingId","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Listing"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{parent}/subscriptions":{"get":{"description":"Lists all subscriptions in a given project and location.","operationId":"analyticshub.projects.locations.subscriptions.list","parameters":[{"description":"Required. The parent resource path of the subscription. e.g. projects/myproject/locations/US","in":"path","name":"parent","required":true,"schema":{"type":"string"}},{"description":"The filter expression may be used to filter by Data Exchange or Listing.","in":"query","name":"filter","schema":{"type":"string"}},{"description":"The maximum number of results to return in a single response page.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSubscriptionsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{resource}:getIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Gets the IAM policy.","operationId":"analyticshub.projects.locations.subscriptions.getIamPolicy","parameters":[{"description":"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.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetIamPolicyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:listSubscriptions":{"get":{"description":"Lists all subscriptions on a given Data Exchange or Listing.","operationId":"analyticshub.projects.locations.dataExchanges.listings.listSubscriptions","parameters":[{"description":"Required. Resource name of the requested target. This resource may be either a Listing or a DataExchange. e.g. projects/123/locations/US/dataExchanges/456 OR e.g. projects/123/locations/US/dataExchanges/456/listings/789","in":"path","name":"resource","required":true,"schema":{"type":"string"}},{"description":"If selected, includes deleted subscriptions in the response (up to 63 days after deletion).","in":"query","name":"includeDeletedSubscriptions","schema":{"type":"boolean"}},{"description":"The maximum number of results to return in a single response page.","in":"query","name":"pageSize","schema":{"type":"integer"}},{"description":"Page token, returned by a previous call.","in":"query","name":"pageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSharedResourceSubscriptionsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]},"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}]},"/v1/{resource}:setIamPolicy":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Sets the IAM policy.","operationId":"analyticshub.projects.locations.subscriptions.setIamPolicy","parameters":[{"description":"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.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetIamPolicyRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Policy"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}},"/v1/{resource}:testIamPermissions":{"parameters":[{"$ref":"#/components/parameters/_.xgafv"},{"$ref":"#/components/parameters/access_token"},{"$ref":"#/components/parameters/alt"},{"$ref":"#/components/parameters/callback"},{"$ref":"#/components/parameters/fields"},{"$ref":"#/components/parameters/key"},{"$ref":"#/components/parameters/oauth_token"},{"$ref":"#/components/parameters/prettyPrint"},{"$ref":"#/components/parameters/quotaUser"},{"$ref":"#/components/parameters/upload_protocol"},{"$ref":"#/components/parameters/uploadType"}],"post":{"description":"Returns the permissions that a caller has.","operationId":"analyticshub.projects.locations.dataExchanges.listings.testIamPermissions","parameters":[{"description":"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.","in":"path","name":"resource","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsRequest"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestIamPermissionsResponse"}}},"description":"Successful response"}},"security":[{"Oauth2":["https://www.googleapis.com/auth/bigquery"],"Oauth2c":["https://www.googleapis.com/auth/bigquery"]},{"Oauth2":["https://www.googleapis.com/auth/cloud-platform"],"Oauth2c":["https://www.googleapis.com/auth/cloud-platform"]}],"tags":["projects"]}}},"components":{"parameters":{"_.xgafv":{"description":"V1 error format.","in":"query","name":"$.xgafv","schema":{"enum":["1","2"],"type":"string"}},"access_token":{"description":"OAuth access token.","in":"query","name":"access_token","schema":{"type":"string"}},"alt":{"description":"Data format for response.","in":"query","name":"alt","schema":{"enum":["json","media","proto"],"type":"string"}},"callback":{"description":"JSONP","in":"query","name":"callback","schema":{"type":"string"}},"fields":{"description":"Selector specifying which fields to include in a partial response.","in":"query","name":"fields","schema":{"type":"string"}},"key":{"description":"API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.","in":"query","name":"key","schema":{"type":"string"}},"oauth_token":{"description":"OAuth 2.0 token for the current user.","in":"query","name":"oauth_token","schema":{"type":"string"}},"prettyPrint":{"description":"Returns response with indentations and line breaks.","in":"query","name":"prettyPrint","schema":{"type":"boolean"}},"quotaUser":{"description":"Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.","in":"query","name":"quotaUser","schema":{"type":"string"}},"uploadType":{"description":"Legacy upload protocol for media (e.g. \"media\", \"multipart\").","in":"query","name":"uploadType","schema":{"type":"string"}},"upload_protocol":{"description":"Upload protocol for media (e.g. \"raw\", \"multipart\").","in":"query","name":"upload_protocol","schema":{"type":"string"}}},"schemas":{"AuditConfig":{"description":"Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { \"audit_configs\": [ { \"service\": \"allServices\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\", \"exempted_members\": [ \"user:jose@example.com\" ] }, { \"log_type\": \"DATA_WRITE\" }, { \"log_type\": \"ADMIN_READ\" } ] }, { \"service\": \"sampleservice.googleapis.com\", \"audit_log_configs\": [ { \"log_type\": \"DATA_READ\" }, { \"log_type\": \"DATA_WRITE\", \"exempted_members\": [ \"user:aliya@example.com\" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts `jose@example.com` from DATA_READ logging, and `aliya@example.com` from DATA_WRITE logging.","properties":{"auditLogConfigs":{"description":"The configuration for logging of each type of permission.","items":{"$ref":"#/components/schemas/AuditLogConfig"},"type":"array"},"service":{"description":"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.","type":"string"}},"type":"object"},"AuditLogConfig":{"description":"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.","properties":{"exemptedMembers":{"description":"Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.","items":{"type":"string"},"type":"array"},"logType":{"description":"The log type that this config enables.","enum":["LOG_TYPE_UNSPECIFIED","ADMIN_READ","DATA_WRITE","DATA_READ"],"type":"string"}},"type":"object"},"BigQueryDatasetSource":{"description":"A reference to a shared dataset. It is an existing BigQuery dataset with a collection of objects such as tables and views that you want to share with subscribers. When subscriber's subscribe to a listing, Analytics Hub creates a linked dataset in the subscriber's project. A Linked dataset is an opaque, read-only BigQuery dataset that serves as a _symbolic link_ to a shared dataset.","properties":{"dataset":{"description":"Resource name of the dataset source for this listing. e.g. `projects/myproject/datasets/123`","type":"string"}},"type":"object"},"Binding":{"description":"Associates `members`, or principals, with a `role`.","properties":{"condition":{"$ref":"#/components/schemas/Expr","description":"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)."},"members":{"description":"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`.","items":{"type":"string"},"type":"array"},"role":{"description":"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).","type":"string"}},"type":"object"},"DataExchange":{"description":"A data exchange is a container that lets you share data. Along with the descriptive information about the data exchange, it contains listings that reference shared datasets.","properties":{"description":{"description":"Optional. Description of the data exchange. The description must not contain Unicode non-characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.","type":"string"},"displayName":{"description":"Required. Human-readable display name of the data exchange. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and must not start or end with spaces. Default value is an empty string. Max length: 63 bytes.","type":"string"},"documentation":{"description":"Optional. Documentation describing the data exchange.","type":"string"},"icon":{"description":"Optional. Base64 encoded image representing the data exchange. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the content of the fields are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.","format":"byte","type":"string"},"listingCount":{"description":"Output only. Number of listings contained in the data exchange.","format":"int32","readOnly":true,"type":"integer"},"name":{"description":"Output only. The resource name of the data exchange. e.g. `projects/myproject/locations/US/dataExchanges/123`.","readOnly":true,"type":"string"},"primaryContact":{"description":"Optional. Email or URL of the primary point of contact of the data exchange. Max Length: 1000 bytes.","type":"string"},"sharingEnvironmentConfig":{"$ref":"#/components/schemas/SharingEnvironmentConfig","description":"Optional. Configurable data sharing environment option for a data exchange."}},"type":"object"},"DataProvider":{"description":"Contains details of the data provider.","properties":{"name":{"description":"Optional. Name of the data provider.","type":"string"},"primaryContact":{"description":"Optional. Email or URL of the data provider. Max Length: 1000 bytes.","type":"string"}},"type":"object"},"DcrExchangeConfig":{"description":"Data Clean Room (DCR), used for privacy-safe and secured data sharing.","properties":{"singleLinkedDatasetPerCleanroom":{"description":"Output only. If True, when subscribing to this DCR, it will create only one linked dataset containing all resources shared within the cleanroom. If False, when subscribing to this DCR, it will create 1 linked dataset per listing. This is not configurable, and by default, all new DCRs will have the restriction set to True.","readOnly":true,"type":"boolean"},"singleSelectedResourceSharingRestriction":{"description":"Output only. If True, this DCR restricts the contributors to sharing only a single resource in a Listing. And no two resources should have the same IDs. So if a contributor adds a view with a conflicting name, the CreateListing API will reject the request. if False, the data contributor can publish an entire dataset (as before). This is not configurable, and by default, all new DCRs will have the restriction set to True.","readOnly":true,"type":"boolean"}},"type":"object"},"DefaultExchangeConfig":{"description":"Default Analytics Hub data exchange, used for secured data sharing.","properties":{},"type":"object"},"DestinationDataset":{"description":"Defines the destination bigquery dataset.","properties":{"datasetReference":{"$ref":"#/components/schemas/DestinationDatasetReference","description":"Required. A reference that identifies the destination dataset."},"description":{"description":"Optional. A user-friendly description of the dataset.","type":"string"},"friendlyName":{"description":"Optional. A descriptive name for the dataset.","type":"string"},"labels":{"additionalProperties":{"type":"string"},"description":"Optional. The labels associated with this dataset. You can use these to organize and group your datasets. You can set this property when inserting or updating a dataset. See https://cloud.google.com/resource-manager/docs/creating-managing-labels for more information.","type":"object"},"location":{"description":"Required. The geographic location where the dataset should reside. See https://cloud.google.com/bigquery/docs/locations for supported locations.","type":"string"}},"type":"object"},"DestinationDatasetReference":{"description":"Contains the reference that identifies a destination bigquery dataset.","properties":{"datasetId":{"description":"Required. A unique ID for this dataset, without the project name. The ID must contain only letters (a-z, A-Z), numbers (0-9), or underscores (_). The maximum length is 1,024 characters.","type":"string"},"projectId":{"description":"Required. The ID of the project containing this dataset.","type":"string"}},"type":"object"},"Empty":{"description":"A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }","properties":{},"type":"object"},"Expr":{"description":"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.","properties":{"description":{"description":"Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.","type":"string"},"expression":{"description":"Textual representation of an expression in Common Expression Language syntax.","type":"string"},"location":{"description":"Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.","type":"string"},"title":{"description":"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.","type":"string"}},"type":"object"},"GetIamPolicyRequest":{"description":"Request message for `GetIamPolicy` method.","properties":{"options":{"$ref":"#/components/schemas/GetPolicyOptions","description":"OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."}},"type":"object"},"GetPolicyOptions":{"description":"Encapsulates settings provided to GetIamPolicy.","properties":{"requestedPolicyVersion":{"description":"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).","format":"int32","type":"integer"}},"type":"object"},"LinkedResource":{"description":"Reference to a linked resource tracked by this Subscription.","properties":{"linkedDataset":{"description":"Output only. Name of the linked dataset, e.g. projects/subscriberproject/datasets/linked_dataset","readOnly":true,"type":"string"}},"type":"object"},"ListDataExchangesResponse":{"description":"Message for response to the list of data exchanges.","properties":{"dataExchanges":{"description":"The list of data exchanges.","items":{"$ref":"#/components/schemas/DataExchange"},"type":"array"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"}},"type":"object"},"ListListingsResponse":{"description":"Message for response to the list of Listings.","properties":{"listings":{"description":"The list of Listing.","items":{"$ref":"#/components/schemas/Listing"},"type":"array"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"}},"type":"object"},"ListOrgDataExchangesResponse":{"description":"Message for response to listing data exchanges in an organization and location.","properties":{"dataExchanges":{"description":"The list of data exchanges.","items":{"$ref":"#/components/schemas/DataExchange"},"type":"array"},"nextPageToken":{"description":"A token to request the next page of results.","type":"string"}},"type":"object"},"ListSharedResourceSubscriptionsResponse":{"description":"Message for response to the listing of shared resource subscriptions.","properties":{"nextPageToken":{"description":"Next page token.","type":"string"},"sharedResourceSubscriptions":{"description":"The list of subscriptions.","items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}},"type":"object"},"ListSubscriptionsResponse":{"description":"Message for response to the listing of subscriptions.","properties":{"nextPageToken":{"description":"Next page token.","type":"string"},"subscriptions":{"description":"The list of subscriptions.","items":{"$ref":"#/components/schemas/Subscription"},"type":"array"}},"type":"object"},"Listing":{"description":"A listing is what gets published into a data exchange that a subscriber can subscribe to. It contains a reference to the data source along with descriptive information that will help subscribers find and subscribe the data.","properties":{"bigqueryDataset":{"$ref":"#/components/schemas/BigQueryDatasetSource","description":"Required. Shared dataset i.e. BigQuery dataset source."},"categories":{"description":"Optional. Categories of the listing. Up to two categories are allowed.","items":{"enum":["CATEGORY_UNSPECIFIED","CATEGORY_OTHERS","CATEGORY_ADVERTISING_AND_MARKETING","CATEGORY_COMMERCE","CATEGORY_CLIMATE_AND_ENVIRONMENT","CATEGORY_DEMOGRAPHICS","CATEGORY_ECONOMICS","CATEGORY_EDUCATION","CATEGORY_ENERGY","CATEGORY_FINANCIAL","CATEGORY_GAMING","CATEGORY_GEOSPATIAL","CATEGORY_HEALTHCARE_AND_LIFE_SCIENCE","CATEGORY_MEDIA","CATEGORY_PUBLIC_SECTOR","CATEGORY_RETAIL","CATEGORY_SPORTS","CATEGORY_SCIENCE_AND_RESEARCH","CATEGORY_TRANSPORTATION_AND_LOGISTICS","CATEGORY_TRAVEL_AND_TOURISM"],"type":"string"},"type":"array"},"dataProvider":{"$ref":"#/components/schemas/DataProvider","description":"Optional. Details of the data provider who owns the source data."},"description":{"description":"Optional. Short description of the listing. The description must not contain Unicode non-characters and C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). Default value is an empty string. Max length: 2000 bytes.","type":"string"},"displayName":{"description":"Required. Human-readable display name of the listing. The display name must contain only Unicode letters, numbers (0-9), underscores (_), dashes (-), spaces ( ), ampersands (&) and can't start or end with spaces. Default value is an empty string. Max length: 63 bytes.","type":"string"},"documentation":{"description":"Optional. Documentation describing the listing.","type":"string"},"icon":{"description":"Optional. Base64 encoded image representing the listing. Max Size: 3.0MiB Expected image dimensions are 512x512 pixels, however the API only performs validation on size of the encoded data. Note: For byte fields, the contents of the field are base64-encoded (which increases the size of the data by 33-36%) when using JSON on the wire.","format":"byte","type":"string"},"name":{"description":"Output only. The resource name of the listing. e.g. `projects/myproject/locations/US/dataExchanges/123/listings/456`","readOnly":true,"type":"string"},"primaryContact":{"description":"Optional. Email or URL of the primary point of contact of the listing. Max Length: 1000 bytes.","type":"string"},"publisher":{"$ref":"#/components/schemas/Publisher","description":"Optional. Details of the publisher who owns the listing and who can share the source data."},"requestAccess":{"description":"Optional. Email or URL of the request access of the listing. Subscribers can use this reference to request access. Max Length: 1000 bytes.","type":"string"},"restrictedExportConfig":{"$ref":"#/components/schemas/RestrictedExportConfig","description":"Optional. If set, restricted export configuration will be propagated and enforced on the linked dataset."},"state":{"description":"Output only. Current state of the listing.","enum":["STATE_UNSPECIFIED","ACTIVE"],"readOnly":true,"type":"string"}},"type":"object"},"Operation":{"description":"This resource represents a long-running operation that is the result of a network API call.","properties":{"done":{"description":"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.","type":"boolean"},"error":{"$ref":"#/components/schemas/Status","description":"The error result of the operation in case of failure or cancellation."},"metadata":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"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.","type":"object"},"name":{"description":"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}`.","type":"string"},"response":{"additionalProperties":{"description":"Properties of the object. Contains field @type with type URL."},"description":"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`.","type":"object"}},"type":"object"},"OperationMetadata":{"description":"Represents the metadata of a long-running operation in Analytics Hub.","properties":{"apiVersion":{"description":"Output only. API version used to start the operation.","readOnly":true,"type":"string"},"createTime":{"description":"Output only. The time the operation was created.","format":"google-datetime","readOnly":true,"type":"string"},"endTime":{"description":"Out