Quickstart for tagging tables

In this quickstart, you:

Create a BigQuery dataset, and then copy public taxi data to a new table in your dataset.
Create a tag template with a schema that defines four tag fields of distinct types (string, double, boolean, and enumerated).
Lookup the Data Catalog entry for your table.
Attach the tag to your table.
For more information:
- Overview of Data Catalog tags.
- Data Discovery using Metadata.

Before you begin

Set up your project:
1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
2. In the Google Cloud Console, on the project selector page, select or create a Google Cloud project.
  
  Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.
  
  Go to project selector
3. Enable the Data Catalog and BigQuery APIs.
  Enable the APIs
4. Install and initialize the Cloud SDK.
  Note: You can run the gcloud tool in the Cloud Console without installing the Cloud SDK. To run the gcloud tool in the Cloud Console, use Cloud Shell .
Add a public dataset to your project.
1. Go to BigQuery in the Google Cloud Console.
2. In the left Explorer pane, click + ADD DATA and select Explore public datasets from the drop-down list.
3. In the Datasets panel, search for "New York taxi trips" and click the relevant search result.
4. In the dataset overview panel, click VIEW DATASET.
Create a new dataset. You must be the dataset owner to attach a tag to a table in the dataset as shown in this quickstart.
1. From BigQuery in the Google Cloud Console.
2. In the left Explorer pane, click your project ID, then click CREATE DATASET.
3. In the Create Dataset dialog:
  - For Dataset ID, enter "demo_dataset".
  - For Data location, accept the Default location, which sets the dataset location to US multi-region.
  - For Default data expiration, choose one of the following options:
    - Never: (Default) Tables created in the dataset are never automatically deleted. You must delete them manually.
    - Number of days after table creation: Any table created in the dataset is deleted after the specified days from its creation time. This value is applied if you do not set a table expiration when the table is created.
  - For Encryption, leave the Google-managed key option selected.
  - Click Create dataset.
Note: You cannot add a description or a label when you create a dataset using the Google Cloud Console. After the dataset is created, you can add a description, and you can add a label.
Copy a public New York Taxi table to your demo_dataset.
1. From BigQuery in the Google Cloud Console, in the left Explorer pane, search for "tlc_yellow_trips" tables and select one of them, such as tlc_yellow_trips_2017. Then click COPY TABLE.
2. In the Destination section of the Copy table dialog:
  1. Select your project from the Project name drop-down list.
  2. Select "demo_dataset" from the Dataset name drop-down list.
  3. Insert "trips" for the Table name, then click COPY.
3. In the left Explorer pane, confirm that the trips table is listed in your demo_dataset.
  
  You add Data Catalog tags to the table in the next section.

Create a tag template and attach the tag to your table

Console

You can create a tag template from the Data Catalog UI in the Google Cloud Console.

gcloud

Run the gcloud data-catalog tag-templates create command shown below to create a tag template with the following four tag fields (also called "attributes"):

display_name: Source of data asset
id: source
required: TRUE
type: String
display_name: Number of rows in the data asset
id: num_rows
required: FALSE
type: Double
display_name: Has PII
id: has_pii
required: FALSE
type: Boolean
display_name: PII type
id: pii_type
required: FALSE
type: Enumerated
values:
1. EMAIL_ADDRESS
2. US_SOCIAL_SECURITY_NUMBER
3. NONE

# -------------------------------
# Create a Tag Template.
# -------------------------------
gcloud data-catalog tag-templates create demo_template \
    --location=us-central1 \
    --display-name="Demo Tag Template" \
    --field=id=source,display-name="Source of data asset",type=string,required=TRUE \
    --field=id=num_rows,display-name="Number of rows in the data asset",type=double \
    --field=id=has_pii,display-name="Has PII",type=bool \
    --field=id=pii_type,display-name="PII type",type='enum(EMAIL_ADDRESS|US_SOCIAL_SECURITY_NUMBER|NONE)'

