Console
    Contact Us Start free

    Manage a business glossary

    Dataplex Universal Catalog business glossary provides a single place to manage business-related terminology and definitions across your company.

    When different teams work on a shared project, or a large company has many departments, it's common for each part of the enterprise to create its own terminology to describe the various data resources that they work with. This can lead to miscommunication and an inconsistent understanding of those resources. In addition, sometimes a concept can require technical or specialized knowledge. This can make it difficult for business users in other domains to understand the concept.

    Dataplex Universal Catalog business glossary lets you create a central, standardized vocabulary for your data resources. You can use a business glossary to do the following things:

    • Define a hierarchical structure of business categories and concepts, called terms.
    • Create connections between concepts by defining synonyms and related terms.
    • Associate your data resources with terms in the glossary, which lets you search for data resources based on business concepts.

    A business glossary helps to streamline data discovery and reduce ambiguity, which can lead to more accurate analysis, better governance, and faster insights.

    Elements of a business glossary

    This section describes the key elements that you can use to structure a business glossary.

    Glossary

    A glossary has the following properties:

    • Overview. Describes the purpose and contents of the business glossary. You can add images, links, tables, or formatted text to the glossary. The maximum supported size is 120 KB.
    • Description. Describes the glossary. The text in this field is indexed for search. The maximum supported size is 1 KB.
    • Region. Specifies the region where the glossary is located.

    Category

    A category lets you organize and structure various categories and terms. Categories are defined within a business glossary. You can nest categories up to three levels.

    A category has the properties of a glossary as well as the following properties:

    • Contacts. Specifies the person responsible for maintaining the category. This property is descriptive and doesn't affect the permissions of the category.
    • Parent. Specifies a relationship that is used to establish the parent of the current category. You can nest up to three categories.

    The region of a category is the same as the region of the glossary that contains it.

    Term

    A term (short for "glossary term") describes a concept that's used in a particular branch of business within your company. For example, the marketing department of a company might create a term that describes cost per click. Terms are defined within a business glossary, either in the glossary directly or within any category found in the glossary.

    A term has the properties of a category as well as the following properties:

    • Synonyms. Specifies links between terms that have the same meaning. See Synonym terms .
    • Related terms. Specifies links between terms that are conceptually related to each other, but that have different meanings. See Related terms .
    • Related entries. Specifies links between terms and data assets, or between terms and columns within data assets.
    • Contacts. Specifies the person responsible for maintaining the term. Terms don't inherit the contacts that are defined in categories.

    The region of a term is the same as the region of the glossary that contains it.

    Synonym terms

    A synonym is a relationship that indicates equivalence between two different terms. Use synonyms when two terms with the same meaning are defined by different teams in different glossaries. For example, you can create a synonym to link the terms "profit" and "earnings."

    A related term is a relationship that indicates that two terms are associated with each other, but have different meanings. For example, you can create a related term to link the terms "revenue" and "profit."

    Limitations

    Required roles

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

    • For data administrators, get full access to glossaries, categories, terms, synonyms, and related terms, and to set IAM policies: Dataplex Catalog Admin ( roles/dataplex.catalogAdmin )
    • For data stewards or data owners, get access to creating, editing or deleting glossaries, categories, terms, links between terms, links between terms and data assets , and search: Dataplex Catalog Editor ( roles/dataplex.catalogEditor )
    • For data analysts or data consumers, get read-only access to glossaries, categories, terms, links between terms and between terms and data assets, and search: Dataplex Catalog Viewer ( roles/dataplex.catalogViewer )

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

    These predefined roles contain the permissions required to create and manage glossaries. To see the exact permissions that are required, expand the Required permissionssection:

    Required permissions

    The following permissions are required to create and manage glossaries:

    • Create, read, update, and delete a business glossary, category, and terms in your project:
      • dataplex.glossaries.list
      • dataplex.glossaries.create
      • dataplex.glossaries.get
      • dataplex.glossaries.update
      • dataplex.glossaries.delete
      • dataplex.glossaryCategories.create
      • dataplex.glossaryCategories.list
      • dataplex.glossaryCategories.get
      • dataplex.glossaryCategories.update
      • dataplex.glossaryCategories.delete
      • dataplex.glossaryTerms.create
      • dataplex.glossaryTerms.list
      • dataplex.glossaryTerms.get
      • dataplex.glossaryTerms.update
      • dataplex.glossaryTerms.delete
    • Create and delete synonym term-to-term links in your project:
      • dataplex.entryLinks.create on the Dataplex Universal Catalog entry group in the project in which either of the glossary terms is present. The link is created in the entry group for which the permission is given.
      • dataplex.entryGroups.useSynonymEntryLink on the Dataplex Universal Catalog entry group in the project in which either of the glossary terms is present. The link is created in the entry group for which the permission is given.
      • dataplex.glossaryTerms.use on the glossaries whose terms need to be associated.
      • dataplex.entryLinks.delete on the Dataplex Universal Catalog entry group in the project in which the link is present.
    • Create and delete related term-to-term links in your project:
      • dataplex.entryLinks.create on the Dataplex Universal Catalog entry group in the project in which either of the glossary terms is present. The link is created in the entry group for which the permission is given.
      • dataplex.entryGroups.useRelatedEntryLink on the Dataplex Universal Catalog entry group in the project in which either of the glossary terms is present. The link is created in the entry group for which the permission is given.
      • dataplex.entries.link on the Dataplex Universal Catalog entry group in projects in which entries corresponding to glossary terms are present.
      • dataplex.entryLinks.delete on the Dataplex Universal Catalog entry group in the project in which the link is present.
    • Create links between terms and data assets or columns in your project:
      • dataplex.entryLinks.create on the system entry group corresponding to data assets or columns in the project. The link is created in the project for which the permission is given.
      • dataplex.entryGroups.useDefinitionEntryLink on the system entry group corresponding to data assets or columns in the project. The link is created in the project for which permission is given.
      • dataplex.entries.link on the system entry group corresponding to data assets or columns in the project. The link is created in the project for which the permission is given.
      • dataplex.glossaryTerms.use on the glossary whose term needs to be associated.
      • dataplex.entryLinks.delete on the system entry group in which the link is present.

    You might also be able to get these permissions with custom roles or other predefined roles .

    For more information, see Dataplex Universal Catalog IAM roles .

    Create and manage business glossaries

    The following sections describe how to create, view, edit, and delete a business glossary.

    Create a business glossary

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Click Create business glossary.

    3. On the Create business glossarypage, specify a name and location for the business glossary. After you create the glossary, you can't change the location.

    4. Click Create. The glossary is created under the current project.

    5. Optional: Add a short description in Description(up to 1024 characters) or a long description in Overview(up to 120 KB).

    REST

    When you create a glossary, Dataplex Universal Catalog creates an entry to represent the glossary.

    1. Create the glossary.

       alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries?glossary_id = 
 GLOSSARY_ID 
  
