Method: inventory.partners.feeds.record.batchDelete
Stay organized with collections
Save and categorize content based on your preferences.
Deletes records of specified feed type. Only performs basic validation (like malformed request) after which an appropriate response is returned to the partner immediately. Google performs business logic validation on the request asynchronously. This batch call does not guarantee atomicity.
HTTP request
POST https://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/feeds/*}/record:batchDelete
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Resource name, which has the format of - partners/{partner_id}/feeds/{feed_name} .
|
Request body
The request body contains data with the following structure:
Fields |
records[] |
object (GenericDeleteRecord )
Records to be deleted. Maximum of 1000 records are allowed in one api call.
|
Response body
If successful, the response body is empty.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/mapsbooking
GenericDeleteRecord
Record to be deleted of the feed type mentioned in url request.
JSON representation |
{
"deleteTime": string,
// Union field record_type can be only one of the following:
"dataRecord": string,
"protoRecord": {
"@type": string,
field1: ...,
...
}
// End of list of possible types for union field record_type .
} |
Fields |
deleteTime |
string (Timestamp format)
Required. This timestamp is used to determine the order in which a delete will be applied to the inventory. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z" .
|
Union field record_type . Encapsulate different types of feed (ndjson, proto-based, etc.) Partner can provide a full record similar to how a record is provided in a feed or BatchPush API. Partners also have the option to include only the essential fields of a record required to uniquely identify it. record_type can be only one of the following: |
dataRecord |
string (bytes format)
For non-proto based feeds. A base64-encoded string.
|
protoRecord |
object
For proto-based feeds. An object containing fields of an arbitrary type. An additional field "@type" contains a URI identifying the type. Example: { "id": 1234, "@type": "types.example.com/standard/id" } .
|
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 2024-10-17 UTC.
[null,null,["Last updated 2024-10-17 UTC."],[[["\u003cp\u003eThis API endpoint (\u003ccode\u003ebatchDelete\u003c/code\u003e) is used to delete records from a specified feed within the Google Maps Booking inventory.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires specifying the \u003ccode\u003eparent\u003c/code\u003e (partner and feed) and an array of \u003ccode\u003erecords\u003c/code\u003e to be deleted, with a maximum of 1000 records per call.\u003c/p\u003e\n"],["\u003cp\u003eEach record to be deleted (\u003ccode\u003eGenericDeleteRecord\u003c/code\u003e) can be identified either by a full data record or a unique identifier, depending on the feed type.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edeleteTime\u003c/code\u003e field is crucial for determining the order of deletion, ensuring data consistency.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful deletion requests will return an empty response body.\u003c/p\u003e\n"]]],[],null,["# Method: inventory.partners.feeds.record.batchDelete\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n - [JSON representation](#body.request_body.SCHEMA_REPRESENTATION)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [GenericDeleteRecord](#GenericDeleteRecord)\n - [JSON representation](#GenericDeleteRecord.SCHEMA_REPRESENTATION)\n\nDeletes records of specified feed type. Only performs basic validation (like malformed request) after which an appropriate response is returned to the partner immediately. Google performs business logic validation on the request asynchronously. This batch call does not guarantee atomicity.\n\n### HTTP request\n\n`POST https://mapsbooking.googleapis.com/v1alpha/inventory/{parent=partners/*/feeds/*}/record:batchDelete`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------|\n| `parent` | `string` Resource name, which has the format of - `partners/{partner_id}/feeds/{feed_name}`. |\n\n### Request body\n\nThe request body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"records\": [ { object (/maps-booking/reference/maps-booking-api/rest/v1alpha/inventory.partners.feeds.record/batchDelete#GenericDeleteRecord) } ] } ``` |\n\n| Fields ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `records[]` | `object (`[GenericDeleteRecord](/maps-booking/reference/maps-booking-api/rest/v1alpha/inventory.partners.feeds.record/batchDelete#GenericDeleteRecord)`)` Records to be deleted. Maximum of 1000 records are allowed in one api call. |\n\n### Response body\n\nIf successful, the response body is empty.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/mapsbooking`\n\nGenericDeleteRecord\n-------------------\n\nRecord to be deleted of the feed type mentioned in url request.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"deleteTime\": string, // Union field `record_type` can be only one of the following: \"dataRecord\": string, \"protoRecord\": { \"@type\": string, field1: ..., ... } // End of list of possible types for union field `record_type`. } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `delete``Time` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Required. This timestamp is used to determine the order in which a delete will be applied to the inventory. A timestamp in RFC3339 UTC \"Zulu\" format, with nanosecond resolution and up to nine fractional digits. Examples: `\"2014-10-02T15:01:23Z\"` and `\"2014-10-02T15:01:23.045123456Z\"`. |\n| Union field `record_type`. Encapsulate different types of feed (ndjson, proto-based, etc.) Partner can provide a full record similar to how a record is provided in a feed or BatchPush API. Partners also have the option to include only the essential fields of a record required to uniquely identify it. `record_type` can be only one of the following: ||\n| `data``Record` | `string (`[bytes](https://developers.google.com/discovery/v1/type-format)` format)` For non-proto based feeds. A base64-encoded string. |\n| `proto``Record` | `object` For proto-based feeds. An object containing fields of an arbitrary type. An additional field `\"@type\"` contains a URI identifying the type. Example: `{ \"id\": 1234, \"@type\": \"types.example.com/standard/id\" }`. |"]]