# 讀取非公開報表範本版本 標準 URL： https://sosoapi.ai/zh-tw/docs/mcp/get-report-template `sosoapi_get_report_template` 讀取非公開報表範本版本。使用明確指定且已審閱的資料集與版本；不會自動更新資料來源。 可透過管線將渲染輸入傳給 sosoapi report render --output FILE。 ## 設定與傳輸方式 設定：full 傳輸方式：stdio、http 選擇 core 或 full 以控制用戶端顯示的工具；這不會變更權限。本機檔案上傳需要 stdio，無法透過 HTTP 使用。設定 SOSOAPI_OUTPUT_SCHEMAS=1 可在探索結果加入輸出結構描述。無論是否啟用此設定，工具皆會回傳結構化結果。 ## 權限與副作用 註解幫助用戶端描述工具。每次呼叫仍會檢查使用者身分驗證、角色、資源存取和能力授權。 ```json { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false } ``` `/analytics-api/reporting/templates/get` — agent:operate；synchronous_http_response ## 輸入欄位 ```json { "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "workspace_id", "id", "version" ], "additionalProperties": false } ``` ## 結構化輸出 此 schema 描述成功工具結果中的 structuredContent。MCP 回應也包含 content，並可能在呼叫失敗時設定 isError。對於發布，請讀取貼文的最終結果，不要把已接受的請求或文字回應當作確認。連結的 API 操作說明了權限和重試規則。 ```json { "type": "object", "properties": { "contractVersion": { "type": "string", "const": "analytics-template/v1" }, "workspaceId": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "format": { "type": "string", "enum": [ "pptx", "docx", "xlsx" ] }, "sourceBase64": { "type": "string", "maxLength": 12582912, "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" }, "sourceSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "mappings": { "type": "object", "propertyNames": { "type": "string", "pattern": "^[A-Za-z][A-Za-z0-9_.-]{0,63}$" }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "kind": { "type": "string", "const": "text" }, "value": { "type": "string", "maxLength": 2000 } }, "required": [ "kind", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "selection" }, "field": { "type": "string", "enum": [ "accounts", "period", "timezone", "platforms", "dataset", "reviewed", "coverage" ] } }, "required": [ "kind", "field" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "metric" }, "platform": { "type": "string", "enum": [ "facebook", "instagram", "threads", "youtube" ] }, "key": { "type": "string", "minLength": 1, "maxLength": 150 }, "unit": { "type": "string", "minLength": 1, "maxLength": 100 }, "grain": { "type": "string", "enum": [ "post", "account" ] }, "measurementKind": { "type": "string", "enum": [ "lifetime", "snapshot", "period", "unknown" ] }, "accountId": { "type": "string", "format": "uuid" }, "providerResourceId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ] }, "sourcePath": { "type": "string", "maxLength": 2000 }, "requestId": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "null" } ] } }, "required": [ "kind", "platform", "key", "unit", "grain", "measurementKind" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "formula" }, "id": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "kind", "id", "version" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "table" }, "source": { "type": "string", "enum": [ "measurements", "formulas" ] }, "limit": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "kind", "source", "limit" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "type": "string", "const": "chart" }, "source": { "type": "string", "const": "publication_by_platform" } }, "required": [ "kind", "source" ], "additionalProperties": false } ] } }, "createdAt": { "type": "string", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$", "format": "date-time" } }, "required": [ "contractVersion", "workspaceId", "id", "version", "name", "format", "sourceBase64", "sourceSha256", "mappings", "createdAt" ], "$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false } ``` ## 工具呼叫範例 這些範例使用已依結構描述檢查的虛構值。請將 ID 替換為您有權使用的 ID、將媒體替換為已就緒素材，並將日期替換為已確認的發布時間。提交寫入前，請檢查帳號資格。本頁不會傳送 API 請求。 ```json { "name": "sosoapi_get_report_template", "arguments": { "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1 } } ``` structuredContent ```json { "contractVersion": "analytics-template/v1", "workspaceId": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1, "name": "example", "format": "pptx", "sourceBase64": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "mappings": {}, "createdAt": "2099-01-15T09:00:00Z" } ``` ## 底層 API 操作 - [/analytics-api/reporting/templates/get](https://sosoapi.ai/zh-tw/docs/api/analytics-api-reporting-templates-get)