收件人資料共用功能

此處列出的程序涵蓋資料共用的收件人所需的所有功能。

建立收件者程序

此功能會建立「資料共用收件人」。

語法

Share.create_recipient(name, email, description, owner, shares,
    token_lifetime)
以下是參數和描述：
  • name ：「收件者」的名稱。您必須在此欄位中輸入值。
  • 電子郵件：此欄位顯示「收件者」的電子郵件地址。
  • 說明：此欄位顯示「收件者」的說明。如果缺少此欄位，則工具會使用空白字串。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。
  • 共用：您可以在收件者共用字典中檢視下列欄位："[{"name","shareNameValue"},...]"。如果缺少參數，則工具會使用空白字典 "[]"。
  • token_lifetime ：此工具使用收件者記號存留時間的格式為 'D HH:MM:SS'。如果缺少此欄位，工具會使用 '0 00:60:00'。

範例
在此範例中，您可以建立「資料共用收件者」：
adp.Share.create_recipient(
    name  = 'test_py_api_recipient_1',
    email = 'test@gmail.com'
)

//Output:
'{"createRecipient":true,"name":"TEST_PY_API_RECIPIENT_1"}'

更新收件人共用程序

此功能會更新 「資料共用收件人」。

語法

Share.update_recipient_shares(name, shares, owner)
以下是參數和描述：
  • name ：收件者名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。
  • 共用：您可以在收件者共用字典中檢視下列欄位："[{"name","shareNameValue"},...]"。如果缺少參數，則工具會使用空白字典 "[]"。

範例
在此範例中，您可以更新「資料共用收件者」：
recipient_name = 'test_py_api_recipient_1'
shares = json.dumps([{"name":'share_py_api_7'}])
adp.Share.update_recipient_shares(name = recipient_name, shares = shares)

//Output:
'{"status" : true}'

刪除收件者程序

此功能會刪除資料共用收件人。

語法

Share.delete_recipient(name, owner)
以下是參數和描述：
  • name ：收件者名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以刪除「資料共用收件者」：
adp.Share.delete_recipient (name  = 'renamed_test_py_api_recipient_2')

//Output:
'{ "status": true }'

重新命名收件者程序

此函數會重新命名「資料共用收件者」。

語法

Share.rename_recipient(name, new_name, owner)
以下是參數和描述：
  • 名稱：「收件者」的名稱。您必須在此欄位中輸入值。
  • new_name ：您要的「收件者」名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以重新命名「資料共用收件者」：
adp.Share.rename_recipient(name = 'test_py_api_recipient_1', new_name = 'test_py_api_recipient_2')
//Output:
'{ "status": true }'

取得收件者程序

此功能會接收「資料共用收件人」的明細。

語法

Share.get_recipient(name, owner)
以下是參數和描述：
  • name ：收件者名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以接收「資料共用收件者」的詳細資訊：
s = adp.Share.get_recipient('test_py_api_recipient_2')
json.loads(s)

//Output:
{'name': 'TEST_PY_API_RECIPIENT_2',
 'id': 40436,
 'type': 'DELTA_SHARING',
 'description': None,
 'email': 'test@gmail.com',
 'clientId': 'xxxxxxxxxxxx..',
 'clientSecret': 'xxxxxxxxxxxxxx..',
 'tokenDuration': None,
 'shares': [{'name': 'SHARE_PY_API_7',
   'id': 40419,
   'description': 'desc_share_py_api_7',
   'tablesCount': 2}],
 'created': '2024-11-12T15:34:08',
 'updated': '2024-11-12T15:36:13'}

取得收件者程序

此功能會根據資料結構收件人擁有者接收資料共用收件人清單。

語法

Share.get_recipients(owner)
以下是參數和描述：
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以接收「資料共用收件者」清單：
s = adp.Share.get_recipients()
json.loads(s)
//Output:
[{'id': 40436,
  'name': 'TEST_PY_API_RECIPIENT_2',
  'type': 'DELTA_SHARING',
  'description': None,
  'email': 'test@gmail.com'}]

取得收件人共用設定檔程序

此功能會接收 「收件人」的 「資料共用」設定檔。

語法

Share.get_recipient_sharing_profile(name, owner)
以下是參數和描述：
  • name ：收件者名稱。您必須在此欄位中輸入值。
  • 擁有者：此欄位顯示「收件者」擁有者。如果沒有這個欄位，工具會使用目前的綱要擁有者。

範例
在此範例中，您可以接收「資料共用接收者」的「資料共用」設定檔：
s = adp.Share.get_recipient_sharing_profile('test_py_api_recipient_2')
json.loads(s)

//Output:
{'shareCredentialsVersion': 2,
 'type': 'persistent_oauth2.0',
 'endpoint': 'https://abc-xyz//xx/delta_sharing',
 'tokenEndpoint': 'https://abcdefg.xx.com/adp/admin/oauth/token',
 'clientId': 'abcdefghijklmnopg..',
 'clientSecret': 'abcdefrtyuioohh..'}

父項主題：資料共用函數