# -------------------------------
# Lookup the Data Catalog entry for the table.
# -------------------------------
ENTRY_NAME=$(gcloud data-catalog entries lookup '//bigquery.googleapis.com/projects/PROJECT_ID/datasets/DATASET/tables/TABLE' --format="value(name)")

# -------------------------------
# Attach a Tag to the table.
# -------------------------------

# Create the Tag file.
cat > tag_file.json << EOF
  {
    "source": "BigQuery",
    "num_rows": 1000,
    "has_pii": true,
    "pii_type": "EMAIL_ADDRESS"
  }
EOF

gcloud data-catalog tags create --entry=${ENTRY_NAME} \
    --tag-template=demo_template --tag-template-location=us-central1 --tag-file=tag_file.json

The location parameter specifies the Compute Engine resource region. Currently, Data Catalog supports only the us-central1 region.

Python

Install the client library
Set up application default credentials

Run the code

# -------------------------------
# Import required modules.
# -------------------------------
from google.cloud import datacatalog_v1

# -------------------------------
# Set your Google Cloud Platform project ID.
# -------------------------------
project_id = 'PROJECT'

# -------------------------------
# Set your BigQuery dataset and table name.
# -------------------------------
dataset_id = 'demo_dataset'
table_name = 'trips'

# -------------------------------
# Currently, Data Catalog stores metadata in the
# us-central1 region.
# -------------------------------
location = 'us-central1'

# -------------------------------
# Use Application Default Credentials to create a new
# Data Catalog client. GOOGLE_APPLICATION_CREDENTIALS
# environment variable must be set with the location
# of a service account key file.
# -------------------------------
datacatalog_client = datacatalog_v1.DataCatalogClient()

# -------------------------------
# Create a Tag Template.
# -------------------------------
tag_template = datacatalog_v1.types.TagTemplate()

tag_template.display_name = 'Demo Tag Template'

tag_template.fields['source'] = datacatalog_v1.types.TagTemplateField()
tag_template.fields['source'].display_name = 'Source of data asset'
tag_template.fields['source'].type_.primitive_type = datacatalog_v1.types.FieldType.PrimitiveType.STRING

tag_template.fields['num_rows'] = datacatalog_v1.types.TagTemplateField()
tag_template.fields['num_rows'].display_name = 'Number of rows in data asset'
tag_template.fields['num_rows'].type_.primitive_type = datacatalog_v1.types.FieldType.PrimitiveType.DOUBLE

tag_template.fields['has_pii'] = datacatalog_v1.types.TagTemplateField()
tag_template.fields['has_pii'].display_name = 'Has PII'
tag_template.fields['has_pii'].type_.primitive_type = datacatalog_v1.types.FieldType.PrimitiveType.BOOL

tag_template.fields['pii_type'] = datacatalog_v1.types.TagTemplateField()
tag_template.fields['pii_type'].display_name = 'PII type'

for display_name in ['EMAIL_ADDRESS', 'US_SOCIAL_SECURITY_NUMBER', 'NONE']:
    enum_value = datacatalog_v1.types.FieldType.EnumType.EnumValue(display_name = display_name)
    tag_template.fields['pii_type'].type_.enum_type.allowed_values.append(enum_value)

expected_template_name = datacatalog_v1.DataCatalogClient\
    .tag_template_path(project_id, location, 'example_tag_template')

# Delete any pre-existing Template with the same name.
try:
    datacatalog_client.delete_tag_template(name=expected_template_name, force=True)
    print('Deleted template: {}'.format(expected_template_name))
except:
    print('Cannot delete template: {}'.format(expected_template_name))

# Create the Tag Template.
try:
    tag_template = datacatalog_client.create_tag_template(
        parent='projects/{}/locations/us-central1'.format(project_id),
        tag_template_id='example_tag_template',
        tag_template=tag_template)
    print('Created template: {}'.format(tag_template.name))
except OSError as e:
    print('Cannot create template: {}'.format(expected_template_name))
    print('{}'.format(e))

