Manage data exchanges

Console

Go to the Analytics Hub API page and enable the Analytics Hub API for your Google Cloud project.

Enable the Analytics Hub API

gcloud

Run the gcloud services enable command:

gcloud services enable analyticshub.googleapis.com

Console

1. In the Google Cloud console, go to the Sharing (Analytics Hub) page.

   Go to Sharing (Analytics Hub)

2. Click add_box Create exchange.

3. In the Create exchange dialog, select a Project and a Region for your data exchange. You can't change the project and region after you create the data exchange.

4. In the Display name field, enter a name for your data exchange.

5. Optional: Enter values in the following fields:

   • Primary contact: enter the URL or email address of the primary contact for the data exchange.
   • Description: enter a description for the data exchange.

6. To log the principal identifiers of all users who run jobs and queries on linked datasets, click the Subscriber Email Logging toggle to the on position. When you turn on this setting, all future listings under the data exchange have subscriber email logging turned on. The logged data is available in the job_principal_subject field of the INFORMATION_SCHEMA.SHARED_DATASET_USAGE view.

7. To make the exchange publicly discoverable, click the Public Discoverability toggle to the on position. When an exchange is publicly discoverable, all listings in the exchange appear and are searchable in the catalog. Consider the following factors when you enable public discoverability:

   • Listing inheritance: all listings inherit the public discoverability setting of the data exchange by default. Public exchanges can't have private listings, but private exchanges can have public listings. You can configure the public discoverability type at the individual listing level.
   • Permissions: if you enable public discoverability, configure the exchange permissions to grant the Analytics Hub Viewer role (roles/analyticshub.viewer) to allUsers or allAuthenticatedUsers.
   • Project requirements: the project where you create the data exchange must have an associated organization and billing account.

8. To create the data exchange, click Create exchange.

9. Optional: In the Exchange Permissions section, complete the following steps:

   1. In the following fields, enter email addresses to grant Identity and Access Management (IAM) roles:

      • Administrators: assign the Analytics Hub Admin role (roles/analyticshub.admin) to these users.
      • Publishers: assign the Analytics Hub Publisher role (roles/analyticshub.publisher) to these users. For more information about the tasks that BigQuery sharing publishers can perform, see Manage listings.
      • Subscribers: assign the Analytics Hub Subscriber role (roles/analyticshub.subscriber) to these users. For more information about the tasks that BigQuery sharing subscribers can perform, see View and subscribe to listings and data exchanges.
      • Viewers: assign the Analytics Hub Viewer role (roles/analyticshub.viewer) to these users. BigQuery sharing viewers can view listings. If public discoverability is enabled, grant the Analytics Hub Viewer role to allUsers or allAuthenticatedUsers.

   2. To save permissions, click Set permissions.

10. If you didn't set permissions for your data exchange, click Skip.

API

To create a data exchange, use the projects.locations.dataExchanges.create method:

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges?dataExchangeId=DATAEXCHANGE_ID

Replace the following:

• PROJECT_ID: the ID of the project where you want to create the data exchange.
• LOCATION: the location for your data exchange. For more information about regions that support BigQuery sharing, see Supported regions.
• DATAEXCHANGE_ID: the ID of your data exchange.

In the body of the request, provide the data exchange details.

If the request is successful, the response body contains the details of the data exchange.

If you enable subscriber email logging with the logLinkedDatasetQueryUserEmail field, the data exchange response contains log_linked_dataset_query_user_email: true. The logged data is available in the job_principal_subject field of the INFORMATION_SCHEMA.SHARED_DATASET_USAGE view.

For more information about the tasks that you can perform on data exchanges using APIs, see projects.locations.dataExchanges methods.

Console

1. In the Google Cloud console, go to the Sharing (Analytics Hub) page.

   Go to Sharing (Analytics Hub)

2. In the list of data exchanges, select the data exchange that you want to update.

3. Click the Details tab.

4. Click mode_edit Edit exchange.

5. In the Edit exchange dialog, update the following fields:

   • Display name: enter a new display name.
   • Primary contact: enter an updated URL or email address.
   • Description: enter an updated description.

   • Public discoverability: turn public discoverability on or off.

     • If you turn public discoverability on, grant the Analytics Hub Viewer role (roles/analyticshub.viewer) to allUsers or allAuthenticatedUsers.
     • If you turn public discoverability off, remove the Analytics Hub Viewer role (roles/analyticshub.viewer) from allUsers or allAuthenticatedUsers. Public exchanges can't have private listings, but private exchanges can have public listings.

   • Subscriber Email Logging: turn subscriber email logging on or off.

