Skip Navigation

この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。

英語に切り替える

ConnectApi.ActionLinkDefinition

アクションリンクの定義。アクションリンク定義は、サードパーティの機密情報である可能性があります (OAuth ベアラートークンヘッダーなど)。そのため、アクションリンク定義を作成した Apex 名前空間からのコールでのみ定義を参照、変更、または削除できます。さらに、コールを実行するユーザーは、定義を作成したユーザーか、「すべてのデータの参照」権限を持つユーザーである必要があります。

プロパティ名	型	説明	使用可能なバージョン
`actionUrl`	String	アクションリンクの URL。たとえば、`Ui` アクションリンク URL は Web ページになります。`Download` アクションリンク URL は、ダウンロードするファイルへのリンクになります。`Ui` および `Download` アクションリンク URL がクライアントに提供されます。`Api` または `ApiAsync` アクションリンク URL は REST リソースになります。`Api` および `ApiAsync` アクションリンク URL はクライアントに提供されません。Salesforce へのリンクは、相対リンクにすることができます。他のすべてのリンクは、`https://` で始まる絶対リンクにする必要があります。	33.0
`createdDate`	Datetime	ISO 8601 形式の��付文字列 (例: 2011-02-25T18:24:31.000Z)。	33.0
`excludedUserId`	String	アクションの実行から除外する単一ユーザーの ID。`excludedUserId` を指定した場合、`userId` を指定できません。	33.0
`groupDefault`	Boolean	このアクションがアクションリンクグループのデフォルトアクションリンクである場合は `true`、それ以外の場合は `false`。各アクションリンクグループに含めることができるデフォルトアクションリンクは 1 つだけです。Salesforce UI では、デフォルトアクションリンクには区別しやすいスタイルが適用されます。	33.0
`headers`	List<`ConnectApi.RequestHeader`>	`Api` および `ApiAsync` アクションリンク種別の要求ヘッダー。	33.0
`id`	String	アクションリンク定義の 18 文字の ID。	33.0
`label`	String	アクションリンクボタンに表示するカスタムの表示ラベル。`label` 値は、アクションリンクテンプレートでのみ設定できます。アクションリンクには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の 4 つの状況があります。次の文字列が、各状況の表示ラベルに追加されます。表示ラベル表示ラベル待機中表示ラベル成功表示ラベル失敗たとえば、`label` の値が「See Example」の場合、4 つのアクションリンクの状態の値は「See Example」、「See Example 待機中」、「See Example 成功」、および「See Example 失敗」になります。アクションリンクでは、表示ラベル名の生成に `label` または `labelKey` を使用できますが、両方は使用できません。`label` に値がある場合、`labelKey` の値は `None` になります。`labelKey` に `None` 以外の値がある場合、`label` の値は `null` になります。	34.0
`labelKey`	String	ユーザーインターフェースに表示される表示ラベルのセットのキー。セットには、NewStatus、PendingStatus、SuccessStatus、FailedStatus の状態の表示ラベルが含まれます。たとえば、`Approve` キーを使用する場合、[承認]、[待機中]、[承認済み]、[失敗] の表示ラベルが含まれます。表示ラベルキーの完全なリストは、『Connect REST API 開発者ガイド』の「アクションリンクの表示ラベル」を参照してください。	33.0
`method`	`ConnectApi.HttpRequestMethod`	HTTP メソッド。次のいずれかの値になります。 `HttpDelete` — 成功した場合は HTTP 204 を返します。レスポンスボディまたは出力クラスは空です。 `HttpGet` — 成功した場合は HTTP 200 を返します。 `HttpHead` — 成功した場合は HTTP 200 を返します。レスポンスボディまたは出力クラスは空です。 `HttpPatch` — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。 `HttpPost` — 成功した場合は HTTP 201 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。例外は、成功時に HTTP 200 を返すバッチ投稿リソースおよびメソッドです。 `HttpPut` — 成功した場合は HTTP 200 を返し、レスポンスボディまたは出力クラスが空の場合は HTTP 204 を返します。	33.0
`modifiedDate`	Datetime	ISO 8601 形式の日付文字列 (例: 2011-02-25T18:24:31.000Z)。	33.0
`requestBody`	String	`Api` および `ApiAsync` アクションリンク種別のリクエストボディ。 `requestBody` 値の疑問符文字をエスケープします。メモ	33.0
`requiresConfirmation`	Boolean	ユーザーにアクションを確認するように要求する場合は `true`、それ以外の場合は `false`。	33.0
`templateId`	String	このアクションリンクのインスタンス化に使用されたアクションリンクテンプレートの ID。アクションリンクがテンプレートに関連付けられていない場合、値は `null` です。	33.0
`type`	`ConnectApi.ActionLinkType`	アクションリンクの種別を定義します。値は次のとおりです。 `Api` — アクションリンクは、アクション URL で同期 API をコールします。Salesforce は、サーバーから返された HTTP 状況コードに基づいて状況を `SuccessfulStatus` または `FailedStatus` に設定します。 `ApiAsync` — アクションリンクは、アクション URL で非同期 API をコールします。アクションは、非同期操作の完了時にサードパーティが `/connect/action-links/actionLinkId` への要求を行って状況を `SuccessfulStatus` または `FailedStatus` に設定するまで、`PendingStatus` 状態のままになります。 `Download` — アクションリンクは、アクション URL からファイルをダウンロードします。 `Ui` — アクションリンクはアクション URL の Web ページをユーザーに表示します。アプリケーションから `ApiAsync` アクションリンクを呼び出す場合は状況を設定するコールが必要です。ただし、現在 Apex を使用してアクションリンクの状況を設定する方法がありません。状況を設定するには、Connect REST API を使用します。詳細は、『Connect REST API 開発者ガイド』の「Action Link リソース」を参照してください。メモ	33.0
`userId`	String	アクションを実行できるユーザーの ID。指定しない場合や `null` の場合、すべてのユーザーがアクションを実行できます。`userId` を指定した場合、`excludedUserId` を指定できません。	33.0