Method: accounts.dataSources.patch

  • This documentation outlines how to update an existing data source configuration using a PATCH request.

  • The request should target the specific data source using its unique identifier in the path.

  • An updateMask query parameter is required to specify the fields to be updated or deleted.

  • The request body must contain the updated DataSource object, adhering to the provided schema.

  • Successful requests will return the updated DataSource object in the response.

Updates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.

HTTP request

PATCH https://merchantapi.googleapis.com/datasources/v1beta/{dataSource.name=accounts/*/dataSources/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
dataSource.name

string

Required. Identifier. The name of the data source. Format: accounts/{account}/dataSources/{datasource}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of data source fields to be updated.

Fields specified in the update mask without a value specified in the body will be deleted from the data source.

Providing special "*" value for full data source replacement is not supported.

For example, If you insert updateMask=displayName in the request, it will only update the displayName leaving all other fields untouched.

Request body

The request body contains an instance of DataSource.

Response body

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.