feat(retail): update the api

yoshi-automation · yoshi-automation · commit eb919ff3667b · 2024-10-30T20:33:48.000Z
#### retail:v2

The following keys were added:
- schemas.GoogleCloudRetailV2PinControlMetadata (Total Keys: 10)
- schemas.GoogleCloudRetailV2SearchResponse.properties.pinControlMetadata.$ref (Total Keys: 1)

#### retail:v2alpha

The following keys were added:
- schemas.GoogleCloudRetailV2alphaPinControlMetadata (Total Keys: 10)
- schemas.GoogleCloudRetailV2alphaSearchResponse.properties.pinControlMetadata.$ref (Total Keys: 1)

#### retail:v2beta

The following keys were added:
- schemas.GoogleCloudRetailV2betaPinControlMetadata (Total Keys: 10)
- schemas.GoogleCloudRetailV2betaSearchResponse.properties.pinControlMetadata.$ref (Total Keys: 1)
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2.projects.locations.catalogs.placements.html
@@ -570,6 +570,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2.projects.locations.catalogs.servingConfigs.html
@@ -1121,6 +1121,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.placements.html
@@ -571,6 +571,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2alpha.projects.locations.catalogs.servingConfigs.html
@@ -1122,6 +1122,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.placements.html
@@ -570,6 +570,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html b/docs/dyn/retail_v2beta.projects.locations.catalogs.servingConfigs.html
@@ -1121,6 +1121,22 @@ <h3>Method Details</h3>
     },
   ],
   &quot;nextPageToken&quot;: &quot;A String&quot;, # A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.
+  &quot;pinControlMetadata&quot;: { # Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins. # Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin.
+    &quot;allMatchedPins&quot;: { # Map of all matched pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+    &quot;droppedPins&quot;: { # Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.
+      &quot;a_key&quot;: { # List of product ids which have associated pins.
+        &quot;productId&quot;: [ # List of product ids which have associated pins.
+          &quot;A String&quot;,
+        ],
+      },
+    },
+  },
   &quot;queryExpansionInfo&quot;: { # Information describing query expansion including whether expansion has occurred. # Query expansion information for the returned results.
     &quot;expandedQuery&quot;: True or False, # Bool describing whether query expansion has occurred.
     &quot;pinnedResultCount&quot;: &quot;A String&quot;, # Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.
diff --git a/googleapiclient/discovery_cache/documents/retail.v2.json b/googleapiclient/discovery_cache/documents/retail.v2.json
@@ -2246,7 +2246,7 @@
 }
 }
 },
-"revision": "20241017",
+"revision": "20241024",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -4041,6 +4041,41 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2PinControlMetadata": {
+"description": "Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.",
+"id": "GoogleCloudRetailV2PinControlMetadata",
+"properties": {
+"allMatchedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2PinControlMetadataProductPins"
+},
+"description": "Map of all matched pins, keyed by pin position.",
+"type": "object"
+},
+"droppedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2PinControlMetadataProductPins"
+},
+"description": "Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2PinControlMetadataProductPins": {
+"description": "List of product ids which have associated pins.",
+"id": "GoogleCloudRetailV2PinControlMetadataProductPins",
+"properties": {
+"productId": {
+"description": "List of product ids which have associated pins.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2PredictRequest": {
 "description": "Request message for Predict method.",
 "id": "GoogleCloudRetailV2PredictRequest",
@@ -5504,6 +5539,10 @@
 "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
 "type": "string"
 },
+"pinControlMetadata": {
+"$ref": "GoogleCloudRetailV2PinControlMetadata",
+"description": "Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin."
+},
 "queryExpansionInfo": {
 "$ref": "GoogleCloudRetailV2SearchResponseQueryExpansionInfo",
 "description": "Query expansion information for the returned results."
diff --git a/googleapiclient/discovery_cache/documents/retail.v2alpha.json b/googleapiclient/discovery_cache/documents/retail.v2alpha.json
@@ -2767,7 +2767,7 @@
 }
 }
 },
-"revision": "20241017",
+"revision": "20241024",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -5864,6 +5864,41 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2alphaPinControlMetadata": {
+"description": "Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.",
+"id": "GoogleCloudRetailV2alphaPinControlMetadata",
+"properties": {
+"allMatchedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2alphaPinControlMetadataProductPins"
+},
+"description": "Map of all matched pins, keyed by pin position.",
+"type": "object"
+},
+"droppedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2alphaPinControlMetadataProductPins"
+},
+"description": "Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2alphaPinControlMetadataProductPins": {
+"description": "List of product ids which have associated pins.",
+"id": "GoogleCloudRetailV2alphaPinControlMetadataProductPins",
+"properties": {
+"productId": {
+"description": "List of product ids which have associated pins.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2alphaPredictRequest": {
 "description": "Request message for Predict method.",
 "id": "GoogleCloudRetailV2alphaPredictRequest",
@@ -7375,6 +7410,10 @@
 "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
 "type": "string"
 },
+"pinControlMetadata": {
+"$ref": "GoogleCloudRetailV2alphaPinControlMetadata",
+"description": "Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin."
+},
 "queryExpansionInfo": {
 "$ref": "GoogleCloudRetailV2alphaSearchResponseQueryExpansionInfo",
 "description": "Query expansion information for the returned results."
diff --git a/googleapiclient/discovery_cache/documents/retail.v2beta.json b/googleapiclient/discovery_cache/documents/retail.v2beta.json
@@ -2391,7 +2391,7 @@
 }
 }
 },
-"revision": "20241017",
+"revision": "20241024",
 "rootUrl": "https://retail.googleapis.com/",
 "schemas": {
 "GoogleApiHttpBody": {
@@ -5842,6 +5842,41 @@
 "properties": {},
 "type": "object"
 },
+"GoogleCloudRetailV2betaPinControlMetadata": {
+"description": "Metadata for pinning to be returned in the response. This is used for distinguishing between applied vs dropped pins.",
+"id": "GoogleCloudRetailV2betaPinControlMetadata",
+"properties": {
+"allMatchedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2betaPinControlMetadataProductPins"
+},
+"description": "Map of all matched pins, keyed by pin position.",
+"type": "object"
+},
+"droppedPins": {
+"additionalProperties": {
+"$ref": "GoogleCloudRetailV2betaPinControlMetadataProductPins"
+},
+"description": "Map of pins that were dropped due to overlap with other matching pins, keyed by pin position.",
+"type": "object"
+}
+},
+"type": "object"
+},
+"GoogleCloudRetailV2betaPinControlMetadataProductPins": {
+"description": "List of product ids which have associated pins.",
+"id": "GoogleCloudRetailV2betaPinControlMetadataProductPins",
+"properties": {
+"productId": {
+"description": "List of product ids which have associated pins.",
+"items": {
+"type": "string"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "GoogleCloudRetailV2betaPredictRequest": {
 "description": "Request message for Predict method.",
 "id": "GoogleCloudRetailV2betaPredictRequest",
@@ -7305,6 +7340,10 @@
 "description": "A token that can be sent as SearchRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.",
 "type": "string"
 },
+"pinControlMetadata": {
+"$ref": "GoogleCloudRetailV2betaPinControlMetadata",
+"description": "Metadata for pin controls which were applicable to the request. This contains two map fields, one for all matched pins and one for pins which were matched but not applied. The two maps are keyed by pin position, and the values are the product ids which were matched to that pin."
+},
 "queryExpansionInfo": {
 "$ref": "GoogleCloudRetailV2betaSearchResponseQueryExpansionInfo",
 "description": "Query expansion information for the returned results."