--data  
@-  
 << EOF 
 { 
 "displayName": " DISPLAY_NAME 
", 
 "description": " DESCRIPTION 
" 
 } 
 EOF

      Replace the following:

      • PROJECT_ID : the ID of the project in which you want to create the glossary
      • LOCATION_ID : the ID of the location where you want to create the glossary
      • GLOSSARY_ID : the ID of the glossary
      • DISPLAY_NAME : the display name of the glossary
      • DESCRIPTION : the description of the glossary, up to a maximum of 1024 characters

    2. Optional: Add an overview to the glossary.

      1. Look up the entry for your glossary:

        gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry \ 
?entry = 
projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
 \ 
 \& 
 view 
 = 
ALL

        Replace PROJECT_NUMBER with the number of the project where your glossary is created.

      2. Add an overview to your glossary:

        gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
 \ 
?update_mask = 
aspects \ 
 \& 
 deleteMissingAspects 
 = 
false \ 
 \& 
 aspect_keys 
 = 
projects/dataplex-types/locations/global/aspectTypes/overview  
 \ 
--data  
@-  
 << EOF 
 { 
 "aspects": { 
 "dataplex-types.global.overview": { 
 "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/overview", 
 "data": { 
 "content": " OVERVIEW 
", 
 "links": [] 
 }, 
 } 
 } 
 } 
 EOF

        Replace OVERVIEW with plaintext or HTML to describe your glossary category or term.

    View the available glossaries

    Console

    • In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

      The My glossariespane displays all the organization's glossaries you have permission to view, along with their descriptions and last modified timestamps.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries

    Edit a glossary

    You can edit the name and description of a glossary.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Click the glossary that you want to edit.

    3. Click Editnext to the name, description, or overview, and then make your change.

    4. Click Save.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
?update_mask = 
displayName,description  
--data  
@-  
 << EOF 
 { 
 "displayName": " DISPLAY_NAME 
", 
 "description": " DESCRIPTION 
" 
 } 
 EOF

    Delete a glossary

    Before you can delete a glossary, you first need to delete all the categories and terms in the glossary.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Click the glossary that you want to delete.

    3. Click Delete, and then confirm when prompted.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
DELETE  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID

    Create and manage categories

    The following sections describe how to create, view, update, and delete categories.

    Create a category under a glossary

    A business glossary can have a maximum of 200 categories.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Select the glossary in which you want to create a category, and then click Create category.

    3. Enter a name for the category.

    4. Click Create.

    5. Optional: Add a short description in Description(up to 1024 characters) or a long description in Overview(up to 120 KB).

    REST

    When you create a category, Dataplex Universal Catalog creates an entry to represent the category.

    1. Create the category.

       alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories?category_id = 
 CATEGORY_ID 
  
--data  
@-  
 << EOF 
 { 
 "displayName": " CATEGORY_DISPLAY_NAME 
", 
 "description": " CATEGORY_DESCRIPTION 
", 
 "parent": "projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
 } 
 EOF

      Replace the following:

      • CATEGORY_ID : the category ID
      • CATEGORY_DISPLAY_NAME : the category display name
      • CATEGORY_DESCRIPTION : the category description

    2. Optional: Add an overview to the category.

      1. Look up the entry for your category:

        gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry \ 
