SharePoint

SharePoint コネクタは、SharePoint サービスとサーバーへの SQL アクセスを提供します。

サポート対象のバージョン

このコネクタは、Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以降、SharePoint Online をサポートしています。

始める前に

SharePoint コネクタを使用する前に、次の作業を行います。

Google Cloud プロジェクトで次の操作を行います。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービスアカウントに、次の IAM ロールを付与します。
  - roles/secretmanager.viewer
  - roles/secretmanager.secretAccessor
  サービスアカウントは特別なタイプの Google アカウントで、Google API のデータにアクセスするのに認証を受ける必要がある人間以外のユーザーを表します。サービスアカウントがない場合は、サービスアカウントを作成する必要があります。詳細については、サービスアカウントを作成するをご覧ください。
- 次のサービスを有効にします。
  - secretmanager.googleapis.com（Secret Manager API）
  - connectors.googleapis.com（Connectors API）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

Azure（AD）で SharePoint アプリを構成する

SharePoint のオンラインエディションに Azure Active Directory（AD）を使用する場合は、次の手順に従って Azure AD で SharePoint アプリを構成します。

Azure AD ポータルで、組織のディレクトリを選択します。
[管理] セクションで [アプリの登録] をクリックし、[新規登録] をクリックします。
登録の詳細を入力して、Azure AD にアプリを登録します。
1. [サポートされているアカウントの種類] で、[この組織ディレクトリ内のアカウントのみ] を選択します。
2. [リダイレクト URI（省略可）] で [ウェブ] を選択し、接続ユーザーが認証レスポンスを受信するための URI として https://your_connections_host.spo.index.html を追加します。
3. [Register] をクリックします。
アプリの [概要] ページで [API 権限] をクリックし、[権限を追加] をクリックします。
次の手順に沿って、ウェブ API にアクセスするようにアプリケーションを構成します。
1. [API 権限をリクエスト] で、[Microsoft API] タブから [SharePoint] を選択します。
2. [委任された権限] で [ユーザーファイルの読み取りと書き込み] と [すべてのサイトコレクションのアイテムの読み取りと書き込み] を選択します。
3. [権限を追加] をクリックします。
4. 構成された API 権限画面で、[your_organizational_directory の管理者の同意を得る] を選択します。
組織の SharePoint モバイルアプリのリダイレクト URI を追加します。
1. [認証] をクリックします。
2. [ウェブ] で [URI を追加] をクリックし、モバイルユーザーの返信 URL として https://your_connections_host/spo/mobile.html を追加します。
3. [暗黙的付与] で、[アクセストークン] と [ID トークン] の両方を選択します。
4. [保存] をクリックします。
Azure Active Directory アプリマニフェストを編集して、アプリで使用するオープン認証を許可します。
1. アプリの [概要] ページで [マニフェスト] セクションをクリックします。
2. 属性 oauth2AllowImplicitFlow を true に変更します。
3. [保存] をクリックします。
アプリの [概要] ページでアプリケーション（クライアント）ID をメモします。Azure AD 認証タイプを選択した場合は、SharePoint コネクタを構成する際に認証セクションでこれを指定する必要があります。

コネクタを構成する

コネクタを構成するには、データソース（バックエンドシステム）への接続を作成する必要があります。接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  コネクタをサポートしているリージョンは次のとおりです。
  サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
2. [次へ] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [SharePoint] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 63 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
6. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
7. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
8. [次へ] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. 宛先の種類: 宛先の種類を選択します。たとえば、ホストアドレスは https://xxxxx.sharepoint.com です。
  1. [Host address] フィールドに、宛先のホスト名または IP アドレスを指定します。
    1. バックエンドシステムへのプライベート接続を確立する場合は、次のようにします。
      1. PSC サービスアタッチメントを作成します。
      2. エンドポイントアタッチメント作成してから、ホストアドレスフィールドにあるエンドポイントアタッチメントの詳細を入力します。
    2. セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的送信 IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  他の宛先を入力するには、[+Add destination] をクリックします。
