Skip to content

Commit 0812aa4

Browse files
feat(retail): update the api
#### retail:v2 The following keys were added: - schemas.GoogleCloudRetailV2Rule.properties.pinAction.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2RulePinAction (Total Keys: 4) #### retail:v2alpha The following keys were added: - schemas.GoogleCloudRetailV2alphaRule.properties.pinAction.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2alphaRulePinAction (Total Keys: 4) #### retail:v2beta The following keys were added: - schemas.GoogleCloudRetailV2betaRule.properties.pinAction.$ref (Total Keys: 1) - schemas.GoogleCloudRetailV2betaRulePinAction (Total Keys: 4)
1 parent 40b43d8 commit 0812aa4

6 files changed

+147
-3
lines changed

docs/dyn/retail_v2.projects.locations.catalogs.controls.html

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,11 @@ <h3>Method Details</h3>
176176
&quot;A String&quot;,
177177
],
178178
},
179+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
180+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
181+
&quot;a_key&quot;: &quot;A String&quot;,
182+
},
183+
},
179184
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
180185
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
181186
},
@@ -280,6 +285,11 @@ <h3>Method Details</h3>
280285
&quot;A String&quot;,
281286
],
282287
},
288+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
289+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
290+
&quot;a_key&quot;: &quot;A String&quot;,
291+
},
292+
},
283293
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
284294
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
285295
},
@@ -408,6 +418,11 @@ <h3>Method Details</h3>
408418
&quot;A String&quot;,
409419
],
410420
},
421+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
422+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
423+
&quot;a_key&quot;: &quot;A String&quot;,
424+
},
425+
},
411426
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
412427
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
413428
},
@@ -523,6 +538,11 @@ <h3>Method Details</h3>
523538
&quot;A String&quot;,
524539
],
525540
},
541+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
542+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
543+
&quot;a_key&quot;: &quot;A String&quot;,
544+
},
545+
},
526546
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
527547
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
528548
},
@@ -645,6 +665,11 @@ <h3>Method Details</h3>
645665
&quot;A String&quot;,
646666
],
647667
},
668+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
669+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
670+
&quot;a_key&quot;: &quot;A String&quot;,
671+
},
672+
},
648673
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
649674
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
650675
},
@@ -749,6 +774,11 @@ <h3>Method Details</h3>
749774
&quot;A String&quot;,
750775
],
751776
},
777+
&quot;pinAction&quot;: { # Pins one or more specified products to a specific position in the results. * Rule Condition: Must specify non-empty Condition.query_terms (for search only) or Condition.page_categories (for browse only), but can&#x27;t specify both. * Action Input: mapping of `[pin_position, product_id]` pairs (pin position uses 1-based indexing). * Action Result: Will pin products with matching ids to the position specified in the final result order. Example: Suppose the query is `shoes`, the Condition.query_terms is `shoes` and the pin_map has `{1, &quot;pid1&quot;}`, then product with `pid1` will be pinned to the top position in the final results. If multiple PinActions are matched to a single request the actions will be processed from most to least recently updated. Pins to positions larger than the max allowed page size of 120 are not allowed. # Pins one or more specified products to a specific position in the results.
778+
&quot;pinMap&quot;: { # Required. A map of positions to product_ids. Partial matches per action are allowed, if a certain position in the map is already filled that `[position, product_id]` pair will be ignored but the rest may still be applied. This case will only occur if multiple pin actions are matched to a single request, as the map guarantees that pin positions are unique within the same action. Duplicate product_ids are not permitted within a single pin map. The max size of this map is 120, equivalent to the max [request page size](https://cloud.google.com/retail/docs/reference/rest/v2/projects.locations.catalogs.placements/search#request-body).
779+
&quot;a_key&quot;: &quot;A String&quot;,
780+
},
781+
},
752782
&quot;redirectAction&quot;: { # Redirects a shopper to a specific page. * Rule Condition: Must specify Condition.query_terms. * Action Input: Request Query * Action Result: Redirects shopper to provided uri. # Redirects a shopper to a specific page.
753783
&quot;redirectUri&quot;: &quot;A String&quot;, # URL must have length equal or less than 2000 characters.
754784
},

0 commit comments

Comments
 (0)