# -------------------------------
# Lookup Data Catalog's Entry referring to the table.
# -------------------------------
resource_name = '//bigquery.googleapis.com/projects/{}' \
                '/datasets/{}/tables/{}'.format(project_id, dataset_id, table_name)
table_entry = datacatalog_client.lookup_entry(request={"linked_resource": resource_name})

# -------------------------------
# Attach a Tag to the table.
# -------------------------------
tag = datacatalog_v1.types.Tag()

tag.template = tag_template.name
tag.name="my_tag"

tag.fields['source'] = datacatalog_v1.types.TagField()
tag.fields['source'].string_value = 'Copied from tlc_yellow_trips_2018'

tag.fields['num_rows'] = datacatalog_v1.types.TagField()
tag.fields['num_rows'].double_value = 113496874

tag.fields['has_pii'] = datacatalog_v1.types.TagField()
tag.fields['has_pii'].bool_value = False

tag.fields['pii_type'] = datacatalog_v1.types.TagField()
tag.fields['pii_type'].enum_value.display_name = 'NONE'

tag = datacatalog_client.create_tag(parent=table_entry.name, tag=tag)
print('Created tag: {}'.format(tag.name))

Java

Install the client library
Set up application default credentials

Run the code

/*
This application demonstrates how to perform core operations with the
Data Catalog API.

For more information, see the README.md and the official documentation at
https://cloud.google.com/data-catalog/docs.
*/

package com.example.datacatalog;

import com.google.cloud.datacatalog.v1.CreateTagRequest;
import com.google.cloud.datacatalog.v1.CreateTagTemplateRequest;
import com.google.cloud.datacatalog.v1.DataCatalogClient;
import com.google.cloud.datacatalog.v1.DeleteTagTemplateRequest;
import com.google.cloud.datacatalog.v1.Entry;
import com.google.cloud.datacatalog.v1.FieldType;
import com.google.cloud.datacatalog.v1.FieldType.EnumType;
import com.google.cloud.datacatalog.v1.FieldType.EnumType.EnumValue;
import com.google.cloud.datacatalog.v1.FieldType.PrimitiveType;
import com.google.cloud.datacatalog.v1.LocationName;
import com.google.cloud.datacatalog.v1.LookupEntryRequest;
import com.google.cloud.datacatalog.v1.Tag;
import com.google.cloud.datacatalog.v1.TagField;
import com.google.cloud.datacatalog.v1.TagTemplate;
import com.google.cloud.datacatalog.v1.TagTemplateField;
import com.google.cloud.datacatalog.v1.TagTemplateName;

public class CreateTags {

  public static void createTags() {
    // TODO(developer): Replace these variables before running the sample.
    String projectId = "my-project";
    String tagTemplateId = "my_tag_template";
    createTags(projectId, tagTemplateId);
  }