2. [次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. 次のいずれかの認証タイプを選択して、対応する詳細を入力します。
  - Windows 認証情報: SharePoint のオンプレミスエディションを使用している場合は、これを選択します。次に、以下の操作を行います。
    1. ユーザー名: ユーザー名を入力します。
    2. パスワード: パスワードを選択します。
    3. シークレットバージョン: シークレットバージョンを入力します。
  - AzureAD: Sharepoint のオンラインエディションを使用している場合は、これを選択します。次に、以下の操作を行います。
    1. クライアント ID: アクセストークンのリクエストに使用するクライアント ID を入力します。クライアント ID を取得するには、Azure AD で SharePoint アプリを構成します。
    2. スコープ: 目的のスコープのカンマ区切りリストを入力します。例: Sites.FullControl.All
    3. クライアントシークレット: 作成した接続されているアプリのクライアントシークレットを含むシークレットを入力します。
    4. シークレットバージョン: 上で選択したシークレットのシークレットバージョン。
    5. 承認 URL: クライアントの作成時に生成された承認 URL。https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize の形式で URL を入力します。例: https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

使用する認証に基づいて詳細を入力します。

Windows 認証情報
- ユーザー名: ユーザー名を入力します。
- パスワード: ユーザーのパスワードを含む Secret Manager シークレットを選択します。
- Secret のバージョン: Secret Manager のシークレットのバージョンを選択します。
AzureAD（OAuth 2.0 - 認証コード）

クライアント ID: 外部アプリケーションによって提供されるクライアント ID。
スコープ: 権限スコープをカンマ区切りで入力します。
クライアントシークレット: Secret Manager のシークレットを選択します。この認証を構成する前に、Secret Manager のシークレットを作成しておく必要があります。
シークレットのバージョン: クライアントシークレットの Secret Manager シークレットのバージョン。

Authorization code 認証タイプの場合は、接続を作成した後、認証を構成するためにいくつかの追加手順を行う必要があります。詳しくは、接続作成後の追加手順をご覧ください。

注: Authorization code 認証タイプを使用していて、Sharepoint アプリケーションで構成を変更した場合は、Sharepoint 接続を再認認可する必要があります。再認可する方法については、認証コードの再認可をご覧ください。

接続作成後の追加手順

認証に OAuth 2.0 - Authorization code を選択した場合は、接続の作成後に次の追加の手順を行う必要があります。

接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
[承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
[リダイレクト URI] の値を外部アプリケーションにコピーします。
認可の詳細を確認します。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

認証コードの再認可

Authorization code 認証タイプを使用しているユーザーが、SharePoint アプリケーションの構成を変更した場合は、Sharepoint 接続を再認可する必要があります。接続を再認可するには、次の手順を行います。

[接続] ページで必要な接続をクリックします。
これにより、[接続の詳細] ページが開きます。
[編集] をクリックして、接続の詳細を編集します。
[認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。
必要に応じて必要な変更を加えます。
[Save] をクリックします。接続の詳細ページに移動します。
[認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
[Authorize（承認）] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

エンティティ、オペレーション、アクション

すべての Integration Connectors が、接続されたアプリケーションのオブジェクトを抽象化するレイヤを提供します。アプリケーションのオブジェクトには、この抽象化を通じてのみアクセスできます。抽象化は、エンティティ、オペレーション、アクションとして公開されます。

エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベースコネクタでは、テーブルがエンティティであり、ファイルサーバーコネクタでは、フォルダがエンティティです。また、メッセージングシステムコネクタでは、キューがエンティティです。
ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。
オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。
- リスト
- 取得
- 作成
- 更新
- 削除
使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティオペレーションをご覧ください。ただし、コネクタがどのエンティティオペレーションもサポートしていない場合、サポートされていないオペレーションは Operations リストに表示されません。
アクション: コネクタインターフェースを介して統合で使用できる最初のクラス関数です。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

アクション

このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。

注: すべてのアクションの結果は、統合を実行した後に Connectors タスクの connectorOutputPayload レスポンスパラメータで JSON レスポンスとして利用できます。

DeleteAttachment アクション

このアクションにより、添付ファイルが削除されます。

DeleteAttachment アクションの入力パラメータ

パラメータ名	データ型	必須	説明
ListTitle	文字列	○	リスト項目のタイトル。
ItemId	文字列	○	リスト項目の ID。
FileName	文字列	○	ドキュメントライブラリから削除するファイルの名前。

DeleteAttachment アクションの構成方法については、アクションの例をご覧ください。

CheckInDocument アクション

このアクションにより、ドキュメントをチェックインできます。

CheckInDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RelativeURL	文字列	○	フォルダの相対 URL。
DocumentName	文字列	○	チェックインするファイルの名前。
コメント	文字列	いいえ	オプションのチェックインメッセージ。

CheckInDocument アクションの構成方法については、アクションの例をご覧ください。

ChekOutDocument アクション

このアクションにより、ファイルをチェックアウトできます。

ChekOutDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RelativeURL	文字列	○	フォルダの相対 URL。
DocumentName	文字列	○	チェックアウトするファイルの名前。

ChekOutDocument アクションの構成方法については、アクションの例をご覧ください。

RevokeCheckOutDocument アクション

このアクションにより、ファイルのチェックアウトを元に戻すことができます。

RevokeCheckOutDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RelativeURL	文字列	○	フォルダの相対 URL。
DocumentName	文字列	○	チェックアウトを元に戻す必要があるファイルの名前。

DiscardCheckOutDocument アクションの構成方法については、アクションの例をご覧ください。

CopyDocument アクション

このアクションにより、ファイルをある場所から別の場所にコピーできます。

CopyDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
SourceFileRelativeUrl	文字列	○	ソースファイルの相対 URL。
DestFileRelativeUrl	文字列	○	宛先ファイルの相対 URL。

CopyDocument アクションの構成方法については、アクションの例をご覧ください。

UploadDocument アクション

このアクションにより、ファイルをアップロードできます。

UploadDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
FileName	文字列	○	アップロードするファイルの名前。
RelativeUrl	文字列	○	フォルダの相対 URL。
コンテンツ	文字列	いいえ	ファイルとしてアップロードするコンテンツ。
ContentBytes	文字列	いいえ	ファイルとしてアップロードするバイトコンテンツ（Base64 文字列として）。これを使用してバイナリデータをアップロードします。
HasBytes	ブール値	いいえ	アップロードするコンテンツがバイナリかどうかを指定します。デフォルト値は `false` です。

UploadDocument アクションの構成方法については、アクションの例をご覧ください。

DownloadDocument アクション

このアクションにより、ファイルをダウンロードできます。

DownloadDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RemoteFile	文字列	○	ダウンロードするファイルの完全な URL。
ライブラリ	文字列	○	SharePoint サーバーのライブラリの名前。
HasBytes	ブール値	いいえ	コンテンツをバイトとしてダウンロードするかどうかを指定します。デフォルト値は `false` です。

DownloadDocument アクションの構成方法については、アクションの例をご覧ください。

MoveAttachmentOrDocument アクション

このアクションにより、ファイルをフォルダ間で移動できます。

MoveAttachmentOrDocument アクションの入力パラメータ

パラメータ名	データ型	必須	説明
SourceFileURL	文字列	○	移動する必要があるソースファイルの URL。
DestinationFolderURL	文字列	○	宛先フォルダの URL。

MoveAttachmentOrDocument アクションの構成方法については、アクションの例をご覧ください。

CreateFolder アクション

このアクションにより、フォルダを作成できます。

CreateFolder アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RelativeURL	文字列	○	フォルダの相対 URL。
FolderName	文字列	○	作成するフォルダの名前。

CreateFolder アクションの構成方法については、アクションの例をご覧ください。

AddAttachments アクション

このアクションにより、添付ファイルを追加できます。

AddAttachments アクションの入力パラメータ

パラメータ名	データ型	必須	説明
ListTitle	文字列	○	添付ファイルリストの名前。
FileName	文字列	○	添付ファイルの名前。
ItemId	文字列	○	追加する添付ファイルの ID。
コンテンツ	文字列	○	添付ファイルのコンテンツ。
ContentBytes	文字列	いいえ	添付ファイルとしてアップロードするバイトコンテンツ（Base64 文字列として）。これを使用してバイナリデータをアップロードします。
HasBytes	ブール値	いいえ	アップロードするコンテンツがバイナリかどうかを指定します。デフォルト値は `false` です。

AddAttachments アクションの構成方法については、アクションの例をご覧ください。

DownloadAttachments アクション

このアクションにより、添付ファイルをダウンロードできます。

DownloadAttachments アクションの入力パラメータ

パラメータ名	データ型	必須	説明
RemoteFile	文字列	○	ファイルの相対 URL。
HasBytes	ブール値	いいえ	ダウンロードするコンテンツがバイナリかどうかを指定します。デフォルト値は `false` です。

DownloadAttachments アクションの構成方法については、アクションの例をご覧ください。

アクションの例

このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。

例 - 添付ファイルを削除する

この例では、指定したファイルを削除します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DeleteAttachment] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"ListTitle": "My lists",
"ItemId": "1",
"FileName": "sitepages.txt"
}
```

アクションが成功すると、DeleteAttachment タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - ドキュメントをチェックインする

この例では、ドキュメントをチェックインします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CheckInDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt",
"Comment": "Comment test"
}
```

アクションが成功すると、CheckInDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - ファイルをチェックアウトする

この例では、ファイルをチェックアウトします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[ChekOutDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}
```

アクションが成功すると、ChekOutDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - チェックアウトを破棄する

この例では、ファイルのチェックアウトを元に戻します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DiscardCheckOutDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.docx"
}
```

アクションが成功すると、DiscardCheckOutDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - ファイルをコピーする

この例では、ある場所から別の場所にファイルをコピーします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CopyDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"SourceFileRelativeUrl": "/Shared Documents/Document.docx",
"DestFileRelativeUrl": "/Shared Documents/TestFolder/Document123.docx"
}
```

アクションが成功すると、CopyDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - テキストファイルをアップロードする

この例では、指定した場所にテキストファイルをアップロードします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UploadDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"Content": "abcd"
}
```

アクションが成功すると、UploadDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - バイナリファイルをアップロードする

この例では、指定した場所にバイナリファイルをアップロードします。バイナリファイルをアップロードするときは、アップロードするコンテンツを Base64 エンコード文字列として指定します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[UploadDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"FileName": "test.txt",
"RelativeUrl": "/Shared Documents/TestFolder",
"ContentBytes": "SGVsbG8gd29ybGQK",
"HasBytes": "true"
}
```

アクションが成功すると、UploadDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Status": "Success"
}]

例 - ファイルをダウンロードする

この例ではファイルをダウンロードします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RemoteFile": "/TestFolder/test.txt",
"Library": "Shared Documents"
}
```

アクションが成功すると、DownloadDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Success": "True",
"Content": "Test File",
}]