6. To apply your changes, click Save.

API

To update a data exchange, use the projects.locations.dataExchanges.patch method:

PATCH https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID?updateMask=UPDATEMASK

Replace the following:

• PROJECT_ID: the ID of the project that contains the data exchange.
• LOCATION: the location of your data exchange.
• DATAEXCHANGE_ID: the ID of your data exchange.
• UPDATEMASK: a comma-separated list of fields that you want to update (for example, displayName,primaryContact).

In the body of the request, specify updated values for any of the following fields:

• displayName
• description
• primaryContact
• documentation
• icon
• discoveryType
• logLinkedDatasetQueryUserEmail

For more information about these fields, see Resource: DataExchange.

For more information about the tasks that you can perform on data exchanges using APIs, see projects.locations.dataExchanges methods.

Console

1. In the Google Cloud console, go to the Sharing (Analytics Hub) page.

   Go to Sharing (Analytics Hub)

2. In the list of data exchanges, view the data exchanges displayed for your Google Cloud project. If you have the resourcemanager.organizations.get permission, you can also view data exchanges across your Google Cloud organization.

API

To view data exchanges in your project, use the projects.locations.dataExchanges.list method:

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges

Replace the following:

• PROJECT_ID: the ID of the project where you want to list data exchanges.
• LOCATION: the location where you want to list existing data exchanges.

To view data exchanges in your organization, use the organizations.locations.dataExchanges.list method:

GET https://analyticshub.googleapis.com/v1/organizations/ORGANIZATION_ID/locations/LOCATION/dataExchanges

Replace the following:

• ORGANIZATION_ID: the organization ID. For more information, see Get your organization ID.
• LOCATION: the location where you want to list existing data exchanges.

Console

1. In the Google Cloud console, go to the Sharing (Analytics Hub) page.

   Go to Sharing (Analytics Hub)

2. Click the name of the data exchange that you want to set permissions for.

3. Click the Details tab.

4. Click person Set permissions.

5. To add principals, click person_add Add principal.

6. In the New principals field, enter the email address of the principal that you want to grant access to. You can also use allUsers to make a resource public and accessible to everyone on the internet, or allAuthenticatedUsers to make it accessible only to signed-in Google users.

7. In the Select a role list, hold the pointer over Analytics Hub, and then select one of the following IAM roles:

   • Analytics Hub Admin
   • Analytics Hub Listing Admin
   • Analytics Hub Publisher
   • Analytics Hub Subscriber
   • Analytics Hub Subscription Owner
   • Analytics Hub Viewer

8. Click Save.

API

1. To read the existing policy, use the projects.locations.dataExchanges.getIamPolicy method:

   POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID:getIamPolicy
   

   Replace the following:

   • PROJECT_ID: the project ID—for example, my-project-1.
   • LOCATION: the location for your data exchange. Use lowercase letters.
   • DATAEXCHANGE_ID: the data exchange ID.

   BigQuery sharing returns the current policy.

2. To add or remove members and their associated IAM roles, edit the policy with a text editor. Use the following format to add members:

   • user:test-user@gmail.com
   • group:admins@googlegroups.com
   • serviceAccount:server@example.gserviceaccount.com
   • domain:example.com

   For example, to grant the roles/analyticshub.subscriber role to group:subscribers@googlegroups.com, add the following binding to the policy:

   {
    "members": [
      "group:subscribers@googlegroups.com"
    ],
    "role":"roles/analyticshub.subscriber"
   }
   

3. To set the policy for the data exchange, use the projects.locations.dataExchanges.setIamPolicy method. In the request body, provide the updated IAM policy from the previous step:

   POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID:setIamPolicy
   

Console

1. In the Google Cloud console, go to the Sharing (Analytics Hub) page.

   Go to Sharing (Analytics Hub)

2. In the list of data exchanges, select the data exchange that you want to delete.

3. Click the Details tab.

4. Click delete Delete exchange.

5. In the Delete exchange? dialog, confirm deletion by entering delete.

6. To permanently delete the data exchange, click Delete.

API

To delete a data exchange, use the projects.locations.dataExchanges.delete method:

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataExchanges/DATAEXCHANGE_ID

Replace the following:

• PROJECT_ID: the ID of the project that contains the data exchange.
• LOCATION: the location for your data exchange. For more information about regions that support BigQuery sharing, see Supported regions.
• DATAEXCHANGE_ID: the ID of your data exchange.

For more information about the tasks that you can perform on data exchanges using APIs, see projects.locations.dataExchanges methods.