Manage listings

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

   A page appears that lists all data exchanges that you can access.

2. Click the data exchange name in which you want to create the listing.

3. Click add_box Create listing.

4. On the Create listing page, in Display name, enter the name of the listing.

5. If you are creating a commercial listing, then you must fill in the Request access contact field. You must enter an email or URL of the intake form for subscribers to contact you.

6. Optional: Enter the following details:

   • Primary contact: enter an email or a URL of the primary contact for the listing.

   • Category: select up to two categories that best represent your listing. Subscribers can filter listings based on these categories.

   • Provider: expand the Provider section and specify details in the following fields:

     • Provider name: the name of the dataset provider.
     • Provider primary contact: an email or a URL of the dataset provider's primary contact.

     Subscribers can filter listings based on the data providers.

   • Publisher: expand the Publisher section and specify details in the following fields:

     • Publisher name: the name of the publisher who's creating the listing.
     • Publisher primary contact: an email or a URL of the dataset publisher's primary contact.

   • Icon: an icon for your listing. PNG and JPEG file formats are supported. Icons must have a file size of less than 512 KiB and dimensions of no more than 512 x 512 pixels.

   • Description: a brief description about your listing. Subscribers can search for listings based on the description.

7. In Source dataset, select the dataset that you want to list in the data exchange. The source dataset must be in the same region as the data exchange. You cannot update this field after the listing is created.

8. In Data Egress, select the appropriate data egress option. Only subscribers with non-edition offerings or the Enterprise Plus edition can query data with data egress restrictions.

   • To apply data egress restrictions on your shared dataset, but not on your query results of your shared dataset, select Disable copy and export of shared data.
   • To apply data egress restrictions on your shared dataset and query results of your shared dataset, select Disable copy and export of query results, which will automatically set Disable copy and export of shared data as well.
   • To apply data API copy and export egress restrictions on your shared dataset, select Disable copy and export of tables through APIs, which will automatically set Disable copy and export of shared data as well.

9. Optional: In the Listing details section, click the Public discoverability toggle to enable public discoverability. You must grant the Analytics Hub Viewer role (roles/analyticshub.viewer) to allUsers or allAuthenticatedUsers. For more information, see Grant the role for a listing. If the exchange is already public, listing permissions are already inherited and no further action is required.

   Publicly discoverable exchanges can't have private listings due to permission inheritance, but private exchanges can have public listings. For public listings to be created, the project the data listing is in must have an associated organization and billing account.

10. Optional: In the Documentation > Markdown section, you can enter additional information such as sample queries that you can run on the dataset, links to any relevant documentation, and any additional information that can help subscribers to use your dataset.

11. Click Save.

API

Use the projects.locations.dataExchanges.listings.create method.

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings?listingId=LISTING_ID

Replace the following:

• PROJECT_ID: the project ID that contains the data exchange in which you want to create the listing.
• LOCATION: the location for your data exchange. For more information about locations that support Analytics Hub, see Supported regions.
• DATAEXCHANGE_ID: the data exchange ID.
• LISTING_ID: the listing ID.

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

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

Console

1. Go to the Analytics Hub page.

   Go to Analytics Hub

2. Click the data exchange name that contains the listing.

3. Click the listing for which you want to add subscribers.

4. Click person Set permissions.

5. To add principals, click person_add Add principal.

6. In the New principals field, add the following details based on the type of listing:

   • For a private listing, enter emails of the identity to whom you want to grant access.

   • For a public listing, add allAuthenticatedUsers.

   • For a public listing discoverable to everyone, including non-Google Cloud users, add allUsers.

7. For Select a role, hold the pointer over Analytics Hub, and then based on the type of listing, select one of the following roles:

   • For a commercial listing, select the Analytics Hub Viewer role. This role lets users view the listing and request access.

   • For a private or non-commercial public listing, select the Analytics Hub Subscriber role. This role lets users subscribe to your listing.

   For more information, see the Analytics Hub Subscriber and Viewer roles.

8. Click Save.

API

1. Read the existing policy with the listing getIamPolicy method by using the projects.locations.dataExchanges.listings.getIamPolicy method.

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

   Replace the following:

   • PROJECT_ID: the project ID—for example, my-project-1.
   • LOCATION: the location of the data exchange that contains the listing.
   • DATAEXCHANGE_ID: the data exchange ID.
   • LISTING_ID: the listing ID.

   Analytics Hub returns the current policy in the response.

