Manage data products

Preview

This product or feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of theService Specific Terms. Pre-GA products and features are available "as is" and might have limited support. For more information, see thelaunch stage descriptions.

This document is intended for data product owners who want to update, delete,and grant access to data products in Dataplex Universal Catalog.

For more information about the architecture and key concepts ofdata products, seeAbout data products.

Before you begin

  1. Enable the Dataplex, BigQuery APIs.

    Roles required to enable APIs

    To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains theserviceusage.services.enable permission.Learn how to grant roles.

    Enable the APIs

Note: This guide assumes you have existing data products to manage. For moreinformation about creating and configuring data products, seeCreate data products.

Required roles

To get the permissions that you need to manage data products, ask your administrator to grant you the following IAM roles on the project:

For more information about granting roles, seeManage access to projects, folders, and organizations.

These predefined roles contain the permissions required to manage data products. To see the exact permissions that are required, expand theRequired permissions section:

Required permissions

The following permissions are required to manage data products:

  • Edit theoverview system aspect type: dataplex.entryGroups.useOverviewAspect
  • Edit therefresh cadence system aspect type: dataplex.entryGroups.useRefreshCadenceAspect

You might also be able to get these permissions withcustom roles or otherpredefined roles.

Grant access to a data product

Data product owners must make their products discoverable and grant necessaryroles, allowing consumers to search for, view, and request accessto data products.

To grant data product consumers the permissions they need to interact with thedata product, grant them the following IAM roles on the dataproduct resource:

  • Search for data products and access them in Dataplex Universal Catalog search:Dataplex Data Product Consumer (dataplex.dataProductsConsumer)
  • Read-only access to view data product definitions and metadata:Dataplex Data Product Viewer (dataplex.dataProductsViewer)
  • Request access to data products: Dataplex Data Product Consumer(dataplex.dataProductsConsumer)

When a data product consumer requests access to a data product, the data productowner receives an email notification.

To grant access, follow these steps:

  1. In the Google Cloud console, go to theGroups page.

    Go to the Groups page

  2. Search for the group associated with the requested permission level andselect it.

  3. Click Add members.

  4. Add the principal.

  5. ClickSave.

For more information, seeCreate and manage Google groups in the Google Cloud console.

Update a data product

You can update the basic details (for example, data product name, description,owner details), assets, access groups, permissions, contract, aspects, andadditional documentation for an existing data product.

Update the basic details of a data product

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product that you want to update.

  3. ClickEdit data product.

  4. Update theData product name,Icon,Description,Owner contacts, andLabels as required.

  5. ClickUpdate data product.

REST

To update the basic details of a data product, use thedataProducts.patchmethod.

For example, to update the description of a data product, send the followingPATCH request:

curl -X PATCH \-H "Authorization: Bearer $(gcloud auth print-access-token)" \-H "Content-Type: application/json" \-d '{"description": "NEW_DESCRIPTION"}' \https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID?update_mask="description"

Replace the following:

  • NEW_DESCRIPTION: a new description for the dataproduct
  • PROJECT_ID: the ID of your Google Cloudproject
  • LOCATION: the region where the dataproduct exists
  • DATA_PRODUCT_ID: the ID of your data product

Update assets of a data product

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData productspage.

    Go to Data products

  2. Click the data product for which you want to update assets.

  3. Click theAssets tab.

  4. To add a new asset, follow these steps:

    1. Click+Add.

    2. Search for and select the assets that you want to add to yourdata product. The assets you select must reside in the same region as thedata product.

      If you have necessary permissions, you can view the metadata of assets byclicking the asset.

    3. To refine the search results, useFilters.

    4. After you select the assets, clickAdd.

  5. To remove an asset from the data product, follow these steps:

    1. For the asset that you want to remove, click> Remove.

    2. To confirm the action, clickRemove.

REST

To add a new data asset to the data product, use thedataAssets.createmethod. For a code example, seeOptional: Add assets.

To delete a data asset from the data product, use thedataAssets.deletemethod. For example, send the followingDELETE request:

curl -X DELETE \-H "Authorization: Bearer $(gcloud auth print-access-token)" \"https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID/dataAssets/DATA_ASSET_ID"

