Almabase (プレビュー)
Almabase は世界一好評な卒業生管理ソフトウェアで、卒業生に特化したプログラムを構築して参加や寄付者のエンゲージメントを促進し、魅力的なオンライン コミュニティをホストします。
このコネクタは、次の製品および地域で利用可能です。
| Service | クラス | 地域 |
|---|---|---|
| Logic Apps | 標準 | 以下を除くすべての Logic Apps 地域 : - Azure 政府の地域 - Azure 中国の地域 - 国防総省 (DoD) |
| Power Automate | プレミアム | 以下を除くすべての Power Automate 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 国防総省 (DoD) |
| Power Apps | プレミアム | 以下を除くすべての Power Apps 地域 : - 米国政府 (GCC) - 米国政府 (GCC High) - 21Vianet が運用する中国のクラウド - 米国国防総省 (DoD) |
| お問い合わせ先 | |
|---|---|
| 件名 | Almabase サポート |
| [URL] | https://docs.almabase.com |
| メール | help@almabase.com |
| Connector Metadata | |
|---|---|
| 発行者 | Almabase, Inc. |
| Web サイト | https://almabase.com |
| プライバシー ポリシー | https://www.almabase.com/ecloud-privacy-policy |
| カテゴリ | 販売と CRM; 生産性 |
Almabase は教育機関が、関わっていない卒業生を生涯のサポーターに変える卒業生中心のプログラムを構築するためのソフトウェア ツールと戦略を提供します。
このコネクタは、Almabase API と Webhook の上に構築されており、Almabase 内にある、以下を含むエンティティの管理に役立つ操作を提供します。
- レコード (スタッフ)
- ギフト
- イベント
- エンゲージメント タッチポイント
- フォーム
- 資金
- 寄付ページ
- ピア ツー ピア募金キャンペーン
- その他...
前提条件
このコネクタを使用するには、
- Almabase の有効なサブスクリプションが必要です。
- サイト管理者ロールが必要です。
資格情報の入手方法
- Almabase が提供する管理ポータルにログインします。
Settingsの下のAPI's & Tokensへ移動します。Add Auth Tokenをクリックし、descriptionに入力し、expiry date & timeトークンを設定します。Workflow Access Tokenを書き留めます (トークンをクリックしてクリップボードにコピーします)。- Power Automate で新しい接続を作成するとき、
Workflow Access Tokenを使用します。
コネクタの使用を開始する
一般的なユース ケース
- 寄付が行われたら、パーソナライズされたメッセージと寄付の受領書を送信します。
- エンゲージメント アクティビティが Slack、Gmail、またはその他のソーシャル メディアに記録されている場合は、
Create Custom Touchpointアクションを使用してエンゲージメント アクティビティを Almabase の Engagement Studio に追加します。 - 寄付、イベント登録、またはフォーム送信で (不明だった卒業生の) 新しいメール アドレスが見つかった場合、そのメール アドレスを Almabase のレコード、Raiser's Edge のメンバー、または Salesforce の連絡先に追加します。
- Almabase と Blackbaud Raiser's Edge 間の双方向データ同期を設計します。
- Almabase と Salesforce 間の双方向データ同期を設計します。
既知の問題と制限事項
- 寄付トリガーは、Almabase でオンライン支払いが行われた場合にのみ機能します。 手動で追加された寄付はフローをトリガーしません。
接続の作成
コネクタは、次の認証タイプをサポートしています:
| 既定 | 接続を作成するためのパラメーター。 | すべての地域 | 共有不可 |
既定
適用できるもの: すべての領域
接続を作成するためのパラメーター。
これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。
| 名称 | タイプ | 内容 | 必要 |
|---|---|---|---|
| ドメイン URL | 文字列 | Almabase ドメインの URL を指定します。例: https://your.domain.com | 真 |
| API キー | securestring | ユーザーの API キー | True |
調整制限
| 名前 | 呼び出し | 更新期間 |
|---|---|---|
| 接続ごとの API 呼び出し | 100 | 60 秒 |
アクション
| イベントを一覧表示 |
すべてのイベントの一覧を返します。 |
| イベントを作成する |
新しいイベントを作成します。 |
| イベントを取得する |
イベントに関する情報を返します。 |
| イベントを更新する |
イベントを更新します。 |
| ギフトの一覧 |
ギフトの一覧を返します。 |
| ギフトを作成する |
新しいギフトを作成します。 |
| ギフトを取得する |
ギフトに関する情報を返します。 |
| ギフトを更新する |
ギフトを更新する |
| タッチポイントを作成する |
新しいカスタム タッチ ポイントを Almabase に送信します。 |
| フォームの一覧 |
フォームの一覧を取得します。 |
| フォームの送信を取得します |
フォームの送信に関する情報を返します。 |
| フォームを送信する |
フォームの新しいフォーム送信を作成する |
| レコードのメール アドレスの一覧 |
レコードのメール アドレスの一覧を返します。 |
| レコードのメール アドレスを作成する |
レコードの新しいメール アドレスを作成します。 |
| レコードのメール アドレスを削除 |
レコードのメール アドレスを削除します。 |
| レコードのメール アドレスを取得する |
レコードのメール アドレスに関する情報を返します。 |
| レコードのメール アドレスを更新する |
レコードのメール アドレスのフィールドを更新する |
| レコードの一覧を表示する |
レコードの一覧を返します。 |
| レコードを作成する |
新しいレコードを作成します。 |
| レコードを取得する |
レコードに関する情報を返します。 |
| レコードを更新する |
レコードを更新します。 |
| 寄付ページの一覧 |
寄付ページの一覧を返します。 |
| 寄付ページを取得する |
寄付ページに関する情報を返します。 |
| 資金の一覧 |
資金の一覧を返す |
| 資金の作成 |
新しい資金を作成します。 |
| 資金を取得する |
資金に関する情報を返します。 |
| 資金を更新する |
資金を更新します。 |
| 連絡担当者を一覧表示 |
イベントのすべての連絡担当者の一覧を返します。 |
| 連絡担当者を更新する |
イベントの連絡担当者を更新します。 |
| 連絡担当者を追加する |
連絡担当者をイベントに追加します。 |
イベントを一覧表示
すべてのイベントの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
外部データベース ID で検索する
|
external_database_id | string |
外部データベース ID でイベントを検索します。 |
|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
イベントを作成する
新しいイベントを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
Description
|
description | string |
イベントの説明 |
|
|
終了日時
|
end_datetime | string |
イベントの終了時刻 |
|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
|
外部登録 URL
|
external_registration_url | string |
外部 Web サイトでのイベントの登録 URL です |
|
|
件名
|
name | True | string |
イベントの名前 |
|
開始日時
|
start_datetime | string |
イベントの開始時刻 |
|
|
タイム ゾーン
|
timezone | string |
イベントのタイム ゾーン |
|
|
件名
|
display_name | string |
会場の市区町村、都道府県、郡 |
戻り値
イベント
イベントを取得する
イベントに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
id | True | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
イベント
イベントを更新する
イベントを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
id | True | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
|
Description
|
description | string |
イベントの説明 |
|
|
終了日時
|
end_datetime | string |
イベントの終了時刻 |
|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
|
外部登録 URL
|
external_registration_url | string |
外部 Web サイトでのイベントの登録 URL です |
|
|
件名
|
name | string |
イベントの名前 |
|
|
開始日時
|
start_datetime | string |
イベントの開始時刻 |
|
|
タイム ゾーン
|
timezone | string |
イベントのタイム ゾーン |
|
|
件名
|
display_name | string |
会場の市区町村、都道府県、郡 |
戻り値
イベント
ギフトの一覧
ギフトの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
状態
|
status | True | string |
状態に基づいてギフトをフィルターします。 |
|
寄付ページ
|
campaign | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
|
ギフト グループ ID でフィルター
|
group_id | uuid |
ギフト グループや一覧を一意に識別するためにシステムで生成された ID。 |
|
|
バッチ番号を空白にするか
|
batch_number__isnull | boolean |
バッチ番号があるかどうかに基づいて、ギフトをフィルターします。 |
|
|
外部データベース ID を空白にするか
|
external_database_id__isnull | boolean |
ギフトがすでに外部データベース ID を持っているかどうかに基づいて、ギフトをフィルタリングします。 注: 外部データベース ID を持つギフトは、すでに外部データベースにプッシュされています。 |
|
|
外部データベース ID でフィルター
|
external_database_id | string |
外部データベース ID でギフトをフィルター処理します。 |
|
|
寄贈者の電子メールでフィルター
|
donor_email | string |
寄贈者のメール アドレスでギフトをフィルター |
|
|
検索条件
|
search | string |
ギフトを名前またはメール アドレスで検索します。 |
|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
|
|
ページ サイズ
|
page_size | integer |
返されるレコード数を表します。 既定値は 10 です。 最大値は 50 です。 |
|
|
ページ番号
|
page | integer |
ページ番号 (オフセット) を表します。 改ページで使用します。 |
|
|
並べ替え順
|
ordering | string |
応答結果における寄付の並び順を定義します。 接頭辞「-」は降順を示します。接頭辞がない場合は昇順で結果を返します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
次の結果の URL
|
nextlink | uri |
検索結果の次のページ セットの URL。 改ページで使用します。 |
|
前の結果 URL
|
previouslink | uri |
検索結果の前のページ セットの URL。 改ページで使用します。 |
|
ギフトの合計
|
total | integer |
指定されたフィルターでのギフトの合計 |
|
ギフト
|
value | array of v1.GivingApi.GiftRead |
指定されたフィルターで返された寄付の一覧。 結果はページ割り付けされます。 |
ギフトを作成する
新しいギフトを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
贈与の金額
|
amount | True | string |
ギフトの金額 (小数点以下 2 桁)。 |
|
バッチ番号
|
batch_number | string |
ギフトのバッチ番号。 |
|
|
贈与の日付
|
completed_at | True | date-time |
ギフトの状態が完了とマークされた日付。 |
|
通貨
|
currency | True | integer |
寄贈者がギフトに使用する通貨です。 |
|
寄付者の住所: 1 行目
|
donor_address_line1 | string |
寄付者がギフトに使用する住所行 1。 |
|
|
寄付者の住所: 2 行目
|
donor_address_line2 | string |
寄付者がギフトに使用する住所行 2。 |
|
|
名前: 市区町村、都道府県、国
|
name | string |
寄付者の市区町村。 形式: 市区町村名、都道府県、短い国名 |
|
|
寄贈者の電子メール
|
donor_email | True |
寄贈者がギフトに使用する電子メール ID です。 |
|
|
寄付者の名前
|
donor_name | True | string |
寄付者の氏名。 |
|
寄贈者の電話番号
|
donor_phone_number | string |
寄付者が贈与に使用する電話番号。 |
|
|
寄付者の住所: 郵便番号
|
donor_zip_code | string |
寄付者がギフトに使用する住所の郵便番号。 |
|
|
リーダーボードで非表示ですか?
|
exclude_from_leaderboard | boolean |
リーダーボードで非表示ですか? |
|
|
外部データベース ID
|
external_database_id | string |
外部データベース システムにより、ギフトに一意の ID が割り当てられました。 |
|
|
敬意のメッセージ
|
honor_message | string |
贈与に対する敬意のメッセージ。 |
|
|
敬意の接頭辞
|
honor_prefix | string |
寄付に添える言葉。 使用できるオプション: 敬意を表して、記念して、ご支援により |
|
|
匿名かどうか
|
is_anonymous | boolean |
この寄贈に対する寄付者の希望により、他の寄付者に対して匿名にすることを示します。 |
|
|
支払いモード
|
mode | True | string |
支払いモード、オンラインまたはオフライン。 |
|
メモ
|
note | string |
メモのテキスト。 |
|
|
その他の資金名
|
other_fund_name | string |
寄付者が is_other_fund とマークされた資金を選択すると、寄付のあて先となるカスタム ファンド名が追加されます。 |
|
|
寄付ページ
|
id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
|
量
|
amount | True | string |
贈与分割の金額。 |
|
資金
|
id | True | integer |
資金を一意に識別するためにシステムで生成された ID。 |
|
状態
|
status | True | string |
ギフトの状態。 |
戻り値
ギフト
ギフトを取得する
ギフトに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
id | True | integer |
ギフトを一意に識別するためにシステムで生成された ID。 |
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
ギフト
ギフトを更新する
ギフトを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
ギフト ID
|
id | True | integer |
ギフトを一意に識別するためにシステムで生成された ID。 |
|
バッチ番号
|
batch_number | string |
ギフトのバッチ番号。 |
|
|
寄付者の住所: 1 行目
|
donor_address_line1 | string |
寄付者がギフトに使用する住所行 1。 |
|
|
寄付者の住所: 2 行目
|
donor_address_line2 | string |
寄付者がギフトに使用する住所行 2。 |
|
|
名前: 市区町村、都道府県、国
|
name | string |
寄付者の市区町村。 形式: 市区町村名、都道府県、短い国名 |
|
|
寄付者の名前
|
donor_name | string |
寄付者の氏名。 |
|
|
寄贈者の電話番号
|
donor_phone_number | string |
寄付者が贈与に使用する電話番号。 |
|
|
寄付者の住所: 郵便番号
|
donor_zip_code | string |
寄付者がギフトに使用する住所の郵便番号。 |
|
|
リーダーボードで非表示ですか?
|
exclude_from_leaderboard | boolean |
リーダーボードで非表示ですか? |
|
|
外部データベース ID
|
external_database_id | string |
外部データベース システムにより、ギフトに一意の ID が割り当てられました。 |
|
|
敬意のメッセージ
|
honor_message | string |
贈与に対する敬意のメッセージ。 |
|
|
敬意の接頭辞
|
honor_prefix | string |
寄付に添える言葉。 使用できるオプション: 敬意を表して、記念して、ご支援により |
|
|
匿名かどうか
|
is_anonymous | boolean |
この寄贈に対する寄付者の希望により、他の寄付者に対して匿名にすることを示します。 |
|
|
メモ
|
note | string |
メモのテキスト。 |
|
|
その他の資金名
|
other_fund_name | string |
寄付者が is_other_fund とマークされた資金を選択すると、寄付のあて先となるカスタム ファンド名が追加されます。 |
|
|
寄付ページ
|
id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
|
量
|
amount | True | string |
贈与分割の金額。 |
|
資金
|
id | True | integer |
資金を一意に識別するためにシステムで生成された ID。 |
戻り値
ギフト
タッチポイントを作成する
新しいカスタム タッチ ポイントを Almabase に送信します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
プログラム
|
touchpoint_program | True | integer |
タッチポイント プログラムごとに種類をフィルターします。 |
|
Email
|
活動に使用するメールの ID。 |
|||
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
|
記録日
|
recorded_at | True | date-time |
活動のタイムスタンプ。 |
|
タイプ
|
id | True | integer |
戻り値
新しいタッチ ポイントを作成するためのタッチポイント本文
フォームの一覧
フォームの一覧を取得します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
フォームの送信を取得します
フォームの送信に関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォーム
|
form_id | True | integer |
フォームを一意に識別するためにシステムで生成された ID。 |
|
回答 ID
|
entry_id | True | string |
フォーム送信を一意に識別するためにシステムで生成された ID。 |
戻り値
フォームを送信する
フォームの新しいフォーム送信を作成する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フォーム
|
form_id | True | integer |
フォームを一意に識別するためにシステムで生成された ID。 |
|
body
|
body | dynamic |
新しいフォーム送信を作成する |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
回答 ID
|
id | integer |
フォーム送信を一意に識別するためにシステムで生成された ID。 |
レコードのメール アドレスの一覧
レコードのメール アドレスの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
record_id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
一対多
|
is_primary | boolean |
プライマリ電子メールを検索します。 |
|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
|
|
ページ サイズ
|
page_size | integer |
返されるレコード数を表します。 既定値は 10 です。 最大値は 50 です。 |
|
|
ページ番号
|
page | integer |
ページ番号 (オフセット) を表します。 改ページで使用します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
次の結果の URL
|
nextlink | uri |
検索結果の次のページ セットの URL。 改ページで使用します。 |
|
前の結果 URL
|
previouslink | uri |
検索結果の前のページ セットの URL。 改ページで使用します。 |
|
メール アドレスの合計
|
total | integer |
指定されたフィルターでのメール アドレスの合計 |
|
メール アドレス
|
value | array of v1.RecordApi.EmailAddressRead |
指定のフィルターに対して返されたレコードのメール アドレスの一覧です。 結果はページ割り付けされます。 |
レコードのメール アドレスを作成する
レコードの新しいメール アドレスを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
record_id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
住所
|
address |
メール アドレス |
||
|
ログインに使用するか
|
is_login_email | boolean |
このメール アドレスを使用したプラットフォームへのログインを、ユーザーに許可するかどうかを示します。 |
|
|
一対多
|
is_primary | boolean |
プライマリ メールは、システムによってトリガーされた自動メールを送信するために使用されます。 また、プロファイルに一括メールを送信するためにも使用されます。 プライマリとして設定するメールは 1 つだけである必要があります。 |
|
|
Source
|
source | string |
ソースは、メールがデータベースに追加される方法を示します。 |
|
|
状態
|
status | string |
メール アドレスの状態 |
|
|
タイプ
|
type | string |
メールの種類 |
戻り値
メール アドレス
レコードのメール アドレスを削除
レコードのメール アドレスを削除します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
record_id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
ID
|
email_id | True | integer |
レコードのメール アドレスを一意に識別するためにシステムで生成された ID。 |
レコードのメール アドレスを取得する
レコードのメール アドレスに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
record_id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
ID
|
email_id | True | integer |
レコードのメール アドレスを一意に識別するためにシステムで生成された ID。 |
戻り値
メール アドレス
レコードのメール アドレスを更新する
レコードのメール アドレスのフィールドを更新する
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
record_id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
メール アドレス ID
|
email_id | True | integer |
レコードのメール アドレスを一意に識別するためにシステムで生成された ID。 |
|
ログインに使用するか
|
is_login_email | boolean |
このメール アドレスを使用したプラットフォームへのログインを、ユーザーに許可するかどうかを示します。 |
|
|
一対多
|
is_primary | boolean |
プライマリ メールは、システムによってトリガーされた自動メールを送信するために使用されます。 また、プロファイルに一括メールを送信するためにも使用されます。 プライマリとして設定するメールは 1 つだけである必要があります。 |
|
|
状態
|
status | string |
メール アドレスの状態 |
|
|
タイプ
|
type | string |
メールの種類 |
戻り値
メール アドレス
レコードの一覧を表示する
レコードの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
名前で検索する
|
search | string |
レコードを名前で検索します。 |
|
|
メール アドレスで検索する
|
email_addresses__address | string |
メール アドレスでレコードを検索します。 |
|
|
外部データベース ID で検索する
|
external_database_id | string |
外部データベース ID でレコードを検索します。 |
|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
|
|
日付以降に更新された
|
updated_at__gte | date-time |
日付以降に更新されました。 |
|
|
日付以降に作成された
|
created_at__gte | date-time |
日付以降に作成されました。 |
|
|
ページ サイズ
|
page_size | integer |
返されるレコード数を表します。 既定値は 10 です。 最大値は 50 です。 |
|
|
ページ番号
|
page | integer |
ページ番号 (オフセット) を表します。 改ページで使用します。 |
戻り値
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
次の結果の URL
|
nextlink | uri |
検索結果の次のページ セットの URL。 改ページで使用します。 |
|
前の結果 URL
|
previouslink | uri |
検索結果の前のページ セットの URL。 改ページで使用します。 |
|
合計レコード数
|
total | integer |
指定されたフィルターでのレコードの合計 |
|
レコード
|
value | array of v1.RecordApi.RecordRead |
指定のフィルターに対して返されたレコードの一覧です。 |
レコードを作成する
新しいレコードを作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
行 1
|
line1 | True | string |
住所の 1 行目 |
|
行 2
|
line2 | string |
住所の 2 行目 |
|
|
件名
|
name | string |
場所の市区町村、都道府県、郡 |
|
|
プライバシー
|
privacy | string |
プライバシー |
|
|
タイプ
|
type | True | string |
番号の種類です |
|
ZipCode
|
zip_code | string |
住所の郵便番号 |
|
|
誕生日
|
date_of_birth | string |
生年月日。 |
|
|
故人
|
deceased | boolean |
故人。 |
|
|
住所
|
address |
メール アドレス |
||
|
ログインに使用するか
|
is_login_email | boolean |
このメール アドレスを使用したプラットフォームへのログインを、ユーザーに許可するかどうかを示します。 |
|
|
一対多
|
is_primary | boolean |
プライマリ メールは、システムによってトリガーされた自動メールを送信するために使用されます。 また、プロファイルに一括メールを送信するためにも使用されます。 プライマリとして設定するメールは 1 つだけである必要があります。 |
|
|
Source
|
source | string |
ソースは、メールがデータベースに追加される方法を示します。 |
|
|
状態
|
status | string |
メール アドレスの状態 |
|
|
タイプ
|
type | string |
メールの種類 |
|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
|
外部データベースの検索 ID
|
external_database_lookup_id | string |
外部データベース内のレコードを表すカスタム ユーザー定義の検索 ID。 例: メンバー ID |
|
|
名
|
first_name | True | string |
レコードの名。 |
|
姓
|
last_name | True | string |
レコードの姓。 |
|
ミドルネーム
|
middle_name | string |
レコードのミドル ネームです。 |
|
|
Number
|
number | True | string |
Number |
|
プライバシー
|
privacy | string |
プライバシー |
|
|
タイプ
|
type | True | string |
番号の種類です |
戻り値
レコード
レコードを取得する
レコードに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
レコード
レコードを更新する
レコードを更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
レコード ID
|
id | True | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
|
外部データベースの検索 ID
|
external_database_lookup_id | string |
外部データベース内のレコードを表すカスタム ユーザー定義の検索 ID。 例: メンバー ID |
|
|
名
|
first_name | string |
レコードの名。 |
|
|
姓
|
last_name | string |
レコードの姓。 |
戻り値
レコード
寄付ページの一覧
寄付ページの一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
寄付ページを取得する
寄付ページに関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
寄付ページ ID
|
id | True | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
寄付ページ
資金の一覧
資金の一覧を返す
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
資金の作成
新しい資金を作成します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステム レコード ID、Salesforce のオブジェクト ID |
|
|
既定の資金ですか?
|
is_default | boolean |
寄付ページで他の資金を定義していない場合、このファンドに分割をすべて関連付けることを示します。 |
|
|
他の資金ですか?
|
is_other_fund | boolean |
この資金の寄付者が、指定したカスタム資金名を持つことを示します。 |
|
|
資金名
|
name | True | string |
資金の名前 |
戻り値
贈与分割に関連付けられた資金。
資金を取得する
資金に関する情報を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
id | True | integer |
資金を一意に識別するためにシステムで生成された ID。 |
|
フィールド
|
fields | array |
応答のフィールドのコンマ区切り一覧。 |
戻り値
贈与分割に関連付けられた資金。
資金を更新する
資金を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
資金 ID
|
id | True | integer |
資金を一意に識別するためにシステムで生成された ID。 |
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステム レコード ID、Salesforce のオブジェクト ID |
|
|
既定の資金ですか?
|
is_default | boolean |
寄付ページで他の資金を定義していない場合、このファンドに分割をすべて関連付けることを示します。 |
|
|
他の資金ですか?
|
is_other_fund | boolean |
この資金の寄付者が、指定したカスタム資金名を持つことを示します。 |
|
|
資金名
|
name | True | string |
資金の名前 |
戻り値
贈与分割に関連付けられた資金。
連絡担当者を一覧表示
イベントのすべての連絡担当者の一覧を返します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
id | True | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
戻り値
連絡担当者を更新する
イベントの連絡担当者を更新します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
id | True | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
|
イベントの連絡担当者 ID
|
person_id | True | integer |
イベントの連絡担当者を一意に識別するためにシステムで生成された ID です。 |
|
メール
|
連絡担当者の電子メール |
|||
|
件名
|
name | string |
連絡担当者の名前 |
|
|
電話番号
|
phone_number | string |
連絡担当者の電話番号 |
戻り値
イベントの連絡担当者
連絡担当者を追加する
連絡担当者をイベントに追加します。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
イベント ID
|
id | True | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
|
メール
|
連絡担当者の電子メール |
|||
|
件名
|
name | string |
連絡担当者の名前 |
|
|
電話番号
|
phone_number | string |
連絡担当者の電話番号 |
戻り値
イベントの連絡担当者
トリガー
| Almabase でレコードが作成または更新された場合 |
Almabase で新しいレコードが作成されるか、既存のレコードが更新された場合にトリガーされます。 |
| フォームが送信された場合、または既存のフォーム送信が更新された場合 |
フォームが送信された場合、または既存のフォーム送信が更新された場合にトリガーされます。 |
| レコードの電子メールが作成、更新、または削除された場合 |
レコードのメールが新しく作成された場合、またはレコードの既存のメールが更新または削除された場合にトリガーされます。 |
| 新しいギフトが成功した場合、またはオンライン ギフトの支払いが失敗した場合 |
寄付者によって寄付ページで新しい寄付が正常に記録された場合、または寄付への支払いが失敗した場合にトリガーされます。 |
Almabase でレコードが作成または更新された場合
Almabase で新しいレコードが作成されるか、既存のレコードが更新された場合にトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
次の場合
|
events | True | string |
フローをトリガーするイベントの一覧。 |
戻り値
フォームが送信された場合、または既存のフォーム送信が更新された場合
フォームが送信された場合、または既存のフォーム送信が更新された場合にトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
次の場合
|
events | True | string |
フローをトリガーするイベントの一覧。 |
|
フォーム
|
object_id | True | integer |
フォームを一意に識別するためにシステムで生成された ID。 |
戻り値
レコードの電子メールが作成、更新、または削除された場合
レコードのメールが新しく作成された場合、またはレコードの既存のメールが更新または削除された場合にトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
次の場合
|
events | True | string |
フローをトリガーするイベントの一覧。 |
戻り値
新しいギフトが成功した場合、またはオンライン ギフトの支払いが失敗した場合
寄付者によって寄付ページで新しい寄付が正常に記録された場合、または寄付への支払いが失敗した場合にトリガーされます。
パラメーター
| 名前 | キー | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
次の場合
|
events | True | string |
フローをトリガーするイベントの一覧。 |
|
寄付ページ
|
object_id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
戻り値
定義
v1.FormApi.FormRead
フォーム
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
フォームを一意に識別するためにシステムで生成された ID。 |
|
フォーム名
|
title | string |
フォームの名前 |
v1.GivingApi.GiftWebhookRecordRead
記録
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
名
|
first_name | string |
マップされたレコードの最初の名 |
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
Almabase に登録済みの寄付者ですか?
|
is_registered | boolean |
マップ済みのレコードや寄付者が Almabase に登録されているかどうかを示します |
|
姓
|
last_name | string |
マップ済みレコードの姓 |
v1.GivingApi.GiftWebhookResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
量
|
data.amount | string |
ギフトの金額 (小数点以下 2 桁)。 |
|
日
|
data.completed_at | date-time |
ギフトの状態が完了とマークされた日付。 |
|
寄贈者の電子メール
|
data.email |
寄贈者がギフトに使用する電子メール ID です。 |
|
|
外部データベース ID
|
data.external_database_id | string |
外部データベース システムにより、ギフトに一意の ID が割り当てられました。 |
|
ID
|
data.id | integer |
ギフトを一意に識別するためにシステムで生成された ID。 |
|
新しいメールですか?
|
data.is_email_new | boolean |
寄付者が提供したメールが Almabase レコードに存在するかどうかを示します。 |
|
スキーマ
|
data.mapped_profile.schema | v1.GivingApi.GiftWebhookRecordRead |
記録 |
|
Mode
|
data.mode | string |
ギフトのモードです。 |
|
寄付者の名前
|
data.name | string |
寄付者の氏名。 |
|
ID
|
data.page.id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
寄付ページ名
|
data.page.name | string |
関連する寄付ページの名前 |
|
状態
|
data.status | string |
ギフトの状態。 |
|
次の場所でイベントをトリガー
|
time | string |
イベントの時間。 |
|
イベント タイプ
|
type | string |
イベントの種類。 |
v1.GivingApi.LocationRead
寄付者がギフトに使用する市区町村。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
市
|
city | string |
寄付者の市区町村 |
|
市区町村の短い名前
|
city_short_name | string |
市区町村の短い表現 (例: SF) |
|
緯度
|
coordinates.latitude | string |
その場所の緯度 |
|
経度
|
coordinates.longitude | string |
その場所の経度 |
|
国
|
country | string |
寄付者の国 |
|
国の短い名前
|
country_short_name | string |
国の短い表現 (例: US) |
|
Google 場所 ID
|
gpid | string |
Google から取得された場所 ID |
|
市区町村、都道府県、国
|
name | string |
寄付者の市区町村。 形式: 市区町村名、都道府県、短い国名 |
|
州
|
state | string |
寄付者の都道府県 |
|
都道府県の短い名前
|
state_short_name | string |
都道府県の短い表現 (例: CA) |
v1.GivingApi.FormFieldRead
フォーム フィールド
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
価値
|
display_value | string |
レスポンダーによって入力されたフォーマットされた値。 例: アップロードのファイル名。 |
|
質問/フォーム フィールド名
|
label | string |
フォームの質問/フォーム フィールド名 |
v1.GivingApi.FundRead
贈与分割に関連付けられた資金。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステム レコード ID、Salesforce のオブジェクト ID |
|
ID
|
id | integer |
資金を一意に識別するためにシステムで生成された ID。 |
|
既定の資金ですか?
|
is_default | boolean |
寄付ページで他の資金を定義していない場合、このファンドに分割をすべて関連付けることを示します。 |
|
他の資金ですか?
|
is_other_fund | boolean |
この資金の寄付者が、指定したカスタム資金名を持つことを示します。 |
|
名称
|
name | string |
資金の名前 |
v1.GivingApi.GiftRead
ギフト
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
贈与の金額
|
amount | string |
ギフトの金額 (小数点以下 2 桁)。 |
|
バッチ番号
|
batch_number | string |
ギフトのバッチ番号。 |
|
贈与の日付
|
completed_at | date-time |
ギフトの状態が完了とマークされた日付。 |
|
通貨
|
currency | integer |
寄贈者がギフトに使用する通貨です。 |
|
デバイス
|
device | string |
ギフトの作成に使用されたデバイス。PC、モバイル、またはタブレットなど。 |
|
寄付者の住所: 1 行目
|
donor_address_line1 | string |
寄付者がギフトに使用する住所行 1。 |
|
寄付者の住所: 行 2
|
donor_address_line2 | string |
寄付者がギフトに使用する住所行 2。 |
|
寄贈者の住所: 場所
|
donor_city_place | v1.GivingApi.LocationRead |
寄付者がギフトに使用する市区町村。 |
|
寄贈者の電子メール
|
donor_email |
寄贈者がギフトに使用する電子メール ID です。 |
|
|
寄付者の名前
|
donor_name | string |
寄付者の氏名。 |
|
寄贈者の電話番号
|
donor_phone_number | string |
寄付者が贈与に使用する電話番号。 |
|
寄付者の住所: 郵便番号
|
donor_zip_code | string |
寄付者がギフトに使用する住所の郵便番号。 |
|
リーダーボードで非表示ですか?
|
exclude_from_leaderboard | boolean |
リーダーボードで非表示ですか? |
|
外部データベース ID
|
external_database_id | string |
外部データベース システムにより、ギフトに一意の ID が割り当てられました。 |
|
敬意のメッセージ
|
honor_message | string |
贈与に対する敬意のメッセージ。 |
|
敬意の接頭辞
|
honor_prefix | string |
寄付に添える言葉。 使用できるオプション: 敬意を表して、記念して、ご支援により |
|
ID
|
id | integer |
ギフトを一意に識別するためにシステムで生成された ID。 |
|
インフルエンサー
|
influencer | v1.GivingApi.InfluencerRead |
公開の共有リンクと非公開のダッシュボード リンク |
|
匿名かどうか
|
is_anonymous | boolean |
この寄贈に対する寄付者の希望により、他の寄付者に対して匿名にすることを示します。 |
|
寄付者が支払いゲートウェイの料金の支払いを選択したか
|
is_donor_covered_charges | boolean |
寄付者がこのギフトを行うときに、支払いゲートウェイの料金を支払うことを選択したかどうかを示します。 |
|
メールが Almabase のレコードに追加されたか
|
is_email_added_to_profile | boolean |
寄付者が提供したメールが Almabase のレコードに追加されたかどうかを示します (is_email_new の状態にかかわらず) |
|
新しいメールですか?
|
is_email_new | boolean |
寄付者が提供したメールが Almabase レコードに存在するかどうかを示します。 |
|
Almabase のレコードへのマッピングが無視されるか
|
is_profile_mapping_ignored | boolean |
レコード マッピングを無視する必要があるかどうかを示します。 |
|
支払いモード
|
mode | string |
支払いモード、オンラインまたはオフライン。 |
|
メモ
|
note | string |
メモのテキスト。 |
|
その他の資金名
|
other_fund_name | string |
寄付者が is_other_fund とマークされた資金を選択すると、寄付のあて先となるカスタム ファンド名が追加されます。 |
|
寄付ページ
|
page | v1.GivingApi.GivingPageAssociatedWithGift |
ギフトに関連する寄付ページ。 |
|
フィールド
|
post_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
回答 ID
|
post_payment_form_entry.id | integer |
フォーム送信を一意に識別するためにシステムで生成された ID。 |
|
フィールド
|
pre_payment_form_entry.fields | array of v1.GivingApi.FormFieldRead | |
|
回答 ID
|
pre_payment_form_entry.id | integer |
フォーム送信を一意に識別するためにシステムで生成された ID。 |
|
マップ済みレコード
|
profile | v1.GivingApi.RecordRead |
Almabase でマップされたレコード |
|
参照元リンク
|
referrer_link | string |
寄付者がどのようにアクセスしたかについての情報源を示す Web サイトのリンク。 例: 寄付者は、Facebook、Google などの寄付キャンペーンにアクセスした。 |
|
返金額
|
refund_amount | string |
寄付者に返金された金額。 全額が返金された場合、ギフトの状態は、完了ではなく返金となります。 |
|
分割
|
splits | array of v1.GivingApi.GiftSplitRead |
贈与に関連付けられた分割。 |
|
状態
|
status | string |
ギフトの状態。 |
|
オンライン トランザクション
|
transaction | v1.GivingApi.TransactionRead |
ギフトに関連するオンライン支払いトランザクション。 |
|
UTM キャンペーン
|
utm_campaign | string |
キーワード分析に使用されます。 utm_campaign は、特定の製品プロモーションまたは戦略的キャンペーンを識別します。 例: annual_fund_2020 |
|
UTM 媒体
|
utm_medium | string |
utm_medium は、メールや 1 クリックあたりのコストなどの媒体を識別します。 例: CPC |
|
UTM ソース
|
utm_source | string |
utm_source は、検索エンジン、ニュースレター名、またはその他のソースを識別します。 例: Google |
v1.GivingApi.GiftSplitRead
贈与の分割
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
量
|
amount | string |
贈与分割の金額。 |
|
資金
|
fund | v1.GivingApi.FundRead |
贈与分割に関連付けられた資金。 |
|
ID
|
id | integer |
ギフト分割を一意に識別するためにシステムで生成された ID。 |
v1.GivingApi.GivingPageAssociatedWithGift
ギフトに関連する寄付ページ。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
名称
|
name | string |
関連する寄付ページの名前。 |
v1.GivingApi.GivingPageRead
寄付ページ
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
寄付ページを一意に識別するためにシステムで生成された ID。 |
|
名称
|
name | string |
寄付ページの名前 |
v1.GivingApi.InfluencerRead
公開の共有リンクと非公開のダッシュボード リンク
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
非公開のインフルエンサー ダッシュボード リンク
|
dashboard_url | uri |
ページへのアクセス数と、それらに影響を受けたギフトを監視する、寄付者の非公開のダッシュボード |
|
公開共有リンク
|
page_share_url | uri |
寄付ページへのアクセスと寄付への影響を追跡するための、寄付者の寄付ページ/キャンペーンの公開リンク。 |
v1.GivingApi.PaymentAccountRead
トランザクションに関連付けられた支払いアカウント。例: BBMS、Stripe、Paypal など。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
支払いアカウントを一意に識別するためにシステムで生成された ID。 |
|
名称
|
name | string |
支払いアカウントの名前。 |
|
ゲートウェイ
|
type | string |
支払いゲートウェイの名前。 |
v1.GivingApi.RecordRead
Almabase でマップされたレコード
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
名
|
first_name | string |
マップされたレコードの最初の名 |
|
完全な名前
|
formatted_name | string |
マップされたレコードのフル ネーム |
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
Almabase に登録済みの寄付者ですか?
|
is_registered | boolean |
マップ済みのレコードや寄付者が Almabase に登録されているかどうかを示します |
|
姓
|
last_name | string |
マップ済みレコードの姓 |
|
画像の URL
|
present_picture | uri |
レコードの写真の URL |
|
リンク
|
profile_url | uri |
Almabase のレコード リンク |
v1.GivingApi.TransactionRead
ギフトに関連するオンライン支払いトランザクション。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
支払いアカウント
|
account | v1.GivingApi.PaymentAccountRead |
トランザクションに関連付けられた支払いアカウント。例: BBMS、Stripe、Paypal など。 |
|
作成時間
|
created_at | date-time |
このトランザクションの作成時間。 |
|
失敗の理由
|
failure_reason | string |
支払いゲートウェイから返されたトランザクション失敗の理由。 |
|
ID
|
id | uuid |
トランザクションを一意に識別するためにシステムで生成された ID。 |
|
状態
|
status | integer |
トランザクションの状態。 - 1 (未処理) - 2 (成功) - 3 (失敗) - 4 (保留中) - 5 (エラー) 注: これらの状態は、支払いゲートウェイによるトランザクションの状態に関連付けられています |
|
支払いゲートウェイの参照 ID
|
transaction_id | string |
トランザクションを識別するために支払いゲートウェイによって生成される一意の ID。 例: Blackbaud Merchant Services (BBMS)、トランザクション ID、または Stripe の請求 ID、Paypal トランザクション ID |
v1.AlmasightsApi.RecordAddOrEdit
Almabase のレコード。
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
v1.AlmasightsApi.TouchpointCustomObjectAdd
新しいタッチ ポイントを作成するタッチポイント本文
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Email
|
活動に使用するメールの ID。 |
||
|
記録
|
mapped_profile | v1.AlmasightsApi.RecordAddOrEdit |
Almabase のレコード。 |
|
記録日
|
recorded_at | date-time |
活動のタイムスタンプ。 |
|
タイプ
|
touchpoint_type.id | integer |
v1.RecordApi.LocationRead
住所の場所
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
City
|
city | string |
場所の市区町村名 |
|
国
|
country | string |
場所の国名 |
|
緯度
|
latitude | double |
その場所の緯度 |
|
経度
|
longitude | double |
その場所の経度 |
|
状態
|
state | string |
場所の都道府県の名前 |
v1.RecordApi.AddressRead
住所
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Line1
|
line1 | string |
住所の 1 行目 |
|
Line2
|
line2 | string |
住所の 2 行目 |
|
スキーマ
|
location.schema | v1.RecordApi.LocationRead |
住所の場所 |
|
ZipCode
|
zipcode | string |
住所の郵便番号 |
v1.RecordApi.EmailWebhookRecordRead
記録
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
名
|
first_name | string |
マップされたレコードの最初の名 |
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
レコードが Almabase に登録済みか
|
is_registered | boolean |
マップ済みのレコードが Almabase に登録されているかどうかを示します |
|
姓
|
last_name | string |
マップ済みレコードの姓 |
v1.RecordApi.EmailWebhookResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール アドレス
|
data.address |
メール アドレス。 |
|
|
ID
|
data.id | integer |
電子メールを一意に識別するためにシステムで生成された ID です。 |
|
プライマリである
|
data.is_primary | boolean |
電子メールがプライマリかどうかを示します。 |
|
スキーマ
|
data.profile.schema | v1.RecordApi.EmailWebhookRecordRead |
記録 |
|
電子メールの種類
|
data.type | string |
メール アドレスの種類です (プライマリ、個人用、仕事用など)。 |
|
次の場所でイベントをトリガー
|
time | string |
イベントの時間。 |
|
イベント タイプ
|
type | string |
イベントの種類。 |
v1.RecordApi.RecordWebhookResponse
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
提携
|
data.affiliations | array of string | |
|
クラスの年
|
data.class_year | string |
レコードのクラスの年 |
|
メール アドレス
|
data.email |
メール アドレス。 |
|
|
外部データベース ID
|
data.external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
名
|
data.first_name | string |
マップされたレコードの最初の名 |
|
スキーマ
|
data.home_address.schema | v1.RecordApi.AddressRead |
住所 |
|
ID
|
data.id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
姓
|
data.last_name | string |
マップ済みレコードの姓 |
|
メンバーシップの有効期限
|
data.membership_expiry_date | date-time |
レコードのメンバーシップの有効期限 |
|
メンバーシップの種類の名前
|
data.membership_type_name | string |
レコードのメンバーシップの種類の名前 |
|
携帯電話番号
|
data.mobile_number | string |
レコードのモバイル番号 |
|
スキーマ
|
data.office_address.schema | v1.RecordApi.AddressRead |
住所 |
|
職場の電話番号
|
data.office_phone_number | string |
レコードの職場の電話番号 |
|
住居電話番号
|
data.residence_phone_number | string |
レコードの住居電話番号 |
|
次の場所でイベントをトリガー
|
time | string |
イベントの時間。 |
|
イベント タイプ
|
type | string |
イベントの種類。 |
v1.RecordApi.EmailAddressRead
メール アドレス
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
住所
|
address |
メール アドレス |
|
|
ID
|
id | integer |
レコードのメール アドレスを一意に識別するためにシステムで生成された ID。 |
|
関与されたか
|
is_engaged | boolean |
電子メール広告がクリックまたは開かれたかどうか、またはユーザーが 1 対 1 のメールに返信したかどうかを示します |
|
ログインに使用するか
|
is_login_email | boolean |
このメール アドレスを使用したプラットフォームへのログインを、ユーザーに許可するかどうかを示します。 |
|
一対多
|
is_primary | boolean |
プライマリ メールは、システムによってトリガーされた自動メールを送信するために使用されます。 また、レコードに一括メールを送信するためにも使用されます。 プライマリとして設定するメールは 1 つだけである必要があります。 |
|
ユーザーによって確認されたか
|
is_verified | boolean |
ユーザーがメールを所有していることを確認したかどうかを示します。 |
|
source
|
source | string |
ソースは、メールがデータベースに追加される方法を示します。 |
|
ステータス
|
status | string | |
|
タイプ
|
type | string |
メールの種類 |
v1.RecordApi.RecordRead
レコード
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール アドレス
|
email_addresses | array of v1.RecordApi.EmailAddressRead |
プロファイルのメール アドレス一覧 |
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
名
|
first_name | string |
レコードの名。 |
|
完全な名前
|
formatted_name | string |
レコードのフル ネーム。 |
|
ID
|
id | integer |
レコードを一意に識別するためにシステムで生成された ID。 |
|
Almabase に登録済みか
|
is_registered | boolean |
レコードや寄付者が Almabase に登録されているかどうかを示します |
|
姓
|
last_name | string |
レコードの姓。 |
|
画像の URL
|
present_picture | uri |
レコードの写真の URL |
|
リンク
|
record_url | uri |
Almabase のレコード リンク |
v1.EventApi.ContactPersonRead
イベントの連絡担当者
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
メール
|
連絡担当者の電子メール |
||
|
ID
|
id | integer |
連絡担当者を一意に識別するためにシステムで生成された ID です。 |
|
件名
|
name | string |
連絡担当者の名前 |
|
電話番号
|
phone_number | string |
連絡担当者の電話番号 |
v1.EventApi.EventRead
イベント
| 名前 | パス | 型 | 説明 |
|---|---|---|---|
|
Description
|
description | string |
イベントの説明 |
|
終了日時
|
end_datetime | string |
イベントの終了時刻 |
|
外部データベース ID
|
external_database_id | string |
システムは、外部データベースによってレコードに一意の ID を割り当てました。 例: Raiser Edge NXT のシステムレコード ID、Salesforce の連絡先 ID |
|
外部登録 URL
|
external_registration_url | string |
外部 Web サイトでのイベントの登録 URL です |
|
ID
|
id | integer |
イベントを一意に識別するためにシステムで生成された ID です。 |
|
件名
|
name | string |
イベントの名前 |
|
開始日時
|
start_datetime | string |
イベントの開始時刻 |
|
タイム ゾーン
|
timezone | string |
イベントのタイム ゾーン |