?entry = 
projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
 \ 
 \& 
 view 
 = 
ALL

      2. Add an overview to your category:

        gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
 \ 
?update_mask = 
aspects \ 
 \& 
 deleteMissingAspects 
 = 
false \ 
 \& 
 aspect_keys 
 = 
projects/dataplex-types/locations/global/aspectTypes/overview \ 
--data  
@-  
 << EOF 
 { 
 "aspects": { 
 "dataplex-types.global.overview": { 
 "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview 
 ", 
 "data": { 
 "content": " OVERVIEW 
", 
 "links": [] 
 }, 
 } 
 } 
 } 
 EOF

        Replace OVERVIEW with plaintext or HTML to describe your glossary category or term.

    3. Optional: Add contacts

      1. Look up the entry for your category:

        gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry \ 
?entry = 
projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
 \ 
 \& 
 view 
 = 
ALL

      2. Update the entry for your category with contacts:

        gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
 \ 
?update_mask = 
aspects \ 
 \& 
 deleteMissingAspects 
 = 
false \ 
 \& 
 aspect_keys 
 = 
projects/dataplex-types/locations/global/aspectTypes/contacts  
 \ 
--data  
@-  
 << EOF 
 { 
 "aspects": { 
 "dataplex-types.global.contacts": { 
 "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts", 
 "data": { 
 "identities": [ 
 { 
 "role": "steward", 
 "name": " CONTACT_NAME 
", 
 "id": " CONTACT_EMAIL 
" 
 } 
 ] 
 }, 
 } 
 } 
 } 
 EOF

    Create a nested category

    A business glossary can have a maximum of three nested category levels, excluding the root glossary level.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary in which you want to create a category.

    3. Select the parent category in which you want to create another category, and click Create category.

    4. Enter a name for the category.

    5. Click Create.

    6. Optional: Add a short description in Description(up to 1024 characters) or a long description in Overview(up to 120 KB).

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories?category_id = 
 CATEGORY_ID 
  
--data  
@-  
 << EOF 
 { 
 "displayName": " CATEGORY_DISPLAY_NAME 
", 
 "description": " CATEGORY_DESCRIPTION 
", 
 "parent": "projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ PARENT_CATEGORY_ID 
" 
 } 
 EOF

    Replace PARENT_CATEGORY_ID with the ID of the parent category.

    View the categories that belong to a glossary

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. To view the categories in a glossary, expand the glossary.

    3. To view the nested categories in a category, expand the category.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories

    Edit a category

    You can edit the name, description, and contacts for a category. For nested categories, you can also edit the parent category.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the category you want to edit.

    3. Click Editnext to the name, description, or overview, and then make your change.

    4. Click Save.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
?update_mask = 
displayName,description  
--data  
@-  
 << EOF 
 { 
 "displayName": " CATEGORY_DISPLAY_NAME 
", 
 "description": " DESCRIPTION 
" 
 } 
 EOF

    Delete a category

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the category that you want to delete.

    3. Click Delete, and then confirm when prompted.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
DELETE  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID

    Create and manage terms

    The following sections describe how to create, view, access, edit, and delete terms.

    Create a term under a business glossary

    A business glossary can have a maximum of 5,000 terms.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. To create a term at the glossary level, select the glossary where you want to create a term, and then click Create term.

    3. Enter a name for the term.

    4. Click Create.

    5. Optional: Add a short description in Description(up to 1024 characters) or a long description in Overview(up to 120 KB).

    6. Optional: To add contacts, click Edit, and then provide a list of email addresses for the data stewards, data owners, or data domain owners. Then click Save.

    REST

    When you create a term, Dataplex Universal Catalog creates an entry to represent the term.

    1. Create the term.

      alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms?term_id= TERM_ID 
--data @- << EOF
{
"displayName": " TERM_DISPLAY_NAME 
",
"description": " TERM_DESCRIPTION 
",
"parent": "projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
"
}
EOF

      Replace the following:

      • TERM_ID : the ID of the term you're creating
      • TERM_DISPLAY_NAME : the display name for the term you're creating
      • TERM_DESCRIPTION : the description for the term you're creating

    2. Optional: Add an overview to the term.

      1. Look up the entry for your term:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry\
?entry=projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
\&view=ALL

      2. Add an overview to your term:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": " OVERVIEW 
",
   "links": []
   },
}
}
}
EOF

        Replace OVERVIEW with plaintext or HTML to describe your glossary category or term.

    3. Optional: Add contacts.

      1. Look up the entry for your term:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry\
?entry=projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
\&view=ALL

      2. Update the entry for your term with contacts:

        gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
?update_mask = 
aspects \ 
 \& 
 deleteMissingAspects 
 = 
false \ 
 \& 
 aspect_keys 
 = 
projects/dataplex-types/locations/global/aspectTypes/contacts  
 \ 