例 - バイナリファイルをダウンロードする

この例では、バイナリファイルをダウンロードします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RemoteFile": "/TestFolder/test1.png",
"Library": "Shared Documents"
"HasBytes": "true"
}
```

アクションが成功すると、DownloadDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

例 - 添付ファイルを移動する

この例では、添付ファイルをある場所から別の場所に移動します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[MoveAttachmentOrDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"SourceFileURL": "/Shared Documents/test.txt",
"DestinationFolderURL": "/Shared Documents/TestFolder"
}
```

アクションが成功すると、MoveAttachmentOrDocument タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Result": "Success"
}]

例 - フォルダを作成する

この例では、指定した場所にフォルダを作成します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[CreateFolder] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"FolderName": "TestFolder123"
}
```

アクションが成功すると、CreateFolder タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Id": "110842b7-2393-4f11-9391-3d75214e9fb8",
"Status": "Success"
}]

例 - 添付ファイルを追加する

この例では、指定したリストに添付ファイルを追加します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[AddAttachments] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"ListTitle": "My Lists",
"FileName": "TestAttachment2",
"Content": "abcd text",
"ItemId": "1"
}
```

アクションが成功すると、AddAttachments タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment2",
"Status": "Success"
}]

例 - バイナリの添付ファイルを追加する

