Method: accounts.dataSources.patch
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-27 UTC.
[null,null,["Last updated 2025-05-27 UTC."],[[["\u003cp\u003eThis documentation outlines how to update an existing data source configuration using a PATCH request.\u003c/p\u003e\n"],["\u003cp\u003eThe request should target the specific data source using its unique identifier in the path.\u003c/p\u003e\n"],["\u003cp\u003eAn \u003ccode\u003eupdateMask\u003c/code\u003e query parameter is required to specify the fields to be updated or deleted.\u003c/p\u003e\n"],["\u003cp\u003eThe request body must contain the updated \u003ccode\u003eDataSource\u003c/code\u003e object, adhering to the provided schema.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful requests will return the updated \u003ccode\u003eDataSource\u003c/code\u003e object in the response.\u003c/p\u003e\n"]]],["This describes updating an existing data source configuration via a `PATCH` request to a specific URL: `https://merchantapi.googleapis.com/datasources/v1beta/{dataSource.name=accounts/*/dataSources/*}`. The `dataSource.name` is a required path parameter. The `updateMask` query parameter specifies fields for update or deletion. The request body contains `DataSource` details for the update. A successful response also returns a `DataSource` instance. The operation requires the `https://www.googleapis.com/auth/content` authorization scope.\n"],null,["# Method: accounts.dataSources.patch\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nUpdates the existing data source configuration. The fields that are set in the update mask but not provided in the resource will be deleted.\n\n### HTTP request\n\n`PATCH https://merchantapi.googleapis.com/datasources/v1beta/{dataSource.name=accounts/*/dataSources/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|-------------------------------------------------------------------------------------------------------------------|\n| `dataSource.name` | `string` Required. Identifier. The name of the data source. Format: `accounts/{account}/dataSources/{datasource}` |\n\n### Query parameters\n\n| Parameters ||\n|--------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `updateMask` | `string (`[FieldMask](https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask)` 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. |\n\n### Request body\n\nThe request body contains an instance of [DataSource](/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#DataSource).\n\n### Response body\n\nIf successful, the response body contains an instance of [DataSource](/merchant/api/reference/rest/datasources_v1beta/accounts.dataSources#DataSource).\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]