--data  
@-  
 << EOF 
 { 
 "aspects": { 
 "dataplex-types.global.contacts": { 
 "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts", 
 "data": { 
 "identities": [ 
 { 
 "role": "steward", 
 "name": " CONTACT_NAME 
", 
 "id": " CONTACT_EMAIL 
" 
 } 
 ] 
 }, 
 } 
 } 
 } 
 EOF

    Create a term under a category

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. To create a term in a category, select the category where you want to create a term, and then click Add term.

    3. Enter a name for the term.

    4. Click Create.

    5. Optional: Add a short description in Description(up to 1024 characters) or a long description in Overview(up to 120 KB).

    6. Optional: To add contacts, click Edit, and then provide a list of email addresses for the data stewards, data owners, or data domain owners. Then click Save.

    REST

    When you create a term, Dataplex Universal Catalog creates an entry to represent the term.

    1. Create a term.

      alias gcurl='curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"'

gcurl -X POST https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms?term_id= TERM_ID 
--data @- << EOF
{
"displayName": " TERM_DISPLAY_NAME 
",
"description": " TERM_DESCRIPTION 
",
"parent": "projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ PARENT_CATEGORY_ID 
"
}
EOF

      Replace the following:

      • TERM_ID : the ID of the term you're creating
      • TERM_DISPLAY_NAME : the display name for the term you're creating
      • TERM_DESCRIPTION : the description for the term you're creating

    2. Optional: Add an overview to the term.

      1. Look up the entry for your term:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry\
?entry=projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
\&view=ALL

      2. Add an overview to your term:

        gcurl -X PATCH https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
?update_mask=aspects\
\&deleteMissingAspects=false\
\&aspect_keys=projects/dataplex-types/locations/global/aspectTypes/overview
\
--data @- << EOF
{
"aspects": {
"dataplex-types.global.overview": {
   "aspect_type":"projects/dataplex-types/locations/global/aspectTypes/overview
",
   "data": {
   "content": " OVERVIEW 
",
   "links": []
   },
}
}
}
EOF

        Replace OVERVIEW with plaintext or HTML to describe your glossary category or term.

    3. Optional: Add contacts.

      1. Look up the entry for your term:

        gcurl -X GET https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
:lookupEntry\
?entry=projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
\
\&view=ALL

      2. Update the entry for your term with contacts:

        gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
?update_mask = 
aspects \ 
 \& 
 deleteMissingAspects 
 = 
false \ 
 \& 
 aspect_keys 
 = 
projects/dataplex-types/locations/global/aspectTypes/contacts  
 \ 
--data  
@-  
 << EOF 
 { 
 "aspects": { 
 "dataplex-types.global.contacts": { 
 "aspect_type": "projects/dataplex-types/locations/global/aspectTypes/contacts", 
 "data": { 
 "identities": [ 
 { 
 "role": "steward", 
 "name": " CONTACT_NAME 
", 
 "id": " CONTACT_EMAIL 
" 
 } 
 ] 
 }, 
 } 
 } 
 } 
 EOF

    View the terms in a glossary or category

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. To view the terms in a glossary, expand the glossary. To view terms in a category within this glossary, expand the category. To view terms within a nested category, expand the nested category.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms

    View the details of a term

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. To view the list of terms in a glossary, expand the glossary.

    3. Click a term. The Term detailspage displays the term name, description, related terms, synonyms, and related entries.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID

    Edit a term

    You can edit the name, description, overview, contacts, and parent for a term.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the term that you want to edit.

    3. Click Edit.

    4. Edit any of the fields and click Save.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
PATCH  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID 
?update_mask = 
displayName,description  
--data  
@-  
 << EOF 
 { 
 "displayName": " TERM_DISPLAY_NAME 
", 
 "description": " TERM_DESCRIPTION 
" 
 } 
 EOF

    Delete a term

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the term that you want to delete.

    3. Click Delete, and then confirm when prompted.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
DELETE  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM_ID

    You can add relationships between terms by linking them as synonyms or related terms.

    Term relationships are bi-directional. For example, when you link profit as a synonym of earnings , earnings also becomes a synonym of profit .

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the term that you want to create links with.

    3. Click Editnext to Synonym terms.

    4. Search for and then select the terms to link to.

      The term gets linked immediately when you select it.

    5. Click Close.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ TERM1_PROJECT_ID 
/locations/ TERM1_LOCATION_ID 
/entryGroups/@dataplex/entryLinks?entry_link_id = 
 ENTRY_LINK_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "entry_link_type" 
:  
 "projects/dataplex-types/locations/global/entryLinkTypes/synonym" 
, "entry_references" 
:  
 [{ 
  
 "name" 
:  
 "projects/ TERM1_PROJECT_NUMBER 
/locations/ TERM1_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM1_PROJECT_NUMBER 
/locations/ TERM1_LOCATION_ID 
/glossaries/ TERM1_GLOSSARY_ID 
/terms/ TERM1_ID 
" 
,  
 "type" 
:  
 "UNSPECIFIED" 
  
 } 
,  
 { 
  
 "name" 
:  
 "projects/ TERM2_PROJECT_NUMBER 
/locations/ TERM2_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM2_PROJECT_NUMBER 
/locations/ TERM2_LOCATION_ID 
/glossaries/ TERM2_GLOSSARY_ID 
/terms/ TERM2_ID 
" 
,  
 "type" 
:  
 "UNSPECIFIED" 
  
 } 
  
 ] 
 } 