この例では、指定したリストにバイナリの添付ファイルを追加します。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[AddAttachments] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"ListTitle": "My Lists",
"FileName": "TestAttachment3",
"ContentBytes": "VGVzdCBGaWxl",
"HasBytes": "true",
"ItemId": "1"
}
```

アクションが成功すると、AddAttachments タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"RelativeUrl": "/Lists/My lists/Attachments/1/TestAttachment3",
"Status": "Success"
}]

例 - 添付ファイルをダウンロードする

この例では、添付ファイルをダウンロードします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadAttachments] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RemoteFile": "/Shared Documents/Document.txt"
}
```

アクションが成功すると、DownloadAttachments タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Success": "True",
"Content": "Test File",
}]

例 - バイナリ添付ファイルをダウンロードする

この例では、バイナリ添付ファイルをダウンロードします。

[Configure connector task] ダイアログで、[Actions] をクリックします。
[DownloadAttachments] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RemoteFile": "/Shared Documents/Document.docx",
"HasBytes": "true"
}
```

アクションが成功すると、DownloadAttachments タスクの connectorOutputPayload レスポンスパラメータの値は次のようになります。

[{
"Success": "True",
"ContentBytes": "VGVzdCBGaWxl",
}]

エンティティオペレーションの例

このセクションでは、このコネクタでエンティティオペレーションの一部を実行する方法について説明します。

例 - すべてのファイルを一覧表示する

この例では、Files エンティティ内のすべてのファイルを一覧表示します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から Files を選択します。
[List] オペレーションを選択してから、[完了] をクリックします。
必要に応じて、コネクタタスクの [タスク入力] セクションでフィルタ句を指定して、結果セットをフィルタリングできます。また、論理演算子を使用して複数のフィルタ条件を指定することもできます。

例 - リストを取得する

この例では、My Lists エンティティから、指定した ID のリストを取得します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から My Lists を選択します。
[Get] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 3 を入力します。
ここで、3 は My Lists エンティティの主キー値です。

例 - レコードを作成する

この例では、My Lists エンティティにレコードを作成します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から My Lists を選択します。
[Create] オペレーションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"AuthorId": 11.0,
"BaseName": "3_",
"Attachments": false,
"Title": "Created List New"
}
```
統合に成功すると、コネクタタスクの connectorOutputPayload フィールドの値は次のようになります。
```
[{
"ID": 3.0
}]
```

