Manage data exchanges

Console

Go to the Analytics Hub APIpage 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. Go to the Sharing (Analytics Hub)page.

   Go to Sharing (Analytics Hub)

2. Click add_box Create exchange.

3. In the Create exchangedialog, select a Projectand a Regionfor your data exchange. You can't update the project and region after you create the data exchange.

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

5. Optional: Enter values in the following fields:

   • Primary contact: enter the URL or the 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 running jobs and queries on linked datasets, click the Subscriber Email Loggingtoggle. When you enable this option, 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 enable public discoverability, click the Public Discoverabilitytoggle. When an exchange is publicly discoverable, all listings in the exchange appear and are searchable in the catalog. If you enable public discoverability, configure the exchange permissions. All listings inherit the data exchange's public discoverability setting by default. This setting inheritance means public exchanges can't have private listings, but private exchanges can have public listings. You can set the public discoverability type at the individual listing level. The project where you create the data exchange must have an associated organization and billing account.

8. Click Create Exchange.

9. Optional: In the Exchange Permissionssection, complete the following steps:

   1. Enter email addresses in the following fields to grant the 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 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 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

Use the projects.locations.dataExchanges.create method .

POST https://analyticshub.googleapis.com/v1/projects/ PROJECT_ID 
/location/ 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 locations that support BigQuery sharing, see Supported regions .
• DATAEXCHANGE_ID : the ID for 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. Go to the Sharing (Analytics Hub)page.

   Go to Sharing (Analytics Hub)

2. From the list of data exchanges, select the data exchange to update.

3. Go to the Detailstab.

4. Click mode_edit Edit exchange.

5. In the Edit exchangedialog, update the following fields:

   • Display name
   • Primary contact
   • Description
   • Public discoverability
     • If you enable public discoverability, grant the Analytics Hub Viewer role ( roles/analyticshub.viewer ) to allUsers or allAuthenticatedUsers .
     • If you disable public discoverability, 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

6. Click Save.

API

Use the projects.locations.dataExchanges.patch method .

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

Replace UPDATEMASK with the list of fields that you want to update. To update multiple values, use a comma-separated list. For example, to update the display name and primary contact for a data exchange, enter displayName,primaryContact .

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

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

For details on 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. Go to the Sharing (Analytics Hub)page.

   Go to Sharing (Analytics Hub)

2. The page displays the data exchanges in your Google Cloud project. If you have the resourcemanager.organizations.get permission, you can also see the data exchanges in 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 
/location/ LOCATION 
/dataExchanges

Replace the following:

• PROJECT_ID : the project ID.
• LOCATION : the location for which you want to list the 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 
/location/ LOCATION 
/dataExchanges

Replace the following:

• ORGANIZATION_ID : the organization ID. For more information, see Getting your organization ID .
• LOCATION : the location where you want to list the 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 data exchange name for which you want to set permissions.

3. Go to the Detailstab.

4. Click person Set permissions.

5. To add principals, click person_add Add principal.

6. In the New principalsfield, add the email IDs to which you want to grant access. 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 rolemenu, select Analytics Hub, and then select one of the following Identity and Access Management (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. Read the existing policy with the listing getIamPolicy method by using 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 (formerly Analytics Hub) returns the current policy.

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

   • user:test-user@gmail.com
   • group:admins@example.com
   • serviceAccount:test123@example.domain.com
   • domain:example.domain.com

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

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

3. Write the updated policy by using the projects.locations.dataExchanges.setIamPolicy method . In the body of the request, provide the updated IAM policy from the previous step.

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

   In the body of the request, provide the listing details. If the request is successful, then the response body contains details of the listing.

Console

1. Go to the Sharing (Analytics Hub)page.

   Go to Sharing (Analytics Hub)

2. From the list of data exchanges, select the data exchange to delete.

3. Go to the Detailstab.

4. Click delete Delete exchange.

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

6. Click Delete.

API

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 in which you want to create the data exchange.
• LOCATION : the location for your data exchange. For more information about locations that support BigQuery sharing, see Supported regions .
• DATAEXCHANGE_ID : the ID for your data exchange.

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