EOF ) 
 "

    Replace the following:

    • TERM1_PROJECT_NUMBER : the project number for the first term being linked.
    • TERM1_LOCATION_ID : the location ID of the glossary that contains the first term.
    • TERM1_GLOSSARY_ID : the ID of the glossary that contains the first term.
    • TERM1_ID : the ID of the first term.
    • TERM2_PROJECT_NUMBER : the project number for the second term that you want to link to as a synonym term. If both terms are in the same project, then this value is the same as the project number for the first term.
    • TERM2_LOCATION_ID : the location ID of the glossary that contains the second term. If both terms are in the same location, then this value is the same as the location ID for the first term.
    • TERM2_GLOSSARY_ID : the ID of the glossary that contains the second term. If both terms are in the same glossary, then this value is the same as the glossary ID for the first term.
    • TERM2_ID : the ID of the second term.
    • ENTRY_LINK_ID : an ID for the link between the two terms. Each term is represented as a Dataplex Universal Catalog entry. The entry link is the relationship between synonym terms.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the term that you want to create links with.

    3. Click Editnext to Related terms.

    4. Search for and then select the terms to link to.

      The term gets linked immediately when you select it.

    5. Click Close.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ TERM1_PROJECT_ID 
/locations/ TERM1_LOCATION_ID 
/entryGroups/@dataplex/entryLinks?entry_link_id = 
 ENTRY_LINK_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "entry_link_type" 
:  
 "projects/dataplex-types/locations/global/entryLinkTypes/related" 
, "entry_references" 
:  
 [{ 
  
 "name" 
:  
 "projects/ TERM1_PROJECT_NUMBER 
/locations/ TERM1_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM1_PROJECT_NUMBER 
/locations/ TERM1_LOCATION_ID 
/glossaries/ TERM1_GLOSSARY_ID 
/terms/ TERM1_ID 
" 
,  
 "type" 
:  
 "UNSPECIFIED" 
  
 } 
,  
 { 
  
 "name" 
:  
 "projects/ TERM2_PROJECT_NUMBER 
/locations/ TERM2_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM2_PROJECT_NUMBER 
/locations/ TERM2_LOCATION_ID 
/glossaries/ TERM2_GLOSSARY_ID 
/terms/ TERM2_ID 
" 
,  
 "type" 
:  
 "UNSPECIFIED" 
  
 } 
  
 ] 
 } 
EOF ) 
 "

    Replace the following:

    • TERM1_PROJECT_NUMBER : the project number for the first term being linked.
    • TERM1_LOCATION_ID : the location ID of the glossary that contains the first term.
    • TERM1_GLOSSARY_ID : the ID of the glossary that contains the first term.
    • TERM1_ID : the ID of the first term.
    • TERM2_PROJECT_NUMBER : the project number for the second term that you want to link to as a related term. If both terms are in the same project, then this value is the same as the project number for the first term.
    • TERM2_LOCATION_ID : the location ID of the glossary that contains the second term. If both terms are in the same location, then this value is the same as the location ID for the first term.
    • TERM2_GLOSSARY_ID : the ID of the glossary that contains the second term. If both terms are in the same glossary, then this value is the same as the glossary ID for the first term.
    • TERM2_ID : the ID of the second term.
    • ENTRY_LINK_ID : an ID for the link between the two terms. Each term is represented as a Dataplex Universal Catalog entry. The entry link is the relationship between related terms.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. Expand the glossary and click the term whose synonyms or related terms you want to remove.

    3. To delete links between related terms, click Editnext to Related terms. Delete the related terms, and then click Close.

    4. To delete links between synonyms, click Editnext to Synonym terms. Delete the synonyms, and then click Close.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
DELETE  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entryLinks/ ENTRY_LINK_ID

    You can attach terms to data assets or data asset columns. For example, you can attach terms to a BigQuery dataset.

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Searchpage.

      Go to Search

    2. Search for the data asset (such as a dataset, file, or table) that you want to link a term to, and then click it.

    3. On the data asset page, do one of the following:

      • To link terms to an asset, on the Detailstab, in the Glossary termssection, click Add. Search for and then select the terms, and then click Close.
      • If the asset has a schema, you can link terms to a column. On the Schematab, select a column to link terms to, and then click Add business term. Search for and then select the terms, and then click Close.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ ENTRY_LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entryLinks?entry_link_id = 
 ENTRY_LINK_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "entry_link_type" 
:  
 "projects/dataplex-types/locations/global/entryLinkTypes/definition" 
,  
 "entry_references" 