例 - レコードを削除する

この例では、My Lists エンティティ内の指定された ID のレコードを削除します。

[Configure connector task] ダイアログで、[Entities] をクリックします。
Entity から My Lists を選択します。
[Delete] オペレーションを選択してから、[完了] をクリックします。
[コネクタタスクの [タスク入力 セクションで [entityId] をクリックし、[デフォルト値] フィールドに 2 を入力します。

統合で SharePoint 接続を使用する

接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。

Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。

Google Cloud コミュニティの助けを借りる

Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。

SharePoint

サポート対象のバージョン

始める前に

Azure（AD）で SharePoint アプリを構成する

コネクタを構成する

認証を構成する

接続作成後の追加手順

認証コードの再認可

エンティティ、オペレーション、アクション

アクション

DeleteAttachment アクション

DeleteAttachment アクションの入力パラメータ

CheckInDocument アクション

CheckInDocument アクションの入力パラメータ

ChekOutDocument アクション

ChekOutDocument アクションの入力パラメータ

RevokeCheckOutDocument アクション

RevokeCheckOutDocument アクションの入力パラメータ

CopyDocument アクション

CopyDocument アクションの入力パラメータ

UploadDocument アクション

UploadDocument アクションの入力パラメータ

DownloadDocument アクション

DownloadDocument アクションの入力パラメータ

MoveAttachmentOrDocument アクション

MoveAttachmentOrDocument アクションの入力パラメータ

CreateFolder アクション

CreateFolder アクションの入力パラメータ

AddAttachments アクション

AddAttachments アクションの入力パラメータ

DownloadAttachments アクション

DownloadAttachments アクションの入力パラメータ

アクションの例

例 - 添付ファイルを削除する

例 - ドキュメントをチェックインする

例 - ファイルをチェックアウトする

例 - チェックアウトを破棄する

例 - ファイルをコピーする

例 - テキスト ファイルをアップロードする

例 - バイナリ ファイルをアップロードする

例 - ファイルをダウンロードする

例 - バイナリ ファイルをダウンロードする

例 - 添付ファイルを移動する

例 - フォルダを作成する

例 - 添付ファイルを追加する

例 - バイナリの添付ファイルを追加する

例 - 添付ファイルをダウンロードする

例 - バイナリ添付ファイルをダウンロードする

エンティティ オペレーションの例

例 - すべてのファイルを一覧表示する

例 - リストを取得する

例 - レコードを作成する

例 - レコードを削除する

統合で SharePoint 接続を使用する

Google Cloud コミュニティの助けを借りる

次のステップ

例 - テキストファイルをアップロードする

例 - バイナリファイルをアップロードする

例 - バイナリファイルをダウンロードする

エンティティオペレーションの例