Reference documentation and code samples for the Cloud Vision V1 Client class ImportProductSetsGcsSource.
The Google Cloud Storage location for a csv file which preserves a list of
ImportProductSetRequests in each line.
Generated from protobuf message google.cloud.vision.v1.ImportProductSetsGcsSource
Namespace
Google \ Cloud \ Vision \ V1
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ csv_file_uri
string
The Google Cloud Storage URI of the input csv file. The URI must start with gs://. The format of the input csv file should be one image per line. In each line, there are 8 columns. 1. image-uri 2. image-id 3. product-set-id 4. product-id 5. product-category 6. product-display-name 7. labels 8. bounding-poly The image-uri, product-set-id, product-id, and product-category columns are required. All other columns are optional. If the ProductSet or Product specified by the product-set-id and product-id values does not exist, then the system will create a new ProductSet or Product for the image. In this case, the product-display-name column refers to display_name, the product-category column refers to product_category, and the labels column refers to product_labels. The image-id column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The product-display-name column is optional. If it is empty, the system sets the display_name field for the product to a space (" "). You can update the display_name later by using the API. If a Product with the specified product-id already exists, then the system ignores the product-display-name, product-category, and labels columns. The labels column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: "key_1=value_1,key_2=value_2,...,key_n=value_n" The bounding-poly column (optional) identifies one region of interest from the image in the same manner as CreateReferenceImage. If you do not specify the bounding-poly column, then the system will try to detect regions of interest automatically. At most one bounding-poly column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the bounding-poly values for each region of interest. The bounding-poly column must contain an even number of comma-separated numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use non-negative integers for absolute bounding polygons, and float values in [0, 1] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP).
getCsvFileUri
The Google Cloud Storage URI of the input csv file.
The URI must start with gs://.
The format of the input csv file should be one image per line.
In each line, there are 8 columns.
image-uri
image-id
product-set-id
product-id
product-category
product-display-name
labels
bounding-poly
The image-uri, product-set-id, product-id, and product-category
columns are required. All other columns are optional.
If the ProductSet or Product specified by the product-set-id and
product-id values does not exist, then the system will create a new
ProductSet or Product for the image. In this case, the
product-display-name column refers to
display_name, the
product-category column refers to
product_category, and
the labels column refers to
product_labels.
The image-id column is optional but must be unique if provided. If it is
empty, the system will automatically assign a unique id to the image.
The product-display-name column is optional. If it is empty, the system
sets the display_name field
for the product to a space (" "). You can update the display_name later
by using the API.
If a Product with the specified product-id already exists, then the
system ignores the product-display-name, product-category, and labels
columns.
The labels column (optional) is a line containing a list of
comma-separated key-value pairs, in the following format:
"key_1=value_1,key_2=value_2,...,key_n=value_n"
The bounding-poly column (optional) identifies one region of
interest from the image in the same manner as CreateReferenceImage. If
you do not specify the bounding-poly column, then the system will try to
detect regions of interest automatically.
At most one bounding-poly column is allowed per line. If the image
contains multiple regions of interest, add a line to the CSV file that
includes the same product information, and the bounding-poly values for
each region of interest.
The bounding-poly column must contain an even number of comma-separated
numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use
non-negative integers for absolute bounding polygons, and float values
in [0, 1] for normalized bounding polygons.
The system will resize the image if the image resolution is too
large to process (larger than 20MP).
Returns
Type
Description
string
setCsvFileUri
The Google Cloud Storage URI of the input csv file.
The URI must start with gs://.
The format of the input csv file should be one image per line.
In each line, there are 8 columns.
image-uri
image-id
product-set-id
product-id
product-category
product-display-name
labels
bounding-poly
The image-uri, product-set-id, product-id, and product-category
columns are required. All other columns are optional.
If the ProductSet or Product specified by the product-set-id and
product-id values does not exist, then the system will create a new
ProductSet or Product for the image. In this case, the
product-display-name column refers to
display_name, the
product-category column refers to
product_category, and
the labels column refers to
product_labels.
The image-id column is optional but must be unique if provided. If it is
empty, the system will automatically assign a unique id to the image.
The product-display-name column is optional. If it is empty, the system
sets the display_name field
for the product to a space (" "). You can update the display_name later
by using the API.
If a Product with the specified product-id already exists, then the
system ignores the product-display-name, product-category, and labels
columns.
The labels column (optional) is a line containing a list of
comma-separated key-value pairs, in the following format:
"key_1=value_1,key_2=value_2,...,key_n=value_n"
The bounding-poly column (optional) identifies one region of
interest from the image in the same manner as CreateReferenceImage. If
you do not specify the bounding-poly column, then the system will try to
detect regions of interest automatically.
At most one bounding-poly column is allowed per line. If the image
contains multiple regions of interest, add a line to the CSV file that
includes the same product information, and the bounding-poly values for
each region of interest.
The bounding-poly column must contain an even number of comma-separated
numbers, in the format "p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y". Use
non-negative integers for absolute bounding polygons, and float values
in [0, 1] for normalized bounding polygons.
The system will resize the image if the image resolution is too
large to process (larger than 20MP).
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Cloud Vision V1 Client - Class ImportProductSetsGcsSource (2.0.3)\n\nVersion latestkeyboard_arrow_down\n\n- [2.0.3 (latest)](/php/docs/reference/cloud-vision/latest/V1.ImportProductSetsGcsSource)\n- [2.0.2](/php/docs/reference/cloud-vision/2.0.2/V1.ImportProductSetsGcsSource)\n- [1.10.3](/php/docs/reference/cloud-vision/1.10.3/V1.ImportProductSetsGcsSource)\n- [1.9.4](/php/docs/reference/cloud-vision/1.9.4/V1.ImportProductSetsGcsSource)\n- [1.8.0](/php/docs/reference/cloud-vision/1.8.0/V1.ImportProductSetsGcsSource)\n- [1.7.6](/php/docs/reference/cloud-vision/1.7.6/V1.ImportProductSetsGcsSource)\n- [1.6.8](/php/docs/reference/cloud-vision/1.6.8/V1.ImportProductSetsGcsSource) \nReference documentation and code samples for the Cloud Vision V1 Client class ImportProductSetsGcsSource.\n\nThe Google Cloud Storage location for a csv file which preserves a list of\nImportProductSetRequests in each line.\n\nGenerated from protobuf message `google.cloud.vision.v1.ImportProductSetsGcsSource`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Vision \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getCsvFileUri\n\nThe Google Cloud Storage URI of the input csv file.\n\nThe URI must start with `gs://`.\nThe format of the input csv file should be one image per line.\nIn each line, there are 8 columns.\n\n1. image-uri\n2. image-id\n3. product-set-id\n4. product-id\n5. product-category\n6. product-display-name\n7. labels\n8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to [display_name](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getDisplayName__), the `product-category` column refers to [product_category](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getProductCategory__), and the `labels` column refers to [product_labels](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getProductLabels__). The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the [display_name](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getDisplayName__) field for the product to a space (\" \"). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: \"key_1=value_1,key_2=value_2,...,key_n=value_n\" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format \"p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y\". Use non-negative integers for absolute bounding polygons, and float values in \\[0, 1\\] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP).\n\n### setCsvFileUri\n\nThe Google Cloud Storage URI of the input csv file.\n\nThe URI must start with `gs://`.\nThe format of the input csv file should be one image per line.\nIn each line, there are 8 columns.\n\n1. image-uri\n2. image-id\n3. product-set-id\n4. product-id\n5. product-category\n6. product-display-name\n7. labels\n8. bounding-poly The `image-uri`, `product-set-id`, `product-id`, and `product-category` columns are required. All other columns are optional. If the `ProductSet` or `Product` specified by the `product-set-id` and `product-id` values does not exist, then the system will create a new `ProductSet` or `Product` for the image. In this case, the `product-display-name` column refers to [display_name](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getDisplayName__), the `product-category` column refers to [product_category](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getProductCategory__), and the `labels` column refers to [product_labels](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getProductLabels__). The `image-id` column is optional but must be unique if provided. If it is empty, the system will automatically assign a unique id to the image. The `product-display-name` column is optional. If it is empty, the system sets the [display_name](/php/docs/reference/cloud-vision/latest/V1.Product#_Google_Cloud_Vision_V1_Product__getDisplayName__) field for the product to a space (\" \"). You can update the `display_name` later by using the API. If a `Product` with the specified `product-id` already exists, then the system ignores the `product-display-name`, `product-category`, and `labels` columns. The `labels` column (optional) is a line containing a list of comma-separated key-value pairs, in the following format: \"key_1=value_1,key_2=value_2,...,key_n=value_n\" The `bounding-poly` column (optional) identifies one region of interest from the image in the same manner as `CreateReferenceImage`. If you do not specify the `bounding-poly` column, then the system will try to detect regions of interest automatically. At most one `bounding-poly` column is allowed per line. If the image contains multiple regions of interest, add a line to the CSV file that includes the same product information, and the `bounding-poly` values for each region of interest. The `bounding-poly` column must contain an even number of comma-separated numbers, in the format \"p1_x,p1_y,p2_x,p2_y,...,pn_x,pn_y\". Use non-negative integers for absolute bounding polygons, and float values in \\[0, 1\\] for normalized bounding polygons. The system will resize the image if the image resolution is too large to process (larger than 20MP)."]]