:  
 [{ 
  
 "name" 
:  
 "projects/ PROJECT_NUMBER 
/locations/ ENTRY_LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entries/ ENTRY_ID 
" 
,  
 "type" 
:  
 "SOURCE" 
  
 } 
,  
 { 
  
 "name" 
:  
 "projects/ TERM_PROJECT_NUMBER 
/locations/ TERM_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM_PROJECT_NUMBER 
/locations/ TERM_LOCATION_ID 
/glossaries/ TERM_GLOSSARY_ID 
/terms/ TERM_ID 
" 
,  
 "type" 
:  
 "TARGET" 
  
 } 
  
 ] 
 } 
EOF ) 
 "

    Replace the following:

    • PROJECT_NUMBER : the project number of the data asset being linked to
    • ENTRY_LOCATION_ID : the location ID of the data asset being linked to
    • ENTRY_GROUP_ID : the entry group of the data asset being linked to
    • ENTRY_LINK_ID : an ID for the link between the term and the Dataplex Universal Catalog entry that represents the data asset.
    • TERM_PROJECT_NUMBER : the project number for the term being linked.

    Attach terms to a column in an entry schema

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Searchpage.

      Go to Search

    2. Search for the data asset (such as a dataset, file, or table) that has a schema with a column you want to link a term to. Click the data asset.

    3. On the data asset page, do one of the following:

      • To link terms to a column in the data asset, on the schema tab, select the columns you want to attach the term to.
      • Click Add business term. Search for the term you want to attach and click the term to attach.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_NUMBER 
/locations/ ENTRY_LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entryLinks?entry_link_id = 
 ENTRY_LINK_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
 "entry_link_type" 
:  
 "projects/dataplex-types/locations/global/entryLinkTypes/definition" 
, "entry_references" 
:  
 [{ 
  
 "name" 
:  
 "projects/ PROJECT_NUMBER 
/locations/ ENTRY_LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entries/ ENTRY_ID 
" 
,  
 "type" 
:  
 "SOURCE" 
,  
 "path" 
:  
 "Schema. COLUMN_NAME 
" 
, } 
,  
 { 
  
 "name" 
:  
 "projects/ TERM_PROJECT_NUMBER 
/locations/ TERM_LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ TERM_PROJECT_NUMBER 
/locations/ TERM_LOCATION_ID 
/glossaries/ TERM_GLOSSARY_ID 
/terms/ TERM_ID 
" 
,  
 "type" 
:  
 "TARGET" 
 } 
 ] 
 } 
EOF ) 
 "

    Replace the following:

    • PROJECT_NUMBER : the project number of the data asset being linked to
    • ENTRY_LOCATION_ID : the location ID of the data asset being linked to
    • ENTRY_GROUP_ID : the entry group of the data asset being linked to
    • ENTRY_LINK_ID : an ID for the link between the term and the Dataplex Universal Catalog entry that represents the data asset
    • TERM_PROJECT_NUMBER : the project number for the term being linked
    • COLUMN_NAME : the column to which you want to attach the term

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Searchpage.

      Go to Search

    2. Search for the data asset (such as a dataset, file, or table) that you want to remove the terms from, and click it.

    3. On the data asset page, do one of the following:

      • To remove a term from an asset, on the Detailstab, in the Glossary termssection, click the term. Then click .
      • To remove a term from a column, on the Schematab, click next to the term.

    REST

     alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
DELETE  
https://dataplex.googleapis.com/v1/projects/ ENTRY_PROJECT_ID 
/locations/ ENTRY_LOCATION_ID 
/entryGroups/ ENTRY_GROUP_ID 
/entryLinks/ ENTRY_LINK_ID

    Find glossaries, terms, and linked data assets

    Console

    To navigate across your business glossary content, use the glossary and terms tree on the Glossariespage.

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. On the Glossariespage, use the filter bar to find categories. The following filters are available:

      • Name: returns the glossaries, categories, and terms whose name contains the text that you provide.
      • Parent: returns the terms whose parent glossary name or description matches the text that you provide. For example, parent:Finance returns the terms that are connected with the parent glossary whose name or description contains the phrase Finance .
      • Synonym: returns the list of terms with a synonym whose name or ID contains the text that you provide. For example, synonym:Profit returns the terms which have a synonym term whose name or ID contains the phrase profit .
      • Contact: returns the terms where the data steward is listed as a contact. For example, contact:alex@example.com returns the entries that are connected to terms with a data steward matching alex@example.com .

    REST

    To find glossaries, terms, and linked data assets by using the REST API, you need to sign up for Preview .

    Search for data assets linked to terms

    Console

    1. In the Google Cloud console, go to the Dataplex Universal Catalog Glossariespage.

      Go to Glossaries

    2. On the Glossariespage, use the filter bar to enter a free-form text search query. This returns a list of corresponding matches in the glossary, category, and term names.

    3. Click a matched term.

    4. On the Term detailspage, see the linked terms (synonyms and related terms) and linked entries (data assets) to this term.

    5. If you want to see the details for an entry in Dataplex Universal Catalog, click the entry.

    REST

    To find glossaries, terms, and linked data assets by using the REST API, you need to sign up for Preview .

    To import glossaries and links from another cataloging tool or to update your glossaries in Dataplex Universal Catalog, you can bulk import glossaries, categories, terms, links between terms, links between terms and data assets, or columns, using the REST API.

    1. Create the target glossary.

      REST

       alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