  public static void createTags(String projectId, String tagTemplateId) {
    // Currently, Data Catalog stores metadata in the us-central1 region.
    String location = "us-central1";

    // Initialize client that will be used to send requests. This client only needs to be created
    // once, and can be reused for multiple requests. After completing all of your requests, call
    // the "close" method on the client to safely clean up any remaining background resources.
    try (DataCatalogClient dataCatalogClient = DataCatalogClient.create()) {

      // -------------------------------
      // Create a Tag Template.
      // -------------------------------
      TagTemplateField sourceField =
          TagTemplateField.newBuilder()
              .setDisplayName("Source of data asset")
              .setType(FieldType.newBuilder().setPrimitiveType(PrimitiveType.STRING).build())
              .build();

      TagTemplateField numRowsField =
          TagTemplateField.newBuilder()
              .setDisplayName("Number of rows in data asset")
              .setType(FieldType.newBuilder().setPrimitiveType(PrimitiveType.DOUBLE).build())
              .build();

      TagTemplateField hasPiiField =
          TagTemplateField.newBuilder()
              .setDisplayName("Has PII")
              .setType(FieldType.newBuilder().setPrimitiveType(PrimitiveType.BOOL).build())
              .build();

      TagTemplateField piiTypeField =
          TagTemplateField.newBuilder()
              .setDisplayName("PII type")
              .setType(
                  FieldType.newBuilder()
                      .setEnumType(
                          EnumType.newBuilder()
                              .addAllowedValues(
                                  EnumValue.newBuilder().setDisplayName("EMAIL_ADDRESS").build())
                              .addAllowedValues(
                                  EnumValue.newBuilder()
                                      .setDisplayName("US_SOCIAL_SECURITY_NUMBER")
                                      .build())
                              .addAllowedValues(
                                  EnumValue.newBuilder().setDisplayName("NONE").build())
                              .build())
                      .build())
              .build();

      TagTemplate tagTemplate =
          TagTemplate.newBuilder()
              .setDisplayName("Demo Tag Template")
              .putFields("source", sourceField)
              .putFields("num_rows", numRowsField)
              .putFields("has_pii", hasPiiField)
              .putFields("pii_type", piiTypeField)
              .build();

      CreateTagTemplateRequest createTagTemplateRequest =
          CreateTagTemplateRequest.newBuilder()
              .setParent(
                  LocationName.newBuilder()
                      .setProject(projectId)
                      .setLocation(location)
                      .build()
                      .toString())
              .setTagTemplateId("demo_tag_template")
              .setTagTemplate(tagTemplate)
              .build();

      String expectedTemplateName =
          TagTemplateName.newBuilder()
              .setProject(projectId)
              .setLocation(location)
              .setTagTemplate("demo_tag_template")
              .build()
              .toString();

      // Delete any pre-existing Template with the same name.
      try {
        dataCatalogClient.deleteTagTemplate(
            DeleteTagTemplateRequest.newBuilder()
                .setName(expectedTemplateName)
                .setForce(true)
                .build());

        System.out.println(String.format("Deleted template: %s", expectedTemplateName));
      } catch (Exception e) {
        System.out.println(String.format("Cannot delete template: %s", expectedTemplateName));
      }

      // Create the Tag Template.
      tagTemplate = dataCatalogClient.createTagTemplate(createTagTemplateRequest);
      System.out.println(String.format("Template created with name: %s", tagTemplate.getName()));

      // -------------------------------
      // Lookup Data Catalog's Entry referring to the table.
      // -------------------------------
      String linkedResource =
          String.format(
              "//bigquery.googleapis.com/projects/%s/datasets/demo_dataset/tables/trips",
              projectId);
      LookupEntryRequest lookupEntryRequest =
          LookupEntryRequest.newBuilder().setLinkedResource(linkedResource).build();
      Entry tableEntry = dataCatalogClient.lookupEntry(lookupEntryRequest);

      // -------------------------------
      // Attach a Tag to the table.
      // -------------------------------
      TagField sourceValue =
          TagField.newBuilder().setStringValue("Copied from tlc_yellow_trips_2017").build();
      TagField numRowsValue = TagField.newBuilder().setDoubleValue(113496874).build();
      TagField hasPiiValue = TagField.newBuilder().setBoolValue(false).build();
      TagField piiTypeValue =
          TagField.newBuilder()
              .setEnumValue(TagField.EnumValue.newBuilder().setDisplayName("NONE").build())
              .build();

      Tag tag =
          Tag.newBuilder()
              .setTemplate(tagTemplate.getName())
              .putFields("source", sourceValue)
              .putFields("num_rows", numRowsValue)
              .putFields("has_pii", hasPiiValue)
              .putFields("pii_type", piiTypeValue)
              .build();

      CreateTagRequest createTagRequest =
          CreateTagRequest.newBuilder().setParent(tableEntry.getName()).setTag(tag).build();

      dataCatalogClient.createTag(createTagRequest);

    } catch (Exception e) {
      System.out.print("Error during CreateTags:\n" + e.toString());
    }
  }
}

Node.js

Install the client library
Set up application default credentials

Run the code