2. To add or remove members and their associated 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.listings.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/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_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.

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

Console

1. Go to the Analytics Hub page.

   Go to Analytics Hub

2. Click the data exchange name that contains the listing for which you want to manage the subscriptions.

3. Click the listing for which you want to list all subscribers.

4. To view all subscribers of your listing, click Manage subscriptions.

   

5. Optional: You can filter results by subscriber details.

Alternatively, if you have access to the shared dataset, you can follow these steps to list subscribers:

1. Go to the BigQuery page.

   Go to BigQuery

2. In the Explorer pane, expand your project and select the shared dataset.

3. In the person_add Sharing list, select Manage subscriptions.

SQL

The following example uses the INFORMATION_SCHEMA.SCHEMATA_LINKS view to list all linked datasets to a shared dataset in myproject that are in the us region:

SELECT * FROM `myproject`.`region-us`.INFORMATION_SCHEMA.SCHEMATA_LINKS;

The output is similar to the following. Some columns are omitted to simplify the output.

+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
|  catalog_name  | schema_name | linked_schema_catalog_name | linked_schema_catalog_number | linked_schema_name | linked_schema_org_display_name |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+
| myproject      | myschema1   | subscriptionproject1       |                 974999999291 | subscriptionld1    | subscriptionorg                |
| myproject      | myschema2   | subscriptionproject2       |                 974999999292 | subscriptionld2    | subscriptionorg                |
| myproject      | myschema3   | subscriptionproject3       |                 974999999293 | subscriptionld3    | subscriptionorg                |
+----------------+-------------+----------------------------+------------------------------+--------------------+--------------------------------+

API

Use the projects.locations.dataExchanges.listings.listSubscriptions method.

GET https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID:listSubscriptions

Replace the following:

• PROJECT_ID: the project ID of the listing that you want to subscribe to.
• LOCATION: the location for the listing that you want to subscribe to.
• DATAEXCHANGE_ID: the data exchange ID that contains the listing that you want to subscribe to.
• LISTING_ID: the ID of the listing that you want to subscribe to.

Console

1. To list all subscribers of a listing, follow the Google Cloud console instructions in View all subscriptions.

2. Click the Subscriptions tab.

3. To remove a subscriber from a listing, select the Subscription(s) you would like to remove and click delete Remove Subscriptions.

4. In the Remove subscription? dialog, enter remove to confirm.

5. Click Remove.

API

Use the projects.locations.subscriptions.revoke method.

POST https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/subscriptions/SUBSCRIPTION_ID:revoke

Replace the following:

• PROJECT_ID: the project ID of the subscription that you want to remove.
• LOCATION: the location of the subscription that you want to remove.
• SUBSCRIPTION: the ID of the subscription that you want to remove.

Console

1. Go to the Analytics Hub page.

   Go to Analytics Hub

2. Click the data exchange name that contains the listing.

3. Click the listing that you want to update.

4. Click mode_edit Edit listing.

5. Modify values in the fields. You can modify all values except the source dataset of the listing.

6. Optional:

   • If you enable public discoverability, grant allUsers or allAuthenticatedUsers the Analytics Hub Viewer role (roles/analyticshub.viewer). For more information, see Grant the role for a listing
   • If you disable public discoverability, remove the Analytics Hub Viewer role from allUsers and allAuthenticatedUsers. Public exchanges can't have private listings, but private exchanges can have public listings.

7. To preview changes, click Preview.

8. To save changes, click Save.

API

Use the projects.locations.dataExchanges.listings.patch method.

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

Replace UPDATEMASK with the list of fields that you want to update. For updating multiple values, use a comma-separated list. In the body of the request, specify the updated values.

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

Console

1. Go to the Analytics Hub page.

   Go to Analytics Hub

2. Click the data exchange name that contains the listing.

3. Click the listing that you want to delete.

4. Click delete Delete.

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

6. Click Delete.

API

Use the projects.locations.dataExchanges.listings.delete method.

DELETE https://analyticshub.googleapis.com/v1/projects/PROJECT_ID/location/LOCATION/dataExchanges/DATAEXCHANGE_ID/listings/LISTING_ID

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