# Vertex AI Search for commerce API . projects

## Instance Methods

Returns the locations Resource.

Returns the operations Resource.

Returns the retailProject Resource.

Close httplib2 connections.

The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

Get the AlertConfig of the requested project.

Gets the LoggingConfig of the requested project.

Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.

Lists all the retail API solutions the project has enrolled.

Update the alert config of the requested project.

Updates the LoggingConfig of the requested project.

### Method Details

`close()`

    Close httplib2 connections.

`enrollSolution(project, body=None, x__xgafv=None)`

    The method enrolls a solution of type Retail Search into a project. The Recommendations AI solution type is enrolled by default when your project enables Retail API, so you don't need to call the enrollSolution method for recommendations.

    Args:
      project: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
      body: object, The request body.
        The object takes the form of:

    { # Request for EnrollSolution method.
      "solution": "A String", # Required. Solution to enroll.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`getAlertConfig(name, x__xgafv=None)`

    Get the AlertConfig of the requested project.

    Args:
      name: string, Required. Full AlertConfig resource name. Format: projects/{project_number}/alertConfig (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Project level alert config.
      "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
        { # Alert policy for a customer.
          "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
          "enrollStatus": "A String", # The enrollment status of a customer.
          "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
            { # Recipient contact information.
              "emailAddress": "A String", # Email address of the recipient.
            },
          ],
        },
      ],
      "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
    }

`getLoggingConfig(name, x__xgafv=None)`

    Gets the LoggingConfig of the requested project.

    Args:
      name: string, Required. Full LoggingConfig resource name. Format: projects/{project_number}/loggingConfig (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Project level logging config to control what level of log will be generated and written to Cloud Logging.
      "defaultLogGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.
        "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
        "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
      },
      "name": "A String", # Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig
      "serviceLogGenerationRules": [ # Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.
        { # The granular logging configurations for supported services.
          "logGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies to this service.
            "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
            "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
          },
          "serviceName": "A String", # Required. Supported service names: "CatalogService", "CompletionService", "ControlService", "MerchantCenterStreaming", "ModelService", "PredictionService", "ProductService", "ServingConfigService", "UserEventService",
        },
      ],
    }

`getRetailProject(name, x__xgafv=None)`

    Gets the project. Throws `NOT_FOUND` if the project wasn't initialized for the Retail API service.

    Args:
      name: string, Required. Full resource name of the project. Format: `projects/{project_number_or_id}/retailProject` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Metadata that describes a Cloud Retail Project.
      "enrolledSolutions": [ # Output only. Retail API solutions that the project has enrolled.
        "A String",
      ],
      "name": "A String", # Output only. Full resource name of the retail project, such as `projects/{project_id_or_number}/retailProject`.
    }

`listEnrolledSolutions(parent, x__xgafv=None)`

    Lists all the retail API solutions the project has enrolled.

    Args:
      parent: string, Required. Full resource name of parent. Format: `projects/{project_number_or_id}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response for ListEnrolledSolutions method.
      "enrolledSolutions": [ # Retail API solutions that the project has enrolled.
        "A String",
      ],
    }

`updateAlertConfig(name, body=None, updateMask=None, x__xgafv=None)`

    Update the alert config of the requested project.

    Args:
      name: string, Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig (required)
      body: object, The request body.
        The object takes the form of:

    { # Project level alert config.
      "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
        { # Alert policy for a customer.
          "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
          "enrollStatus": "A String", # The enrollment status of a customer.
          "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
            { # Recipient contact information.
              "emailAddress": "A String", # Email address of the recipient.
            },
          ],
        },
      ],
      "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
    }

      updateMask: string, Indicates which fields in the provided AlertConfig to update. If not set, 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:

        { # Project level alert config.
      "alertPolicies": [ # Alert policies for a customer. They must be unique by [AlertPolicy.alert_group]
        { # Alert policy for a customer.
          "alertGroup": "A String", # The feature that provides alerting capability. Supported value: - `search-data-quality` for retail search customers. - `conv-data-quality` for retail conversation customers.
          "enrollStatus": "A String", # The enrollment status of a customer.
          "recipients": [ # Recipients for the alert policy. One alert policy should not exceed 20 recipients.
            { # Recipient contact information.
              "emailAddress": "A String", # Email address of the recipient.
            },
          ],
        },
      ],
      "name": "A String", # Required. Immutable. The name of the AlertConfig singleton resource. Format: projects/*/alertConfig
    }

`updateLoggingConfig(name, body=None, updateMask=None, x__xgafv=None)`

    Updates the LoggingConfig of the requested project.

    Args:
      name: string, Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig (required)
      body: object, The request body.
        The object takes the form of:

    { # Project level logging config to control what level of log will be generated and written to Cloud Logging.
      "defaultLogGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.
        "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
        "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
      },
      "name": "A String", # Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig
      "serviceLogGenerationRules": [ # Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.
        { # The granular logging configurations for supported services.
          "logGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies to this service.
            "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
            "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
          },
          "serviceName": "A String", # Required. Supported service names: "CatalogService", "CompletionService", "ControlService", "MerchantCenterStreaming", "ModelService", "PredictionService", "ProductService", "ServingConfigService", "UserEventService",
        },
      ],
    }

      updateMask: string, Indicates which fields in the provided LoggingConfig to update. The following are the only supported fields: * LoggingConfig.default_log_generation_rule * LoggingConfig.service_log_generation_rules If not set, 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:

        { # Project level logging config to control what level of log will be generated and written to Cloud Logging.
      "defaultLogGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies by default to all services supporting log generation. It can be overridden by ServiceLogGenerationRule for service level control.
        "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
        "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
      },
      "name": "A String", # Required. Immutable. The name of the LoggingConfig singleton resource. Format: projects/*/loggingConfig
      "serviceLogGenerationRules": [ # Controls logging configurations more granularly for each supported service. This overrides the default_log_generation_rule for the services specified. For those not mentioned, they will fallback to the default log generation rule.
        { # The granular logging configurations for supported services.
          "logGenerationRule": { # The logging configurations for services supporting log generation. # The log generation rule that applies to this service.
            "infoLogSampleRate": 3.14, # The log sample rate for INFO level log entries. You can use this to reduce the number of entries generated for INFO level logs. DO NOT set this field if the logging_level is not LoggingLevel.LOG_ALL. Otherwise, an INVALID_ARGUMENT error is returned. Sample rate for INFO logs defaults to 1 when unset (generate and send all INFO logs to Cloud Logging). Its value must be greater than 0 and less than or equal to 1.
            "loggingLevel": "A String", # The logging level. By default it is set to `LOG_WARNINGS_AND_ABOVE`.
          },
          "serviceName": "A String", # Required. Supported service names: "CatalogService", "CompletionService", "ControlService", "MerchantCenterStreaming", "ModelService", "PredictionService", "ProductService", "ServingConfigService", "UserEventService",
        },
      ],
    }