-X  
POST  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/glossaries?glossary_id = 
 GLOSSARY_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "displayName" 
:  
 " DISPLAY_NAME 
" 
,  
 "description" 
:  
 " DESCRIPTION 
" 
 } 
EOF ) 
 "

      Replace the following:

      • PROJECT_ID : the project ID in which you're creating the glossary
      • LOCATION_ID : the location in which we want to create the glossary
      • GLOSSARY_ID : the glossary ID
      • DISPLAY_NAME : the display name of the glossary
      • DESCRIPTION : the description of the glossary

    2. To import categories, terms, and links between terms and data assets in the target glossary created, upload files for each of these into a Cloud Storage bucket. These files are of the following format:

      • Sample format for terms and categories of a glossary

          
 { 
 "entry" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
" 
, "entryType" 
: "projects/dataplex-types/locations/global/entryTypes/glossary-category" 
, "aspects" 
: { 
 "dataplex-types.global.glossary-category-aspect" 
: { 
 "data" 
: {}} 
, "dataplex-types.global.overview" 
: { 
 "data" 
: { 
 "content" 
: " CONTENT 
" 
 }} 
, "dataplex-types.global.contacts" 
: { 
 "data" 
: { 
 "identities" 
: [{ 
role:  
 "steward" 
,  
name:  
 " CONTACT_DISPLAY_NAME 
" 
,  
id:  
 " CONTACT_EMAIL 
" 
 }]}}} 
, "parentEntry" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "entrySource" 
: { 
 "resource" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
" 
, "displayName" 
: " CATEGORY_NAME 
" 
, "description" 
: " CATEGORY_DESCRIPTION 
" 
, "ancestors" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "type" 
: "projects/dataplex-types/locations/global/entryTypes/glossary" 
 }]}}} 
  
 { 
 "entry" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM1_ID 
" 
, "entryType" 
: "projects/dataplex-types/locations/global/entryTypes/glossary-term" 
, "aspects" 
: { 
 "dataplex-types.global.glossary-term-aspect" 
: { 
 "data" 
: {}} 
, "dataplex-types.global.overview" 
: { 
 "data" 
: { 
 "content" 
: " TERM1_CONTENT 
" 
 }} 
, "dataplex-types.global.contacts" 
: { 
 "data" 
: { 
 "identities" 
: [{ 
role:  
 "steward" 
,  
name:  
 " CONTACT_DISPLAY_NAME 
" 
,  
id:  
 " CONTACT_EMAIL 
" 
 }]}}} 
, "parentEntry" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "entrySource" 
: { 
 "resource" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM1_ID 
" 
, "displayName" 
: " TERM1_DISPLAY_NAME 
" 
, "description" 
: " TERM1_DESCRIPTION 
" 
, "ancestors" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "type" 
: "projects/dataplex-types/locations/global/entryTypes/glossary" 
 } 
, { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
" 
, "type" 
: "projects/dataplex-types/locations/global/entryTypes/glossary-category" 
 }]}}} 
  
 { 
 "entry" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM2_ID 
" 
, "entryType" 
: "projects/dataplex-types/locations/global/entryTypes/glossary-term" 
, "aspects" 
: { 
 "dataplex-types.global.glossary-term-aspect" 
: { 
 "data" 
: {}} 
, "dataplex-types.global.overview" 
: { 
 "data" 
: { 
 "content" 
: " TERM1_CONTENT 
" 
 }} 
, "dataplex-types.global.contacts" 
: { 
 "data" 
: { 
 "identities" 
: [{ 
role:  
 "steward" 
,  
name:  
 " CONTACT_DISPLAY_NAME 
" 
,  
id:  
 " CONTACT_EMAIL 
" 
 }]}}} 
, "parentEntry" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "entrySource" 
: { 
 "resource" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/terms/ TERM2_ID 
" 
, "displayName" 
: " TERM2_DISPLAY_NAME 
" 
, "description" 
: " TERM2_DESCRIPTION 
" 
, "ancestors" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
" 
, "type" 
: "projects/dataplex-types/locations/global/entryTypes/glossary" 
 } 
, { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/ LOCATION_ID 
/glossaries/ GLOSSARY_ID 
/categories/ CATEGORY_ID 
" 
, "type" 
: "projects/dataplex-types/locations/global/entryTypes/glossary-category" 
 }]}}}

      • Sample format for links between terms

          
 { 
 "entryLink" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048" 
, "entryLinkType" 
: "projects/dataplex-types/locations/global/entryLinkTypes/synonym" 
, "entryReferences" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-1" 
 } 
, { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-2" 
 }]}} 
  
 { 
 "entryLink" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entryLinks/el-import-2f7408e3-af3d-405d-81bb-861cf9ec5146" 
, "entryLinkType" 
: "projects/dataplex-types/locations/global/entryLinkTypes/related" 
, "entryReferences" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-1" 
 } 
, { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-2" 
 }]}}

      • Sample format for links between terms and data assets

          
projects/ PROJECT_NUMBER 
/locations/us-central1/entryGroups/entry-group-1/entries/entry-1  
and  
term  
projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-1  
 { 
 "entryLink" 
: { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entryLinks/el-import-0606e3f2-8206-4f3a-aba9-32c6196f6048" 
, "entryLinkType" 
: "projects/dataplex-types/locations/global/entryLinkTypes/definition" 
, "entryReferences" 
: [{ 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/global/entryGroups/@dataplex/entries/projects/ PROJECT_NUMBER 
/locations/global/glossaries/import-glossary/terms/term-1" 
 } 
, { 
 "name" 
: "projects/ PROJECT_NUMBER 
/locations/us-central1/entryGroups/entry-group-1/entries/entry-1" 
 }]}} 
  

       # Set GCURL alias 
 alias 
  
 gcurl 
 = 
 'curl -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json"' 
gcurl  
https:// DATAPLEX_API 
/metadataJobs?metadata_job_id = 
 JOB_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "type" 
: "IMPORT" 
,  
 "import_spec" 
: { 
  
 "log_level" 
: "DEBUG" 
,  
 "source_storage_uri" 
: "gs:// STORAGE_BUCKET 
/" 
,  
 "entry_sync_mode" 
: "FULL" 
,  
 "aspect_sync_mode" 
: "INCREMENTAL" 
,  
 "scope" 
: { 
  
 "glossaries" 
:  
 " GLOSSARY_NAME 
" 
  
 } 
  
 } 
 } 
EOF ) 
 "

      Replace DATAPLEX_API with the Dataplex Universal Catalog API endpoint of the format dataplex.googleapis.com/v1/projects/ PROJECT_ID /locations/ LOCATION_ID .

    3. Optional: Get the status of the operation.

      gcurl  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/operations/operation- OPERATION_ID

      Replace OPERATION_ID with the ID of the operation.

    4. Optional: Get the status of the metadata job.

      gcurl  
-X  
GET  
https://dataplex.googleapis.com/v1/projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/metadataJobs/ JOB_ID

    5. Import links between terms as synonym or related terms.

      gcurl  
https:// DATAPLEX_API 
/metadataJobs?metadata_job_id = 
 JOB_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
  
 "type" 
: "IMPORT" 
,  
 "import_spec" 
: { 
  
 "log_level" 
: "DEBUG" 
,  
 "source_storage_uri" 
: "gs:// STORAGE_BUCKET 
/" 
,  
 "entry_sync_mode" 
: "FULL" 
,  
 "aspect_sync_mode" 
: "INCREMENTAL" 
,  
 "scope" 
: { 
  
 "entry_groups" 
: [ 
  
 "projects/ PROJECT_ID 
/locations/ LOCATION_ID 
/entryGroups/@dataplex" 
  
 ] 
,  
 "entry_link_types" 
: [ 
  
 "projects/dataplex-types/locations/global/entryLinkTypes/synonym" 
,  
 "projects/dataplex-types/locations/global/entryLinkTypes/related" 
  
 ] 
,  
 "referenced_entry_scopes" 
: [ 
  
 " PROJECT_IDS 
" 
  
 ] 
  
 } 
  
 } 
 } 
EOF ) 
 "

      Replace DATAPLEX_API with dataplex.googleapis.com/v1/projects/ PROJECT_ID /locations/ LOCATION_ID .

    6. Import links between terms and data assets or columns.

      To create a link between glossary terms and data assets, run the import job for each entry group to which the entry for the data asset belongs. All definition entry links are created in this entry group.

      gcurl  
https:// DATAPLEX_API 
/metadataJobs?metadata_job_id = 
 JOB_ID 
  
-d  
 " 
 $( 
cat<<EOF { 
 "type" 
: "IMPORT" 
, "import_spec" 
: { 
  
 "log_level" 
: "DEBUG" 
,  
 "source_storage_uri" 
: "gs:// STORAGE_BUCKET 
/" 
,  
 "entry_sync_mode" 
: "FULL" 
,  
 "aspect_sync_mode" 
: "INCREMENTAL" 
,  
 "scope" 
: { 
  
 "entry_groups" 
: [ 
  
 "projects/ PROJECT_ID 
/locations/ ENTRY_GROUP_LOCATION_ID 
/entryGroups/@dataplex" 
  
 ] 
,  
 "entry_link_types" 
: [ 
  
 "projects/dataplex-types/locations/global/entryLinkTypes/definition" 
  
 ] 
,  
 "referenced_entry_scopes" 
: [ 
  
 " PROJECT_IDS 
" 
  
 ] 
  
 } 
 } 
 } 
EOF ) 
 "

      Replace DATAPLEX_API with dataplex.googleapis.com/v1/projects/ PROJECT_ID /locations/ LOCATION_ID .

    Pricing

    Starting in July 2026, Dataplex Universal Catalog business glossary will be billed the same as the metadata storage pricing. See Dataplex Universal Catalog metadata storage pricing .

    What's next
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: