| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.dataStores.html">dataStores</a> . <a href="discoveryengine_v1alpha.projects.locations.dataStores.controls.html">controls</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, controlId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Gets a Control.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Lists all Controls by their parent DataStore.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, controlId=None, x__xgafv=None)</code> |
| <pre>Creates a Control. By default 1000 controls are allowed for a data store. A request can be submitted to adjust this limit. If the Control to create already exists, an ALREADY_EXISTS error is returned. |
| |
| Args: |
| parent: string, Required. Full resource name of parent data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| } |
| |
| controlId: string, Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>Deletes a Control. If the Control to delete does not exist, a NOT_FOUND error is returned. |
| |
| Args: |
| name: string, Required. The resource name of the Control to delete. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>Gets a Control. |
| |
| Args: |
| name: string, Required. The resource name of the Control to get. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}` (required) |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>Lists all Controls by their parent DataStore. |
| |
| Args: |
| parent: string, Required. The data store resource name. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}` or `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. (required) |
| filter: string, Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. |
| pageSize: integer, Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| pageToken: string, Optional. A page token, received from a previous `ListControls` call. Provide this to retrieve the subsequent page. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Response for ListControls method. |
| "controls": [ # All the Controls for a given data store. |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| }, |
| ], |
| "nextPageToken": "A String", # Pagination token, if not returned indicates the last page. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>Retrieves the next page of results. |
| |
| Args: |
| previous_request: The request for the previous page. (required) |
| previous_response: The response from the request for the previous page. (required) |
| |
| Returns: |
| A request object that you can call 'execute()' on to request the next |
| page. Returns None if there are no more items in the collection. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>Updates a Control. Control action type cannot be changed. If the Control to update does not exist, a NOT_FOUND error is returned. |
| |
| Args: |
| name: string, Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` (required) |
| body: object, The request body. |
| The object takes the form of: |
| |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| } |
| |
| updateMask: string, Optional. Indicates which fields in the provided Control to update. The following are NOT supported: * Control.name * Control.solution_type If not set or empty, all supported fields are updated. |
| x__xgafv: string, V1 error format. |
| Allowed values |
| 1 - v1 error format |
| 2 - v2 error format |
| |
| Returns: |
| An object of the form: |
| |
| { # Defines a conditioned behavior to employ during serving. Must be attached to a ServingConfig to be considered at serving time. Permitted actions dependent on `SolutionType`. |
| "associatedServingConfigIds": [ # Output only. List of all ServingConfig IDs this control is attached to. May take up to 10 minutes to update after changes. |
| "A String", |
| ], |
| "boostAction": { # Adjusts order of products in returned list. # Defines a boost-type control |
| "boost": 3.14, # Required. Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| "dataStore": "A String", # Required. Specifies which data store's documents can be boosted by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. Specifies which products to apply the boost to. If no filter is provided all products will be boosted (No-op). Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "conditions": [ # Determines when the associated action will trigger. Omit to always apply the action. Currently only a single condition may be specified. Otherwise an INVALID ARGUMENT error is thrown. |
| { # Defines circumstances to be checked before allowing a behavior |
| "activeTimeRange": [ # Range of time(s) specifying when condition is active. Maximum of 10 time ranges. |
| { # Used for time-dependent conditions. |
| "endTime": "A String", # End of time range. Range is inclusive. Must be in the future. |
| "startTime": "A String", # Start of time range. Range is inclusive. |
| }, |
| ], |
| "queryTerms": [ # Search only A list of terms to match the query on. Maximum of 10 query terms. |
| { # Matcher for search request query |
| "fullMatch": True or False, # Whether the search query needs to exactly match the query term. |
| "value": "A String", # The specific query value to match against Must be lowercase, must be UTF-8. Can have at most 3 space separated terms if full_match is true. Cannot be an empty string. Maximum length of 5000 characters. |
| }, |
| ], |
| }, |
| ], |
| "displayName": "A String", # Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| "filterAction": { # Specified which products may be included in results. Uses same filter as boost. # Defines a filter-type control Currently not supported by Recommendation |
| "dataStore": "A String", # Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| "filter": "A String", # Required. A filter to apply on the matching condition results. Required Syntax documentation: https://cloud.google.com/retail/docs/filter-and-order Maximum length is 5000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "name": "A String", # Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| "redirectAction": { # Redirects a shopper to the provided URI. # Defines a redirect-type control. |
| "redirectUri": "A String", # Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| }, |
| "solutionType": "A String", # Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| "synonymsAction": { # Creates a set of terms that will act as synonyms of one another. Example: "happy" will also be considered as "glad", "glad" will also be considered as "happy". # Treats a group of terms as synonyms of one another. |
| "synonyms": [ # Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| "A String", |
| ], |
| }, |
| "useCases": [ # Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| "A String", |
| ], |
| }</pre> |
| </div> |
| |
| </body></html> |