Replace the following:

  • PROJECT_ID: the ID of your Google Cloudproject
  • LOCATION: the region in which you want tocreate the data product
  • DATA_PRODUCT_ID: a unique ID for your dataproduct
  • DATA_ASSET_ID: the ID of the data asset you wantto remove from the data product

Update access groups and asset permissions

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product for which you want to update the access groups andpermissions.

  3. Click theAccess groups & permissions tab.

  4. To update an access group, follow these steps:

    1. ClickEdit.

    2. Update the access group name, description, and identifier as required.

    3. To add a new access group, clickAdd access group and follow thesesteps:

      1. In theAccess group name field, enter a name for the new accessgroup. For example,Analyst.

      2. In theAccess group description field, enter a description for theaccess group.

      3. In theAccess group identifier field, enter the email address ofa Google group that you want to assign to this access group. Dataproduct consumers who request access to this accessgroup can be added as members to the mapped Google group.

        You can add a maximum of three access groups per data product.

    4. ClickAdd.

  5. To remove an access group, follow these steps:

    1. For the access group that you want to remove, click> Remove.

    2. To confirm the action, clickRemove.

  6. If no access groups are configured for the selected data product, you canadd a new access group by clickingAdd access group.

  7. To update asset permissions, follow these steps:

    1. For the asset you want to update permissions, click>Permissions.

    2. Update the required access groups and IAM roles.

    3. ClickConfigure.

REST

To update the access groups associated with a data product, use thedataProducts.patchmethod. For a code example, seeConfigure access groups.

To update the asset permissions, use thedataAssets.patchmethod. For a code example, seeConfigure asset permissions.

Update the data product contract

Note: The refresh cadence isn't editable after you add it to the contract. If you try to modify this value, the following error is displayed:You don't have permission to change contract values.

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product for which you want to update the contract.

  3. Click theContract tab.

  4. To update the existing contract, follow these steps:

    1. ClickEdit.

    2. Update the necessary fields.

    3. ClickSave.

  5. If no contract is attached to the selected data product, you can add one byclickingAdd contract.

REST

To update a contract, use theentries.patchmethod. For a code example, seeAdd a contract.

Update aspects of a data product

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product for which you want to update the aspects.

  3. Click theAspects tab.

  4. To update an aspect, follow these steps:

    1. Click the aspect you want to update.

    2. ClickEdit.

    3. Update theAspect type,Country, andRegion as required.

    4. ClickSave.

  5. To add a new aspect for the data product, follow these steps:

    1. Click+ Add aspect.

    2. In theSelect aspect type field, search for and select an aspecttype from the list. For example,Geo context.

    3. In theCountry field, select the country to which the asset belongs.

    4. In theRegion field, select the business region to which the assetbelongs.

    5. ClickSave.

  6. To delete an aspect, follow these steps:

    1. Click the aspect you want to delete.

    2. Click.

    3. To confirm the action, clickConfirm.

REST

To update any aspect on the data product entry, usetheentries.patchmethod.

Update the data product documentation

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product for which you want to update the documentation.

  3. Click theOverview tab.

  4. ClickEdit againstDocumentation.

  5. Update user guide, sample queries, and other documentation as required.

  6. ClickSave.

REST

Documentation is part of theoverview aspect. To update the data productdocumentation, use theentries.patchmethod.

Delete a data product

To delete a data product, you must first remove all the assets from the dataproduct.

Console

  1. In the Google Cloud console, go to the Dataplex Universal CatalogData products page.

    Go to Data products

  2. Click the data product that you want to delete.

  3. Click theAssets tab.

  4. For every asset listed, click>Remove.Confirm the action by clickingRemove.

  5. After you remove all the assets, delete the data product by clickingDelete.

  6. In the confirmation dialog, enterdelete and clickDelete.

REST

To delete a data product, use thedataProducts.deletemethod.

For example, send the followingDELETE request:

curl -X DELETE \-H "Authorization: Bearer $(gcloud auth print-access-token)" \-H "Content-Type: application/json" \https://dataplex.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/dataProducts/DATA_PRODUCT_ID

Replace the following:

  • PROJECT_ID: the ID of your Google Cloudproject
  • LOCATION: the region where the dataproduct exists
  • DATA_PRODUCT_ID: the ID of your data product thatyou want to delete

What's next

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2026-02-19 UTC.