Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.
This message can be used both in streaming and non-streaming API methods in the request as well as the response.
It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.
Example:
message GetResourceRequest {
// A unique request id.
string requestId = 1;
// The raw HTTP body is bound to this field.
google.api.HttpBody http_body = 2;
}
service ResourceService {
rpc GetResource(GetResourceRequest)
returns (google.api.HttpBody);
rpc UpdateResource(google.api.HttpBody)
returns (google.protobuf.Empty);
}
Application specific response metadata. Must be set in the first response for streaming APIs.
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" }.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-22 UTC."],[[["\u003cp\u003eThis content describes the \u003ccode\u003egoogle.api.HttpBody\u003c/code\u003e message, which is designed to represent arbitrary HTTP bodies that cannot be represented as JSON, such as binary data or HTML.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHttpBody\u003c/code\u003e message can be used in both streaming and non-streaming API methods, functioning as a request or response field.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHttpBody\u003c/code\u003e message can also be a top level field when one wants to extract parameters from either the URL or HTTP template and have access to the raw HTTP body.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eHttpBody\u003c/code\u003e message uses fields like \u003ccode\u003econtentType\u003c/code\u003e, \u003ccode\u003edata\u003c/code\u003e (base64-encoded binary), and \u003ccode\u003eextensions\u003c/code\u003e for application-specific metadata, allowing for a flexible representation of various content types.\u003c/p\u003e\n"],["\u003cp\u003eUse of the \u003ccode\u003eHttpBody\u003c/code\u003e type only impacts how the request and response bodies are processed, leaving other API features unaffected.\u003c/p\u003e\n"]]],[],null,["# HttpBody\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nMessage that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page.\n\nThis message can be used both in streaming and non-streaming API methods in the request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body.\n\nExample: \n\n message GetResourceRequest {\n // A unique request id.\n string requestId = 1;\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n service ResourceService {\n rpc GetResource(GetResourceRequest)\n returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody)\n returns (google.protobuf.Empty);\n }\n\nExample with streaming methods: \n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged."]]