Method: projects.locations.catalogs.models.patch

Update of model metadata. Only fields that currently can be updated are: filteringOption and periodicTuningState. If other values are provided, this API method ignores them.

HTTP request

PATCH https://retail.googleapis.com/v2alpha/{model.name=projects/*/locations/*/catalogs/*/models/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
model.name

string

Required. The fully qualified resource name of the model.

Format: projects/{projectNumber}/locations/{locationId}/catalogs/{catalogId}/models/{modelId} catalogId has char limit of 50. recommendation_model_id has char limit of 40.

Query parameters

Parameters
updateMask

string (FieldMask format)

Optional. Indicates which fields in the provided 'model' to update. If not set, by default updates all fields.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Model.

Response body

If successful, the response body contains an instance of Model.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • retail.models.update

For more information, see the IAM documentation.