async function main() {
    // -------------------------------
    // Import required modules.
    // -------------------------------
    const { DataCatalogClient } = require('@google-cloud/datacatalog').v1;

    // Common fields.
    let request;
    let responses;

    // -------------------------------
    // Set your Google Cloud Platform project ID.
    // -------------------------------
    const projectId = 'PROJECT_ID';

    // -------------------------------
    // Currently, Data Catalog stores metadata in the
    // us-central1 region.
    // -------------------------------
    const location = 'us-central1';

    // -------------------------------
    // Use Application Default Credentials to create a new
    // Data Catalog client. GOOGLE_APPLICATION_CREDENTIALS
    // environment variable must be set with the location
    // of a service account key file.
    // -------------------------------
    const datacatalog = new DataCatalogClient();

    // Create Fields.
    const fieldSource = {
        displayName: 'Source of data asset',
        type: {
            primitiveType: 'STRING',
        },
    };

    const fieldNumRows = {
        displayName: 'Number of rows in data asset',
        type: {
            primitiveType: 'DOUBLE',
        },
    };

    const fieldHasPII = {
        displayName: 'Has PII',
        type: {
            primitiveType: 'BOOL',
        },
    };

    const fieldPIIType = {
        displayName: 'PII type',
        type: {
            enumType: {
                allowedValues: [
                    {
                        displayName: 'EMAIL_ADDRESS',
                    },
                    {
                        displayName: 'US_SOCIAL_SECURITY_NUMBER',
                    },
                    {
                        displayName: 'NONE',
                    },
                ],
            },
        },
    };

    // -------------------------------
    // Create Tag Template.
    // -------------------------------
    const tagTemplateId = 'demo_tag_template';

    const tagTemplate = {
        displayName: 'Demo Tag Template',
        fields: {
            source: fieldSource,
            num_rows: fieldNumRows,
            has_pii: fieldHasPII,
            pii_type: fieldPIIType,
        },
    };

    const tagTemplatePath = datacatalog.tagTemplatePath(
        projectId,
        location,
        tagTemplateId
    );

    // Delete any pre-existing Template with the same name.
    try {
        request = {
            name: tagTemplatePath,
            force: true,
        };
        await datacatalog.deleteTagTemplate(request);
        console.log(`Deleted template: ${tagTemplatePath}`);
    } catch (error) {
        console.log(`Cannot delete template: ${tagTemplatePath}`);
    }

    // Create the Tag Template request.
    const locationPath = datacatalog.locationPath(projectId, location);

    request = {
        parent: locationPath,
        tagTemplateId: tagTemplateId,
        tagTemplate: tagTemplate,
    };

    // Execute the request.
    responses = await datacatalog.createTagTemplate(request);
    const createdTagTemplate = responses[0];
    console.log(`Created template: ${createdTagTemplate.name}`);

    // -------------------------------
    // Lookup Data Catalog's Entry referring to the table.
    // -------------------------------
    responses = await datacatalog.lookupEntry({
        linkedResource: `//bigquery.googleapis.com/projects/` +
            `${projectId}/datasets/demo_dataset/tables/trips`,
    });
    const entry = responses[0];
    console.log(`Entry name: ${entry.name}`);
    console.log(`Entry type: ${entry.type}`);
    console.log(`Linked resource: ${entry.linkedResource}`);

    // -------------------------------
    // Attach a Tag to the table.
    // -------------------------------
    const tag = {
        name: entry.name,
        template: createdTagTemplate.name,
        fields: {
            source: {
                stringValue: 'Copied from tlc_yellow_trips_2017',
            },
            num_rows: {
                doubleValue: 113496874,
            },
            has_pii: {
                boolValue: false,
            },
            pii_type: {
                enumValue: {
                    displayName: 'NONE',
                },
            },
        },
    };

    request = {
        parent: entry.name,
        tag: tag,
    };

    // Create the Tag.
    await datacatalog.createTag(request);
    console.log(`Tag created for entry: ${entry.name}`);
}

main();

REST & CMD LINE

