close()
Close httplib2 connections.
- collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)
collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
import_(parent, body=None, x__xgafv=None)
collect(parent, ets=None, uri=None, userEvent=None, x__xgafv=None)
+ collect(parent, ets=None, prebuiltRule=None, rawJson=None, uri=None, userEvent=None, x__xgafv=None)
Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Retail API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
Args:
parent: string, Required. The parent catalog name, such as `projects/1234/locations/global/catalogs/default_catalog`. (required)
ets: string, The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
+ prebuiltRule: string, The prebuilt rule name that can convert a specific type of raw_json. For example: "default_schema/v1.0"
+ rawJson: string, An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.
uri: string, The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.
userEvent: string, Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
x__xgafv: string, V1 error format.
diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
index b1fc40b8231..14a81222faa 100644
--- a/googleapiclient/discovery_cache/documents/retail.v2.json
+++ b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -133,7 +133,7 @@
"type": "string"
},
"deviceType": {
- "description": "The device type context for completion suggestions. It is useful to apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.",
+ "description": "The device type context for completion suggestions. We recommend that you leave this field empty. It can apply different suggestions on different device types, e.g. `DESKTOP`, `MOBILE`. If it is empty, the suggestions are across all device types. Supported formats: * `UNKNOWN_DEVICE_TYPE` * `DESKTOP` * `MOBILE` * A customized string starts with `OTHER_`, e.g. `OTHER_IPHONE`.",
"location": "query",
"type": "string"
},
@@ -1490,6 +1490,16 @@
"required": true,
"type": "string"
},
+ "prebuiltRule": {
+ "description": "The prebuilt rule name that can convert a specific type of raw_json. For example: \"default_schema/v1.0\"",
+ "location": "query",
+ "type": "string"
+ },
+ "rawJson": {
+ "description": "An arbitrary serialized JSON string that contains necessary information that can comprise a user event. When this field is specified, the user_event field will be ignored. Note: line-delimited JSON is not supported, a single JSON only.",
+ "location": "query",
+ "type": "string"
+ },
"uri": {
"description": "The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for 3rd party requests.",
"location": "query",
@@ -1770,7 +1780,7 @@
}
}
},
- "revision": "20220922",
+ "revision": "20221014",
"rootUrl": "https://retail.googleapis.com/",
"schemas": {
"GoogleApiHttpBody": {
@@ -1871,7 +1881,7 @@
"type": "object"
},
"GoogleCloudRetailLoggingImportErrorContext": {
- "description": "The error payload that is populated on LRO import APIs. Including: \"google.cloud.retail.v2.ProductService.ImportProducts\" \"google.cloud.retail.v2.EventService.ImportUserEvents\"",
+ "description": "The error payload that is populated on LRO import APIs, including \"google.cloud.retail.v2.ProductService.ImportProducts\" and \"google.cloud.retail.v2.EventService.ImportUserEvents\".",
"id": "GoogleCloudRetailLoggingImportErrorContext",
"properties": {
"catalogItem": {
@@ -1882,10 +1892,6 @@
"description": "Cloud Storage file path of the import source. Can be set for batch operation error.",
"type": "string"
},
- "inventoryActivity": {
- "description": "The detailed content which caused the error on importing an inventory activity. http://cs/google3/google/cloud/retail/v2main/inventory_activity.proto",
- "type": "string"
- },
"lineNumber": {
"description": "Line number of the content in file. Should be empty for permission or batch operation error.",
"type": "string"
@@ -1894,26 +1900,6 @@
"description": "The operation resource name of the LRO.",
"type": "string"
},
- "order": {
- "description": "The detailed content which caused the error on importing an order. http://cs/google3/google/cloud/retail/v2main/order.proto",
- "type": "string"
- },
- "place": {
- "description": "The detailed content which caused the error on importing a place. http://cs/google3/google/cloud/retail/v2main/place.proto",
- "type": "string"
- },
- "placeAsset": {
- "description": "The detailed content which caused the error on importing a place asset. http://cs/google3/google/cloud/retail/v2main/place_asset.proto",
- "type": "string"
- },
- "placeProductPrice": {
- "description": "The detailed content which caused the error on importing a place product price. http://cs/google3/google/cloud/retail/v2main/place_product_price.proto",
- "type": "string"
- },
- "placeProductSettings": {
- "description": "The detailed content which caused the error on importing a place product settings. http://cs/google3/google/cloud/retail/v2main/place_product_settings.proto",
- "type": "string"
- },
"product": {
"description": "The detailed content which caused the error on importing a product.",
"type": "string"
@@ -2170,6 +2156,20 @@
],
"type": "string"
},
+ "exactSearchableOption": {
+ "description": "If EXACT_SEARCHABLE_ENABLED, attribute values will be exact searchable. This property only applies to textual custom attributes and requires indexable set to enabled to enable exact-searchable.",
+ "enum": [
+ "EXACT_SEARCHABLE_OPTION_UNSPECIFIED",
+ "EXACT_SEARCHABLE_ENABLED",
+ "EXACT_SEARCHABLE_DISABLED"
+ ],
+ "enumDescriptions": [
+ "Value used when unset. Defaults to EXACT_SEARCHABLE_DISABLED.",
+ "Exact searchable option enabled for an attribute.",
+ "Exact searchable option disabled for an attribute."
+ ],
+ "type": "string"
+ },
"inUse": {
"description": "Output only. Indicates whether this attribute has been used by any products. `True` if at least one Product is using this attribute in Product.attributes. Otherwise, this field is `False`. CatalogAttribute can be pre-loaded by using CatalogService.AddCatalogAttribute, CatalogService.ImportCatalogAttributes, or CatalogService.UpdateAttributesConfig APIs. This field is `False` for pre-loaded CatalogAttributes. Only pre-loaded catalog attributes that are neither in use by products nor predefined can be deleted. Catalog attributes that are either in use by products or are predefined attributes cannot be deleted; however, their configuration properties will reset to default values upon removal request. After catalog changes, it takes about 10 minutes for this field to update.",
"readOnly": true,
@@ -4746,6 +4746,17 @@
},
"type": "object"
},
+ "GoogleCloudRetailV2alphaGcsOutputResult": {
+ "description": "A Gcs output result.",
+ "id": "GoogleCloudRetailV2alphaGcsOutputResult",
+ "properties": {
+ "outputUri": {
+ "description": "The uri of Gcs output",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleCloudRetailV2alphaImportCompletionDataResponse": {
"description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudRetailV2alphaImportCompletionDataResponse",
@@ -5068,15 +5079,22 @@
"type": "object"
},
"GoogleCloudRetailV2alphaOutputResult": {
- "description": "Output result.",
+ "description": "Output result that stores the information about where the exported data is stored.",
"id": "GoogleCloudRetailV2alphaOutputResult",
"properties": {
"bigqueryResult": {
- "description": "Export result in BigQuery.",
+ "description": "The BigQuery location where the result is stored.",
"items": {
"$ref": "GoogleCloudRetailV2alphaBigQueryOutputResult"
},
"type": "array"
+ },
+ "gcsResult": {
+ "description": "The Google Cloud Storage location where the result is stored.",
+ "items": {
+ "$ref": "GoogleCloudRetailV2alphaGcsOutputResult"
+ },
+ "type": "array"
}
},
"type": "object"
@@ -5372,6 +5390,17 @@
},
"type": "object"
},
+ "GoogleCloudRetailV2betaGcsOutputResult": {
+ "description": "A Gcs output result.",
+ "id": "GoogleCloudRetailV2betaGcsOutputResult",
+ "properties": {
+ "outputUri": {
+ "description": "The uri of Gcs output",
+ "type": "string"
+ }
+ },
+ "type": "object"
+ },
"GoogleCloudRetailV2betaImportCompletionDataResponse": {
"description": "Response of the ImportCompletionDataRequest. If the long running operation is done, this message is returned by the google.longrunning.Operations.response field if the operation is successful.",
"id": "GoogleCloudRetailV2betaImportCompletionDataResponse",
@@ -5617,15 +5646,22 @@
"type": "object"
},
"GoogleCloudRetailV2betaOutputResult": {
- "description": "Output result.",
+ "description": "Output result that stores the information about where the exported data is stored.",
"id": "GoogleCloudRetailV2betaOutputResult",
"properties": {
"bigqueryResult": {
- "description": "Export result in BigQuery.",
+ "description": "The BigQuery location where the result is stored.",
"items": {
"$ref": "GoogleCloudRetailV2betaBigQueryOutputResult"
},
"type": "array"
+ },
+ "gcsResult": {
+ "description": "The Google Cloud Storage location where the result is stored.",
+ "items": {
+ "$ref": "GoogleCloudRetailV2betaGcsOutputResult"
+ },
+ "type": "array"
}
},
"type": "object"