# 非公開レポートテンプレートのバージョンを取得 正規URL： https://sosoapi.ai/ja/docs/api/analytics-api-reporting-templates-get 契約: sha256:d6e85a113e8fb367 非公開レポートテンプレートのバージョンを取得。指定された確認済みデータセットとバージョンを使用し、ソースは自動更新しません。 レンダリング入力は sosoapi report render --output FILE にパイプで渡せます。 POST /analytics-api/reporting/templates/get ## 認証と権限 - **受け付ける認証情報の種類:** user_session, delegated_oauth, personal_access_token - **委任された機能権限:** agent:operate - **ワークスペースの最低ロール:** viewer - **アクセス範囲:** このユーザーがアクセスを許可されたリソース - **すべてのワークスペースへの同意が必要:** いいえ - **状態を変更:** いいえ - **操作完了時：** synchronous_http_response トークンは所有者の権利内でのみ使えます。各要求で所属、リソース所有権、選択ワークスペース、付与機能を確認します。coreとfullは表示だけを変え、アクセスは付与しません。 ## リクエストのフィールド ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "workspace_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "workspace_id", "id", "version" ], "additionalProperties": false } ``` ## レスポンスと完了条件 成功時のHTTPステータス： 200 HTTP成功は完了ではなく受理の場合があります。バックグラウンド処理はIDを保存し、同じ処理を完了まで確認します。予約・受理された投稿はプラットフォーム確認後のみ公開済みです。タイムアウトだけでは結果を判断できません。 ```json { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "contractVersion": { "type": "string", "const": "analytics-template/v1" }, "workspaceId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "selection" }, "field": { "type": "string", "enum": [ "accounts", "period", "timezone", "platforms", "dataset", "reviewed", "coverage" ] } }, "required": [ "kind", "field" ] }, { "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", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "providerResourceId": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 512 }, { "type": "null" } ] }, "sourcePath": { "type": "string", "maxLength": 2000 }, "requestId": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] } }, "required": [ "kind", "platform", "key", "unit", "grain", "measurementKind" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "formula" }, "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "version": { "type": "integer", "minimum": 1, "maximum": 1000000 } }, "required": [ "kind", "id", "version" ] }, { "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" ] }, { "type": "object", "properties": { "kind": { "type": "string", "const": "chart" }, "source": { "type": "string", "const": "publication_by_platform" } }, "required": [ "kind", "source" ] } ] } }, "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" ] } ``` ## エラーと安全な再試行 HTTPステータスとレスポンス本文を確認します。400の検証エラーにはZodErrorが含まれる場合があります。ハンドラーエラーはerror、message、codeを使用します。診断用にrequest_idまたはx-request-idを保持し、認証情報は含めないでください。401/403はアクセス問題を解消してから再試行し、429はRetry-Afterに従います。書き込み結果が不確か、または5xxの場合は、まず既存の結果を取得してください。冪等性キーは対応する操作でのみ再利用します。再試行の挙動は操作ごとに異なり、厳密に一回の配信は保証しません。 ## 例 スキーマ確認済みの架空値の例です。認可されたID、準備済みメディア、確認済みの公開日時に置き換え、書き込み前に適格性を確認してください。このページはAPIを呼びません。 サーバーのSOSOAPI_ACCESS_TOKENに操作が受け付ける認証情報を設定し、ブラウザーコードに含めないでください。エージェントはsosoapi auth loginでブラウザーログインし、CLIに更新を任せます。 request.json ```json { "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1 } ``` cURL ```bash curl --request POST \ "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/reporting/templates/get" \ -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \ -H "Content-Type: application/json" \ --data-binary @request.json ``` JavaScript ```js // Server-side JavaScript. Do not print tokens or credential-bearing responses. const token = process.env.SOSOAPI_ACCESS_TOKEN; if (!token) throw new Error("Set an accepted credential for this operation"); const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/analytics-api/reporting/templates/get", { method: "POST", headers: { "Content-Type": "application/json", Authorization: "Bearer " + token }, body: JSON.stringify({ "workspace_id": "11111111-1111-4111-8111-111111111111", "id": "11111111-1111-4111-8111-111111111111", "version": 1 }) }); const result = await response.json(); // Check response.ok, the operation-specific body and completion state before continuing. ``` CLI ```bash npx sosoapi api post /analytics-api/reporting/templates/get < request.json ``` 合成レスポンス例 ```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" } ``` ## 関連ツールとガイド MCP: sosoapi_get_report_template [APIリファレンス](https://sosoapi.ai/ja/docs/api)