If you do not have access to Cloud Client libraries for your language or want to test the API using REST requests, see the following examples and refer to the Data Catalog REST API documentation.

1. Create a tag template.

Before using any of the request data below, make the following replacements:

project-id: your GCP project ID

HTTP method and URL:

POST https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/tagTemplates?tagTemplateId=demo_tag_template

Request JSON body:

{
  "displayName":"Demo Tag Template",
  "fields":{
    "source":{
      "displayName":"Source of data asset",
      "isRequired": "true",
      "type":{
        "primitiveType":"STRING"
      }
    },
    "num_rows":{
      "displayName":"Number of rows in data asset",
      "isRequired": "false",
      "type":{
        "primitiveType":"DOUBLE"
      }
    },
    "has_pii":{
      "displayName":"Has PII",
      "isRequired": "false",
      "type":{
        "primitiveType":"BOOL"
      }
    },
    "pii_type":{
      "displayName":"PII type",
      "isRequired": "false",
      "type":{
        "enumType":{
          "allowedValues":[
            {
              "displayName":"EMAIL_ADDRESS"
            },
            {
              "displayName":"US_SOCIAL_SECURITY_NUMBER"
            },
            {
              "displayName":"NONE"
            }
          ]
        }
      }
    }
  }
}

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Save the request body in a file called request.json, and execute the following command:

curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/tagTemplates?tagTemplateId=demo_tag_template

PowerShell (Windows)

Save the request body in a file called request.json, and execute the following command:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method POST `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/tagTemplates?tagTemplateId=demo_tag_template" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template",
  "displayName":"Demo Tag Template",
  "fields":{
    "num_rows":{
      "displayName":"Number of rows in data asset",
      "isRequired": "false",
      "type":{
        "primitiveType":"DOUBLE"
      }
    },
    "has_pii":{
      "displayName":"Has PII",
      "isRequired": "false",
      "type":{
        "primitiveType":"BOOL"
      }
    },
    "pii_type":{
      "displayName":"PII type",
      "isRequired": "false",
      "type":{
        "enumType":{
          "allowedValues":[
            {
              "displayName":"EMAIL_ADDRESS"
            },
            {
              "displayName":"NONE"
            },
            {
              "displayName":"US_SOCIAL_SECURITY_NUMBER"
            }
          ]
        }
      }
    },
    "source":{
      "displayName":"Source of data asset",
      "isRequired":"true",
      "type":{
        "primitiveType":"STRING"
      }
    }
  }
}

2. Lookup the Data Catalog `entry-id` for your BigQuery table.

Before using any of the request data below, make the following replacements:

project-id: GCP project ID

HTTP method and URL:

GET https://datacatalog.googleapis.com/v1/entries:lookup?linkedResource=//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips

Request JSON body:

Request body is empty.

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Save the request body in a file called request.json, and execute the following command:

curl -X GET \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://datacatalog.googleapis.com/v1/entries:lookup?linkedResource=//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips

PowerShell (Windows)

Save the request body in a file called request.json, and execute the following command:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method GET `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://datacatalog.googleapis.com/v1/entries:lookup?linkedResource=//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name": "projects/project-id/locations/US/entryGroups/@bigquery/entries/entry-id",
  "type": "TABLE",
  "schema": {
    "columns": [
      {
        "type": "STRING",
        "description": "A code indicating the TPEP provider that provided the record. 1= ",
        "mode": "REQUIRED",
        "column": "vendor_id"
      },
      ...
    ]
  },
  "sourceSystemTimestamps": {
    "createTime": "2019-01-25T01:45:29.959Z",
    "updateTime": "2019-03-19T23:20:26.540Z"
  },
  "linkedResource": "//bigquery.googleapis.com/projects/project-id/datasets/demo_dataset/tables/trips",
  "bigqueryTableSpec": {
    "tableSourceType": "BIGQUERY_TABLE"
  }
}

3. Create a tag from the template and attach it to your BigQuery table.

