Analytics REST API 開発者ガイド
jTemplate リソース
- リソース URL
-
1/wave/templates/<templateIdOrApiName> - 形式
- JSON
- 使用可能なバージョン
- 36.0
- HTTP のメソッド
- DELETE GET PUT
- GET の要求パラメータ
- GET レスポンスボディ (TemplateRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン assetIcon String Analytics アプリケーションを最適に表すアイコン。 Small、36.0 36.0 ～ 41.0 assetVersion Double すべてのダッシュボードとレンズのアセットバージョン (API バージョン)。 Big、37.0 37.0 configurationUrl String テンプレートの設定の URL。 Small、36.0 36.0 customAttributes TemplateCustomAttributesRepresentation テンプレートのカスタム属性定義。 Big、44.0 44.0 description String テンプレートの説明。 Big、36.0 36.0 folderSource AssetReferenceRepresentation テンプレートの取得元フォルダ Medium、39.0 39.0 icons TemplateIconsRepresentation テンプレート用に設定されたアイコン。 Small、41.0 41.0 id String テンプレートの ID または完全修飾 API 参照名。 Small、36.0 36.0 label String アプリケーションテンプレートのローカライズされた名前。 Small、36.0 36.0 name String テンプレートのローカル API 参照名。 Medium、36.0 36.0 namespace String テンプレートプロバイダの名前空間。 Medium、36.0 36.0 releaseInfo TemplateReleaseRepresentation テンプレートのリリース情報 Medium、37.0 37.0 tags String[] テンプレートのタグ定義のリスト。 Big、44.0 44.0 templateIcon String Analytics アプリケーションテンプレートを最適に表すアイコン。 Small、36.0 36.0 ～ 41.0 templateType ConnectWaveTemplateTypeEnum テンプレートの種類。有効な値は、次のとおりです。 - App
- Dashboard
- Embedded
- Lens
Small、36.0 36.0 url String テンプレートの詳細の URL。 Small、36.0 36.0 videos VideoInfoRepresentation テンプレートに関連付けられている動画。 Big、46.0 46.0 - PUT リクエストボディ (TemplateInputRepresentation)
-
TemplateInputRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、TemplateInputRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 必須か省略可能 使用可能なバージョン dataflow AssetReferenceInputRepresentation このアプリケーションに関連付けられたデータフロー。 省略可能 39.0 folderSource AssetReferenceInputRepresentation このテンプレートの作成元であるフォルダ。 必須 39.0 - PUT レスポンスボディ (TemplateRepresentation)
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン assetIcon String Analytics アプリケーションを最適に表すアイコン。 Small、36.0 36.0 ～ 41.0 assetVersion Double すべてのダッシュボードとレンズのアセットバージョン (API バージョン)。 Big、37.0 37.0 configurationUrl String テンプレートの設定の URL。 Small、36.0 36.0 customAttributes TemplateCustomAttributesRepresentation テンプレートのカスタム属性定義。 Big、44.0 44.0 description String テンプレートの説明。 Big、36.0 36.0 folderSource AssetReferenceRepresentation テンプレートの取得元フォルダ Medium、39.0 39.0 icons TemplateIconsRepresentation テンプレート用に設定されたアイコン。 Small、41.0 41.0 id String テンプレートの ID または完全修飾 API 参照名。 Small、36.0 36.0 label String アプリケーションテンプレートのローカライズされた名前。 Small、36.0 36.0 name String テンプレートのローカル API 参照名。 Medium、36.0 36.0 namespace String テンプレートプロバイダの名前空間。 Medium、36.0 36.0 releaseInfo TemplateReleaseRepresentation テンプレートのリリース情報 Medium、37.0 37.0 tags String[] テンプレートのタグ定義のリスト。 Big、44.0 44.0 templateIcon String Analytics アプリケーションテンプレートを最適に表すアイコン。 Small、36.0 36.0 ～ 41.0 templateType ConnectWaveTemplateTypeEnum テンプレートの種類。有効な値は、次のとおりです。 - App
- Dashboard
- Embedded
- Lens
Small、36.0 36.0 url String テンプレートの詳細の URL。 Small、36.0 36.0 videos VideoInfoRepresentation テンプレートに関連付けられている動画。 Big、46.0 46.0 - TemplateIconsRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン appBadge AssetReferenceRepresentation このテンプレートから作成されたアプリケーションで使用されるバッジアイコン。 Small、41.0 41.0 templateBadge AssetReferenceRepresentation テンプレート設定ウィザードでこのテンプレートを表すために使用されるバッジアイコン。 Small、41.0 41.0 templatePreviews ImageAssetReferenceRepresentation[] ウィザードでテンプレートが選択されたときに、そのテンプレートの詳細ページのカルーセルに表示される画像のリスト。 Small、44.0 44.0 - TemplateReleaseRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン notesUrl String このテンプレートのリリースノートの URL Small、37.0 37.0 templateVersion String このテンプレートのバージョン。 Small、37.0 37.0 - TemplateCustomAttributesRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン label String カスタム属性メタデータの表示ラベル。 Small、44.0 44.0 values String[] カスタム属性メタデータの値のリスト。 Small、44.0 44.0 - VideoInfoRepresentation
-
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン id String 動画コンテンツのプラットフォーム固有の ID。 Small、46.0 46.0 label String 動画のタイトル。 Small、46.0 46.0 linkType ConnectTemplateVideoLinkTypeEnum 動画プラットフォーム。有効な値は、次のとおりです。 - Vidyard
- YouTube
Small、46.0 46.0 purpose ConnectTemplateVideoPurposeEnum 動画の目的。有効な値は、次のとおりです。 - Onboarding
- Walkthrough
Small、46.0 46.0 showPlaylist Boolean 動画プラットフォームにプレイリストを表示するか否かを示します。 Small、46.0 46.0 - ImageAssetReferenceRepresentation
-
ImageAssetReferenceRepresentation は、抽象 BaseAssetInputRepresentation からプロパティを継承します。これらの基本プロパティは、ImageAssetReferenceRepresentation に、次のテーブルで明示的に定義されたプロパティとともに表示されます。
プロパティ名 型 説明 検索条件グループとバージョン 使用可能なバージョン description String 画像の説明。 Small、44.0 44.0