ExternalClientApplication | メタデータ API 開発者ガイド

親種別

Metadata メタデータ型を拡張し、その fullName 項目を継承します。

ファイルのサフィックスおよびディレクトリの場所

ExternalClientApplication コンポーネントは .eca のサフィックスを持ち、externalClientApps フォルダーに保存されます。

バージョン

ExternalClientApplication コンポーネントは、API バージョン 59.0 以降で利用できます。

特別なアクセスルール

ExternalClientApplication 型へアクセスするには、組織の [設定] で「外部クライアントアプリケーションへのオプトイン」権限が有効になっている必要があります。

項目

項目名	説明
contactEmail	項目の型 string 説明 Salesforce が登録者組織の外部クライアントアプリケーション管理者への連絡に使用するメールアドレス。
contactPhone	項目の型 string 説明 Salesforce が登録者組織の外部クライアントアプリケーション管理者への連絡に使用する電話番号。
description	項目の型 string 説明アプリケ��ションの説明。
distributionState	項目の型 ExtlClntAppDistState (string 型の列挙) 説明外部クライアントアプリケーションの配信状態。値は次のとおりです。 `Local` `Managed`。組織内でのみ使用します。 `Packaged`
iconUrl	項目の型 string 説明アイコン画像の URL。
infoUrl	項目の型 string 説明将来の使用のために予約されています。
isProtected	項目の型 boolean 説明サブスクライバー組織内のコンポーネントの可視性を制御するために開発者が使用するパッケージ構造。デフォルトは false です。
label	項目の型 string 説明外部クライアントアプリケーションの表示ラベル。
logoUrl	項目の型 string 説明ロゴ画像の URL。
managedType	項目の型 ExtlClntAppManagedType (string 型の列挙) 説明組織内でのみ使用します。
orgScopedExternalApp	項目の型 string 説明組織 ID と、この外部クライアントアプリケーション名から成る一意の ID。開発者が定義するか、最初のリリース時に自動生成されます。期待される値は次の形式になります: [`組織 ID`]:[`外部クライアントアプリケーション名`]。

宣言的なメタデータの定義のサンプル

次の例は、ExternalClientApplication コンポーネントを示しています。

1<?xml version="1.0" encoding="UTF-8"?>
2<ExternalClientApplication xmlns="http://soap.sforce.com/2006/04/metadata">
3    <contactEmail>johndoe@example.com</contactEmail>
4    <description>Test external client app</description>
5    <distributionState>Local</distributionState>
6    <iconUrl>https://icon.example.com</iconUrl>
7    <infoUrl>https://info.example.com</infoUrl>
8    <logoUrl>https://logo.example.com</logoUrl>
9    <label>myeca</label>
10    <isProtected>false</isProtected>
11    <orgScopedExternalApp>Org_ID:External_Client_App_Name</orgScopedExternalApp> 
12</ExternalClientApplication>

この例の package.xml は、以前の定義を参照します。

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>ExternalClientApplication</name>
6    </types>
7    <types>
8        <members>*</members>
9        <name>ExtlClntAppOauthSettings</name>
10    </types>
11    <types>
12        <members>*</members>
13        <name>ExtlClntAppGlobalOauthSettings</name>
14    </types>
15    <types>
16        <members>*</members>
17        <name>ExtlClntAppOauthConfigurablePolicies</name>
18    </types>
19    <types>
20        <members>*</members>
21        <name>ExtlClntAppConfigurablePolicies</name>
22    </types>
23    <version>60.0</version>
24</Package>

マニフェストファイル内のワイルドカードのサポート

このメタデータ型では、package.xml マニフェストファイル内のワイルドカード文字 * (アスタリスク) がサポートされます。マニフェストファイルの使用についての詳細は、「zip ファイルを使用したメタデータのリリースと取得」を参照してください。