Retrieves a list of existing products.

## Explore further


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

- [Getting and listing resources](https://docs.cloud.google.com/vision/product-search/docs/get-list-resources)
- [List products](https://docs.cloud.google.com/vision/product-search/docs/samples/vision-product-search-list-products)

## 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"
    	"google.golang.org/api/iterator"
    )

    // listProducts lists products.
    func listProducts(w io.Writer, projectID string, location 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_ListProductsRequest{
    		Parent: fmt.Sprintf("projects/%s/locations/%s", projectID, location),
    	}

    	it := c.ListProducts(ctx, req)
    	for {
    		resp, err := it.Next()
    		if err == iterator.Done {
    			break
    		}
    		if err != nil {
    			return fmt.Errorf("Next: %w", err)
    		}

    		fmt.Fprintf(w, "Product name: %s\n", resp.Name)
    		fmt.Fprintf(w, "Product display name: %s\n", resp.DisplayName)
    		fmt.Fprintf(w, "Product category: %s\n", resp.ProductCategory)
    		fmt.Fprintf(w, "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).

    /**
     * List all products.
     *
     * @param projectId - Id of the project.
     * @param computeRegion - Region name.
     * @throws IOException - on I/O errors.
     */
    public static void listProducts(String projectId, String computeRegion) throws IOException {
      try (ProductSearchClient client = ProductSearchClient.create()) {

        // A resource that represents Google Cloud Platform location.
        String formattedParent = LocationName.format(projectId, computeRegion);

        // List all the products available in the region.
        for (Product product : client.listProducts(formattedParent).iterateAll()) {
          // Display the product information
          System.out.println(String.format("\nProduct name: %s", product.getName()));
          System.out.println(
              String.format(
                  "Product id: %s",
                  product.getName().substring(product.getName().lastIndexOf('/') + 1)));
          System.out.println(String.format("Product display name: %s", product.getDisplayName()));
          System.out.println(String.format("Product category: %s", product.getProductCategory()));
          System.out.println("Product labels:");
          System.out.println(
              String.format("Product labels: %s", product.getProductLabelsList().toString()));
        }
      }
    }

### 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 listProducts() {
      /**
       * TODO(developer): Uncomment the following line before running the sample.
       */
      // const projectId = 'Your Google Cloud project Id';
      // const location = 'A compute region name';

      // Resource path that represents Google Cloud Platform location.
      const locationPath = client.locationPath(projectId, location);

      const [products] = await client.listProducts({parent: locationPath});
      products.forEach(product => {
        console.log(`Product name: ${product.name}`);
        console.log(`Product id: ${product.name.split('/').pop()}`);
        console.log(`Product display name: ${product.displayName}`);
        console.log(`Product description: ${product.description}`);
        console.log(`Product category: ${product.productCategory}`);
        if (product.productLabels.length) {
          console.log('Product labels:');
          product.productLabels.forEach(productLabel => {
            console.log(`${productLabel.key}: ${productLabel.value}`);
          });
        }
      });
    }
    listProducts();

### 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 list_products(project_id, location):
        """List all products.
        Args:
            project_id: Id of the project.
            location: A compute region name.
        """
        client = vision.https://docs.cloud.google.com/python/docs/reference/vision/latest/google.cloud.vision_v1.services.product_search.ProductSearchClient.html()

        # A resource that represents Google Cloud Platform location.
        location_path = f"projects/{project_id}/locations/{location}"

        # List all the products available in the region.
        products = 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_list_products(parent=location_path)

        # Display the product information.
        for product in products:
            print(f"Product name: {product.name}")
            print("Product id: {}".format(product.name.split("/")[-1]))
            print(f"Product display name: {product.display_name}")
            print(f"Product description: {product.description}")
            print(f"Product category: {product.product_category}")
            print(f"Product labels: {product.product_labels}\n")


## 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).