Manage data exchanges

Console

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

Enable the Analytics Hub API

gcloud

Run the gcloud services enable command:

gcloud services enable analyticshub.googleapis.com

Console

1. Go to the Analytics Hub page.

   Go to 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 cannot update the project and region after you create the data exchange.

4. For Display name, 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 turn on public discoverability, click the Public discoverability toggle. Once an exchange is publicly discoverable, all listings in the exchange are displayed and searchable in the catalog. If you enable public discoverability, you must configure the exchange permissions. Due to permission inheritance, all listings by default will be set with the same public discoverability type of the exchange. Therefore, public exchanges cannot have private listings, but private exchanges can have public listings (for example, you can set the public discoverability type at the individual listing level). The project that you are creating the data exchange in must have an associated organization and billing account.

7. Click Create Exchange.

8. Optional: In the Exchange permissions section, do the following steps:

   1. Enter email addresses in the following fields to grant the Analytics Hub user roles:

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

   2. To save permissions, click Set permissions.

9. 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 in which you want to create the data exchange.
• LOCATION: the location for your data exchange. For more information about locations that support Analytics Hub, 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, then the response body contains details of the data exchange.

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 Analytics Hub page.

   Go to Analytics Hub

2. From the list of data exchanges, click a data exchange that you want to update.

3. Click mode_edit Edit exchange.

4. In the Edit exchange dialog, 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.

5. 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. For updating 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 the updated values for the following fields:

• Display name
• Description
• Documentation
• Icon
• Primary contact
• Public discoverability

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 Analytics Hub page.

   Go to Analytics Hub

2. View the list of data exchanges within your Google Cloud organization.

API

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 for which you want to list the existing data exchanges.

Console

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

   Go to Analytics Hub

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

3. Click person Set permissions.

4. To add principals, click person_add Add principal.

5. In the New principals field, add the emails to which you want to grant access.

6. For Select a role, hold the pointer over Analytics Hub, and then select one of the following Identity and Access Management (IAM) roles:

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

7. 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.
   • DATAEXCHANGE_ID: the data exchange ID.

   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:[email protected]
   • group:[email protected]
   • serviceAccount:[email protected]
   • domain:example.domain.com

   For example, to grant the roles/analyticshub.subscriber role to group:[email protected], add the following binding to the policy:

   {
    "members": [
      "group:[email protected]"
    ],
    "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 Analytics Hub page.

   Go to Analytics Hub

2. From the list of data exchanges, click the data exchange that you want to delete.

3. Click delete Delete exchange.

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

5. Click Delete.

API

Use the projects.locations.dataExchanges.delete method.

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

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