Before using any of the request data below, make the following replacements:

project-id: GCP project ID
entry-id: Data Catalog entry ID for the Demo Dataset trips table (returned in the lookup results in the previous step).

HTTP method and URL:

POST https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/entryGroups/@bigquery/entries/entry-id/tags?tagTemplateId=demo_tag_template

Request JSON body:

{
  "template":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template",
  "fields":{
    "source":{
      "stringValue":"Copied from tlc_yellow_trips_2017"
    },
    "num_rows":{
      "doubleValue":113496874
    },
    "has_pii":{
      "boolValue":false
    },
    "pii_type":{
      "enumValue":{
        "displayName":"NONE"
      }
    }
  }
}

To send your request, expand one of these options:

curl (Linux, macOS, or Cloud Shell)

Save the request body in a file called request.json, and execute the following command:

curl -X POST \
-H "Authorization: Bearer "$(gcloud auth application-default print-access-token) \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/entryGroups/@bigquery/entries/entry-id/tags?tagTemplateId=demo_tag_template

PowerShell (Windows)

Save the request body in a file called request.json, and execute the following command:

$cred = gcloud auth application-default print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
  -Method POST `
  -Headers $headers `
  -ContentType: "application/json; charset=utf-8" `
  -InFile request.json `
  -Uri "https://datacatalog.googleapis.com/v1/projects/project-id/locations/us-central1/entryGroups/@bigquery/entries/entry-id/tags?tagTemplateId=demo_tag_template" | Select-Object -Expand Content

You should receive a JSON response similar to the following:

{
  "name":"projects/project-id/locations/US/entryGroups/@bigquery/entries/entry-id/tags/tag-id",
  "template":"projects/project-id/locations/us-central1/tagTemplates/demo_tag_template",
  "fields":{
    "pii_type":{
      "displayName":"PII type",
      "enumValue":{
        "displayName":"NONE"
      }
    },
    "has_pii":{
      "displayName":"Has PII",
      "boolValue":false
    },
    "source":{
      "displayName":"Source of data asset",
      "stringValue":"Copied from tlc_yellow_trips_2017"
    },
    "num_rows":{
      "displayName":"Number of rows in data asset",
      "doubleValue":113496874
    }
  },
  "templateDisplayName":"Demo Tag Template"
}

Clean up

To avoid incurring charges to your Google Cloud account for the resources used in this quickstart, follow these steps.

Deleting the project

The easiest way to eliminate billing is to delete the project that you created for the tutorial.

To delete the project:

In the Cloud Console, go to the Manage resources page.
Go to Manage resources
In the project list, select the project that you want to delete, and then click Delete.
In the dialog, type the project ID, and then click Shut down to delete the project.

Deleting the dataset

If necessary, open the BigQuery web UI.

Go to the BigQuery web UI
In the navigation panel, in the Resources section, click the demo_dataset dataset you created.
In the details panel, on the right side, click Delete dataset. This action deletes the dataset, the table, and all the data.
In the Delete dataset dialog box, confirm the delete command by typing the name of your dataset (demo_dataset) and then click Delete.

Deleting the tag template

Open the Data Catalog UI in the Google Cloud Console. Under Tag Template, click Manage tag templates.
Click Demo Tag Template.
On the Tag Template page, click Delete to delete the Demo Tag Template.

What's next

Read the Data Catalog Overview
Learn How to search with Data Catalog
Browse the Overview of APIs and Client Libraries.

Quickstart for tagging tables

Before you begin

Create a tag template and attach the tag to your table

Console

gcloud

Python

Java

Node.js

REST & CMD LINE

1. Create a tag template.

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

2. Lookup the Data Catalog entry-id for your BigQuery table.

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

3. Create a tag from the template and attach it to your BigQuery table.

curl (Linux, macOS, or Cloud Shell)

PowerShell (Windows)

Clean up

Deleting the project

Deleting the dataset

Deleting the tag template

What's next

2. Lookup the Data Catalog `entry-id` for your BigQuery table.