Update labels for a product.

## Explore further


For detailed documentation that includes this code sample, see the following:

- [Product Search Tutorial](https://docs.cloud.google.com/vision/product-search/docs/tutorial)
- [Update product labels](https://docs.cloud.google.com/vision/product-search/docs/samples/vision-product-search-update-product-labels)
- [Updating resources](https://docs.cloud.google.com/vision/product-search/docs/update-resources)

## Code sample

### Go


Before trying this sample, follow the Go setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Go API
reference documentation](https://godoc.org/cloud.google.com/go/vision/apiv1).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).


    import (
    	"context"
    	"fmt"
    	"io"

    	vision "cloud.google.com/go/vision/apiv1"
    	"cloud.google.com/go/vision/v2/apiv1/visionpb"
    	field_mask "google.golang.org/genproto/protobuf/field_mask"
    )

    // updateProductLabels updates product labels of a product.
    func updateProductLabels(w io.Writer, projectID string, location string, productID string, key string, value string) error {
    	ctx := context.Background()
    	c, err := vision.NewProductSearchClient(ctx)
    	if err != nil {
    		return fmt.Errorf("NewProductSearchClient: %w", err)
    	}
    	defer c.Close()

    	req := &visionpb.https://docs.cloud.google.com/go/docs/reference/cloud.google.com/go/vision/v2/latest/apiv1/visionpb.html#cloud_google_com_go_vision_v2_apiv1_visionpb_UpdateProductRequest{
    		UpdateMask: &field_mask.FieldMask{
    			Paths: []string{
    				"product_labels",
    			},
    		},
    		Product: &visionpb.https://docs.cloud.google.com/go/docs/reference/cloud.google.com/go/vision/v2/latest/apiv1/visionpb.html#cloud_google_com_go_vision_v2_apiv1_visionpb_Product{
    			Name: fmt.Sprintf("projects/%s/locations/%s/products/%s", projectID, location, productID),
    			ProductLabels: []*visionpb.https://docs.cloud.google.com/go/docs/reference/cloud.google.com/go/vision/v2/latest/apiv1/visionpb.html#cloud_google_com_go_vision_v2_apiv1_visionpb_Product_KeyValue{
    				{
    					Key:   key,
    					Value: value,
    				},
    			},
    		},
    	}

    	resp, err := c.UpdateProduct(ctx, req)
    	if err != nil {
    		return fmt.Errorf("UpdateProduct: %w", err)
    	}

    	fmt.Fprintf(w, "Product name: %s\n", resp.Name)
    	fmt.Fprintf(w, "Updated product labels: %s\n", resp.ProductLabels)

    	return nil
    }

### Java


Before trying this sample, follow the Java setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Java API
reference documentation](https://docs.cloud.google.com/java/docs/reference/google-cloud-vision/latest/overview).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    /**
     * Update the product labels.
     *
     * @param projectId - Id of the project.
     * @param computeRegion - Region name.
     * @param productId -Id of the product.
     * @param productLabels - Labels of the product.
     * @throws IOException - on I/O errors.
     */
    public static void updateProductLabels(
        String projectId, String computeRegion, String productId, String productLabels)
        throws IOException {
      try (ProductSearchClient client = ProductSearchClient.create()) {

        // Get the full path of the product.
        String formattedName = ProductName.format(projectId, computeRegion, productId);

        // Set product name, product labels and product display name.
        // Multiple labels are also supported.
        Product product =
            Product.newBuilder()
                .setName(formattedName)
                .addProductLabels(
                    KeyValue.newBuilder()
                        .setKey(productLabels.split(",")[0].split("=")[0])
                        .setValue(productLabels.split(",")[0].split("=")[1])
                        .build())
                .build();

        // Set product update field name.
        FieldMask updateMask = FieldMask.newBuilder().addPaths("product_labels").build();

        // Update the product.
        Product updatedProduct = client.updateProduct(product, updateMask);
        // Display the product information
        System.out.println(String.format("Product name: %s", updatedProduct.getName()));
        System.out.println(String.format("Updated product labels: "));
        for (Product.KeyValue element : updatedProduct.getProductLabelsList()) {
          System.out.println(String.format("%s: %s", element.getKey(), element.getValue()));
        }
      }
    }

### Node.js


Before trying this sample, follow the Node.js setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Node.js API
reference documentation](https://googleapis.dev/nodejs/vision/latest).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    // Imports the Google Cloud client library
    const vision = require('https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/overview.html');

    // Creates a client
    const client = new vision.https://docs.cloud.google.com/nodejs/docs/reference/vision/latest/overview.html();

    async function updateProductLabels() {
      /**
       * TODO(developer): Uncomment the following line before running the sample.
       */
      // const projectId = 'Your Google Cloud project Id';
      // const location = 'A compute region name';
      // const productId = 'Id of the product';
      // const key = 'The key of the label';
      // const value = 'The value of the label';

      // Resource path that represents full path to the product.
      const productPath = client.productPath(projectId, location, productId);

      const product = {
        name: productPath,
        productLabels: [
          {
            key: key,
            value: value,
          },
        ],
      };

      const updateMask = {
        paths: ['product_labels'],
      };

      const request = {
        product: product,
        updateMask: updateMask,
      };

      const [updatedProduct] = await client.updateProduct(request);
      console.log(`Product name: ${updatedProduct.name}`);
      console.log(`Product display name: ${updatedProduct.displayName}`);
      console.log(`Product description: ${updatedProduct.description}`);
      console.log(`Product category: ${updatedProduct.productCategory}`);
      console.log(
        `Product Labels: ${updatedProduct.productLabels[0].key}: ${updatedProduct.productLabels[0].value}`
      );
    }
    updateProductLabels();

### Python


Before trying this sample, follow the Python setup instructions in the
[Vision quickstart using
client libraries](https://docs.cloud.google.com/vision/docs/quickstart-client-libraries).


For more information, see the
[Vision Python API
reference documentation](https://docs.cloud.google.com/python/docs/reference/vision/latest).


To authenticate to Vision, set up Application Default Credentials.
For more information, see

[Set up authentication for a local development environment](https://docs.cloud.google.com/docs/authentication/set-up-adc-local-dev-environment).

    from google.cloud import vision
    from google.protobuf import field_mask_pb2 as field_mask

    def update_product_labels(project_id, location, product_id, key, value):
        """Update the product labels.
        Args:
            project_id: Id of the project.
            location: A compute region name.
            product_id: Id of the product.
            key: The key of the label.
            value: The value of the label.
        """
        client = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html()

        # Get the name of the product.
        product_path = client.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html#google_cloud_vision_v1_services_product_search_ProductSearchClient_product_path(
            project=project_id, location=location, product=product_id
        )

        # Set product name, product label and product display name.
        # Multiple labels are also supported.
        key_value = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.Product.html.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.Product.KeyValue.html(key=key, value=value)
        product = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.types.Product.html(name=product_path, product_labels=[key_value])

        # Updating only the product_labels field here.
        update_mask = field_mask.FieldMask(paths=["product_labels"])

        # This overwrites the product_labels.
        updated_product = client.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html#google_cloud_vision_v1_services_product_search_ProductSearchClient_update_product(product=product, update_mask=update_mask)

        # Display the updated product information.
        print(f"Product name: {updated_product.name}")
        print(f"Updated product labels: {product.product_labels}")


## What's next


To search and filter code samples for other Google Cloud products, see the
[Google Cloud sample browser](https://docs.cloud.google.com/docs/samples?product=cloudvision).