Connect REST API 開発者ガイド
jAction Link Group Definition Input
アクションリンク定義の情報はサードパーティの機密情報 (OAuth ベアラートークンヘッダーなど) である可能性があります。そのため、アクションリンク定義を作成した接続アプリケーション経由で実行された要求のみが定義を参照、変更、または削除できます。さらに、要求を実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。
- ルート XML タグ
- <actionLinkGroup>
- JSON の例
- 次の例では、テンプレートを使用せずにアクションリンクグループ定義をインスタンス化しています。
- 次の例では、テンプレートからアクションリンクグループ定義をインスタンス化しています。
- プロパティ
-
名前 型 説明 必須か省略可能 使用可能なバージョン actionLinks Action Link Definition Input[] グループ内の各アクションリンク。 アクションリンクグループ内では、アクションリンクは、Action Link Group Definition Input リクエストボディの actionLinks プロパティにリストされる順序で表示されます。フィード項目内では、アクションリンクグループは、Associated Actions Capability Input リクエストボディの actionLinkGroupIds プロパティに指定された順序で表示されます。
テンプレートを使用せずにアクションリンクグループをインスタンス化する場合は必須。 テンプレートからインスタンス化する場合は、値を指定しないでください。
33.0 category String 関連付けられたフィード項目内でのアクションリンクの優先度および相対位置を示します。値は次のとおりです。 - Primary — アクションリンクグループは、フィード要素の本文に表示されます。
- Overflow — アクションリンクグループは、フィード要素のオーバーフローメニューに表示されます。
テンプレートを使用せずにアクションリンクグループをインスタンス化する場合は必須。 テンプレートからインスタンス化する場合は、値を指定しないでください。
33.0 executionsAllowed String アクションリンクを実行できる回数を定義します。値は次のとおりです。 - Once — アクションリンクは、すべてのユーザーで 1 回のみ実行できます。
- OncePerUser — アクションリンクは、各ユーザーで 1 回のみ実行できます。
- Unlimited — アクションリンクは、各ユーザーで無制限に実行できます。アクションリンクの actionType が Api または ApiAsync の場合、この値を使用できません。
テンプレートを使用せずにアクションリンクグループをインスタンス化する場合は必須。 テンプレートからインスタンス化する場合は、値を指定しないでください。
33.0 expirationDate String このアクションリンクグループが関連付けられたフィード項目から削除され、実行できなくなる日時を表す ISO 8601 日付文字列 (例: 2011-02-25T18:24:31.000Z)。expirationDate は、作成日から 1 年以内の日時である必要があります。 アクションリンクグループ定義に OAuth トークンが含まれる場合、アクションリンクグループの有効期限を OAuth トークンの有効期限と同じ値に設定することをお勧めします。そうすれば、ユーザーがアクションリンクを実行できず、OAuth エラーは発生しません。
テンプレートからインスタンス化するときに日付を設定する場合は、「アクションリンクテンプレートの設計」の「アクションリンクグループの有効期限の設定」を参照してください。
テンプレートを使用せずにアクションリンクグループをインスタンス化する場合は必須。 テンプレートからインスタンス化する場合は省略可能。
33.0 templateBindings Action Link Template Binding Input[] アクションリンクテンプレートからバインド変数値またはカスタムユーザー別名に入力されるキー - 値のペアのコレクション。バインド変数を使用するアクションリンクテンプレートからこのアクションリンクグループをインスタンス化するには、すべての変数の値を指定する必要があります。「アクションリンクテンプレートの設計」の「バインド変数の定義」を参照してください。 テンプレートを使用せずにインスタンス化する場合は、値を指定しないでください。 バインド変数を使用するテンプレートからこのアクションリンクグループをインスタンス化する場合は必須。
33.0 templateId String このアクションリンクグループのインスタンス化に使用されたアクションリンクグループテンプレートの ID。 テンプレートを使用せずにインスタンス化する場合は、値を指定しないでください。 テンプレートからこのアクションリンクグループをインスタンス化する場合は必須。
33.0