このページは Cloud Translation API によって翻訳されました。

SharePoint

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

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

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

始める前に

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

Google Cloud プロジェクトで次の操作を行います。
- ネットワーク接続が設定されていることを確認します。ネットワークパターンの詳細については、Network Connectivity をご覧ください。
- コネクタを構成するユーザーに 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）
  サービスを有効にする方法については、サービスを有効にするをご覧ください。
以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

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

Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
[接続] ページに移動
[+ 新規作成] をクリックして [接続の作成] ページを開きます。
[ロケーション] セクションで、接続のロケーションを選択します。
1. リージョン: プルダウンリストからロケーションを選択します
  コネクタをサポートしているリージョンは次のとおりです。
  サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。
2. [次へ] をクリックします。
[接続の詳細] セクションで、次の操作を行います。
1. コネクタ: 使用可能なコネクタのプルダウンリストから [SharePoint] を選択します。
2. コネクタのバージョン: 使用可能なバージョンのプルダウンリストからコネクタのバージョンを選択します。
3. [接続名] フィールドに、接続インスタンスの名前を入力します。
  接続名は次の条件を満たす必要があります。
  - 接続名には英字、数字、ハイフンを使用できます。
  - 文字は小文字のみを使用できます。
  - 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
  - 接続名は 49 文字以内で指定してください。
4. 必要に応じて、接続インスタンスの [説明] を入力します。
5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
6. サービスアカウント: 必要なロールを持つサービスアカウントを選択します。
7. 必要に応じて、接続ノードの設定を構成します。
  - ノードの最小数: 接続ノードの最小数を入力します。
  - ノードの最大数: 接続ノードの最大数を入力します。
  ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。
8. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
9. [次へ] をクリックします。
[宛先] セクションに、接続するリモートホスト（バックエンドシステム）の詳細を入力します。
1. 宛先の種類: 宛先の種類を選択します。たとえば、ホストアドレスは https://xxxxx.sharepoint.com です。
  - リストから [ホストアドレス] を選択し、宛先のホスト名または IP アドレスを指定します。
  - バックエンドシステムへのプライベート接続を確立する場合は、リストからエンドポイントアタッチメントを選択し、次にエンドポイントアタッチメントリストから必要なエンドポイントアタッチメントを選択します。
    注: エンドポイントアタッチメントの作成方法については、PSC サービスアタッチメントとエンドポイントアタッチメントをご覧ください。エンドポイントアタッチメントを作成すると、[エンドポイントアタッチメント] リストに表示されます。
  セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォールルールを構成します。
  
  他の宛先を入力するには、[+ 宛先を追加] をクリックします。
2. [次へ] をクリックします。
[認証] セクションで、認証の詳細を入力します。
1. [認証タイプ] を選択し、関連する詳細を入力します。
  SharePoint 接続でサポートされる認証タイプは次のとおりです。
  - Windows 認証情報。SharePoint のオンプレミスエディションを使用する場合は、このオプションを選択します。
  - AzureAD。SharePoint のオンラインエディションを使用する場合は、このオプションを選択します。
  - JWT Bearer を使用した OAuth 2.0 クライアント認証情報。認証に JWT Bearer OAuth 2.0 クライアント認証情報を使用する場合は、このオプションを選択します。
  - クライアントシークレットを使用する OAuth 2.0 クライアント認証情報。認証にクライアントシークレットを使用する OAuth 2.0 クライアント認証情報を使用する場合は、このオプションを選択します。
2. [次へ] をクリックします。
Review: 接続と認証の詳細を確認します。
[作成] をクリックします。

認証を構成する

SharePoint コネクタは、次の認証タイプをサポートしています。

Windows 認証情報。この認証タイプの構成方法については、Windows 認証情報の認証タイプをご覧ください。
Azure AD。この認証タイプの構成方法については、Azure AD 認証タイプをご覧ください。
JWT Bearer を使用した OAuth 2.0 クライアント認証情報。この認証タイプの構成方法については、OAuth 2.0 - JWT Bearer 認証タイプを使用したクライアント認証情報をご覧ください。
OAuth 2.0 - クライアントシークレットを使用するクライアント認証情報。この認証タイプの構成方法については、クライアントシークレット認証タイプの OAuth 2.0 クライアント認証情報をご覧ください。

Windows 認証情報の認証タイプ

Windows 認証情報の認証タイプを有効にするには、次の手順を完了する必要があります。

PSC を構成し、エンドポイントアタッチメントを作成します。
Google Cloud で認証情報を指定する。

PSC を構成してエンドポイントアタッチメントを作成する

SharePoint がホストされている IP を使用してインスタンスグループを作成します。
内部パススルーネットワークロードバランサを作成し、作成したインスタンスグループをバックエンドとして使用します。TCP 内部ロードバランサでグローバルアクセスを有効にする必要があります。
Private Service Connect でロードバランサを公開します。サービスアタッチメントは、ロードバランサが公開された後に生成されます。
サービスを公開し、作成したロードバランサを指定します。
サービスアタッチメントを使用して、エンドポイントアタッチメントを作成します。
エンドポイントアタッチメントを作成したら、エンドポイントアタッチメントの IP を使用して SharePoint 接続を作成します。

エンドポイントアタッチメントの作成の詳細については、エンドポイントアタッチメントを作成するをご覧ください。

Google Cloud で Windows 認証情報の詳細を指定する

Integration Connectors で接続を作成する場合は、次の詳細を指定する必要があります。

[Authentication] セクションで、認証タイプとして [Windows credentials] を選択し、次の詳細を入力します。

ユーザー名: ユーザー名を入力します。
パスワード: パスワードを選択します。
シークレットバージョン: シークレットバージョンを入力します。

Windows 認証情報の接続タイプ

次の表に、Windows 認証情報の接続タイプのサンプル構成値を示します。

フィールド名	詳細
リージョン	us-central1
コネクタ	SharePoint
コネクタのバージョン	1
接続名	sharepoint-staging-psc
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ノードの最小数	2
ノードの最大数	50
宛先の種類	ホストアドレス
host 1	http://192.0.2.0
port 1	24
Authentication	Windows 認証情報
ユーザー名	USER_NAME
パスワード	PASSWORD
シークレットバージョン	1

Azure AD 認証の種類

Azure AD 認証タイプを有効にするには、次の手順を完了する必要があります。

アプリを登録して OAuthClientId と OAuthClientSecret を取得する

アプリを登録して、アプリの OAuthClientId と OAuthClientSecret を取得するには、次の操作を行います。

Azure Portal にログインします。
[Azure サービス] で、[アプリの登録]、[新しい登録] の順に選択します。
アプリケーション名を入力し、[Any Microsoft Entra ID tenant - Multitenant] を選択します。次の画像は、[アプリを登録する] ページを示しています。
アプリを作成したら、[Certificates & Secrets] セクションに移動し、アプリケーションのクライアントシークレットを作成して、クライアントシークレットの値を保存します。次の図は、[証明書とシークレット] ページを示しています。

[API 権限] で、必要なアプリケーション権限と委任された権限を選択します。接続を有効にするには、次の最小権限を付与する必要があります。AllSites.Manage

次の表に、アプリケーションでオペレーションを実行するために必要な権限を示します。

委任された権限	アプリの権限
`ConsentRequest.Read.All`	`AllSites.FullControl`
`ConsentRequest.ReadWrite.All`	`AllSites.Manage`
`DelegatedAdminRelationship.Read.All`	`AllSites.Read`
`DelegatedAdminRelationship.ReadWrite.All`	`AllSites.Write`
`DelegatedPermissionGrant.Read.All`	`EnterpriseResource.Read`
`DelegatedPermissionGrant.ReadWrite.All`	`EnterpriseResource.Write`
`Files.Read.All`	`MyFiles.Read`
`Files.ReadWrite.All`	`MyFiles.Write`
`Group.Create`	`Project.Read`
`Group.Read.All`	`Project.Write`
`Group.ReadWrite.All`	`ProjectWebApp.FullControl`
`Sites.FullControl.All`	`ProjectWebAppReporting.Read`
`Sites.FullControl.All`	`Sites.FullControl.All`
`Sites.Manage.All`	`Sites.Manage.All`
`Sites.Read.All`	`Sites.Read.All`
`Sites.ReadWrite.All`	`Sites.ReadWrite.All`
`Sites.Selected`	`Sites.Search.All`
`User.Export.All`	`Sites.Selected`
`User.Read`	`TaskStatus.Submit`
`User.Read.All`	`TermStore.Read.All`
`User.ReadWrite.All`	`TermStore.Read.All`
	`TermStore.ReadWrite.All`
	`TermStore.ReadWrite.All`
	`User.Read.All`
	`User.Read.All`
	`User.ReadWrite.All`
	`User.ReadWrite.All`

変更を保存します。
管理者の同意が必要な権限を使用するように選択した場合は、現在のテナントの [API 権限] ページで権限を付与できます。次の図は、API 権限ページを示しています。
スコープを追加するには、[API を公開する] セクションに移動し、AllSites.Manage, Sites.FullControl.All スコープを追加して、管理者とユーザーのどちらが制御できるかを選択します。次の図は、[API を公開する] ページを示しています。
[保存] をクリックします。

Google Cloud で認証情報を指定する

Integration Connectors で接続を作成する場合は、次の詳細を指定する必要があります。

[認証] セクションで、認証タイプとして [AzureAD] を選択し、次の詳細を入力します。

クライアント ID: アクセストークンのリクエストに使用するクライアント ID を入力します。
スコープ: 必要なスコープをカンマ区切りで入力します。例: Sites.FullControl.All
クライアントシークレット: 作成した接続されているアプリのクライアントシークレットを含む Secret を入力します。
シークレットバージョン: 上で選択したシークレットのシークレットバージョン。
承認 URL: クライアントの作成時に生成された承認 URL。URL は https://login.microsoftonline.com/<tenant_identifier>/oauth2/v2.0/authorize の形式で入力します。例: https://login.microsoftonline.com/9bxxxxxxxxx8112/oauth2/v2.0/authorize

Google Cloud で接続を承認する

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

リダイレクト URL をアプリに追加する

Azure ポータルで、[Azure サービス] > [アプリの登録] をクリックします。
アプリ名をクリックします。
[リダイレクト URI を追加] をクリックします。
[Add a platform] をクリックします。
[Web] ダイアログで、Google Cloud で接続を承認したときにコピーしたリダイレクト URI を貼り付けます。

Azure AD 接続の種類

次の表に、Azure AD 接続タイプのサンプル構成値を示します。

フィールド名	詳細
リージョン	us-central1
コネクタ	SharePoint
コネクタのバージョン	1
接続名	sharepoint-google-cloud-con
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ノードの最小数	2
ノードの最大数	50
宛先の種類	ホストアドレス
host 1	http://z8**.sharepoint.com
認証	AzureAD
クライアント ID	CLIENT_ID
スコープ	Sites.FullControl.All
クライアントシークレット	CLIENT_SECRET
シークレットバージョン	1
認証 URL	https://login.microsoftonline.com/{tenant-id}/oauth2/v2.0/authorize

OAuth 2.0 - JWT Bearer 認証タイプを使用したクライアント認証情報

OAuth 2.0 - JWT Bearer 認証タイプを使用したクライアント認証情報を有効にするには、次の手順を完了する必要があります。

JWT ベアラ認証タイプを有効にするには、証明書を作成して Azure ポータルにアップロードし、秘密鍵を取得する必要があります。

証明書を生成

パソコンに空のフォルダを作成します。
フォルダにテキストファイルを作成します。
Azure AD アプリのみによるアクセス権の付与ページから PowerShell スクリプトをコピーし、テキストファイルに貼り付けます。
テキストファイルの名前を Create-SelfSignedCertificate.ps1 に変更します。
フォルダで Windows PowerShell を実行します。
テキストファイルが含まれているディレクトリに移動します。
次のコマンドをコピーします。 .\Create-SelfSignedCertificate.ps1 -CommonName "CERTIFICATE_NAME" -StartDate 2022-09-25 -EndDate 2023-10-25
CERTIFICATE_NAME の一意の名前を入力します。StartDate を現在の日付に、EndDate を任意の日付に変更します。
変更を加えたコマンドを Windows PowerShell に貼り付けて、Enter キーを押します。
Windows PowerShell から、秘密鍵を保護するためのパスワードを入力するよう求められます。後で使用できるようにパスワードを保存してください。

Windows PowerShell によって、MyCertificate.pfx と MyCertificate.cer の 2 つのファイルが作成されます。

Azure Portal に証明書をアップロードする

Azure Portal にログインし、次の詳細を指定して新しいアプリケーションを登録します。
- 名前: アプリケーションの名前を入力します。
- サポートされているアカウントの種類: [この組織ディレクトリ内のアカウントのみ（アカウント名のみ - 単一テナント）] を選択します。
[API 権限] > [権限を追加] > [API 権限をリクエスト] > [SharePoint] に移動します。
[アプリケーションのアクセス許可] を選択し、必要な権限を追加します。
[管理者の同意を付与] を選択し、[はい] を選択します。
アプリを作成したら、[Certificates & Secrets] セクションに移動します。
[証明書をアップロード] を選択し、パソコンから CER 証明書をアップロードします。アップロードが完了したら、[追加] を選択します。
アプリにクライアントシークレットを追加しないでください。証明書ベースの認証フローと競合する可能性があります。
マニフェストに移動し、KeyCredentials を見つけて、customKeyIdentifier をサムプリントとしてコピーします。これは後で使用します。これで、アプリが登録され、証明書がリンクされました。

秘密鍵を取得する

秘密鍵を取得するには、OpenSSL を使用して PFX ファイルを PEM ファイルに変換します。

コマンドプロンプトで、PFX ファイルのあるフォルダに移動し、次のコマンドを実行します。 openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
証明書の作成プロセスで使用した PFX パスワードを入力します。
テキストエディタで PEM ファイルを開き、秘密鍵の次のセクションをコピーします。
```
-----BEGIN PRIVATE KEY----- 

-----END PRIVATE KEY----- 
```

設定を完了する

Azure ポータルで、新しく登録したアプリからクライアント ID とテナント ID をコピーします。
次の認証情報を使用して、SharePoint リストサービスプリンシパル認証でログインします。

クライアント ID
テナント ID
秘密鍵
拇印（秘密鍵のパスワード）

Google Cloud で OAuth 2.0 JWT Bearer 認証情報を指定する

Integration Connectors で接続を作成する場合は、次の詳細を指定する必要があります。

[認証] セクションで、認証タイプとして [OAuth 2.0 クライアント認証情報（JWT ベアラーを使用）] を選択し、次の詳細を入力します。

クライアント ID: アクセストークンのリクエストに使用するクライアント ID を入力します。これは、Azure Portal でアプリを登録したときに生成されたコンシューマキーです。
秘密鍵: PEM 形式の秘密鍵ファイルのコンテンツを含む Secret Manager の Secret を選択します。秘密鍵は、コネクタに提供された公開鍵/証明書と一致する必要があります。
シークレットバージョン: 上で選択したシークレットのシークレットバージョン。
秘密鍵パスワード: 秘密鍵ファイルのパスワード（言い回し）を含む Secret Manager の Secret を選択します。
シークレットバージョン: 上で選択したシークレットのシークレットバージョン。
Azure テナント: データへのアクセスに使用されている Microsoft Online テナント。

JWT Bearer 証明書の接続タイプ

次の表に、OAuth 2.0 JWT Bearer 証明書接続タイプのサンプル構成値を示します。

フィールド名	詳細
リージョン	europe-west1
コネクタ	SharePoint
コネクタのバージョン	1
接続名	sharepoint-jwt-certificate
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ノードの最小数	2
ノードの最大数	50
宛先の種類	ホストアドレス
host 1	http://z8**.sharepoint.com
port 1	****
Authentication	OAuth 2.0 - JWT Bearer を使用したクライアント認証情報
OAuth クライアント ID	CLIENT_ID
秘密鍵	キー
シークレットバージョン	1
秘密鍵のパスワード	PASSWORD
シークレットバージョン	1
Azure テナント	AZURE_TENANT_ID

OAuth 2.0 - クライアントシークレットの接続タイプ

OAuth 2.0 クライアントシークレット接続タイプを有効にするには、次の手順を完了する必要があります。

アドインを登録する

次の URL https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx を使用して、[アドオンを登録] ページに移動します。
[アプリ情報] セクションで、クライアント ID とクライアントシークレットを生成します。
[タイトル]、[アプリのドメイン]、[リダイレクト URI] の値を指定します。
[作成] をクリックします。アドオンが登録され、SharePoint アプリに作成された情報が表示されます。

アドインに権限を付与する

次の URL を使用して SharePoint サイトに移動します。https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx[権限を付与] ページにリダイレクトされます。
[アプリ ID] フィールドに、先ほど生成したクライアント ID を入力し、[参照] をクリックします。[タイトル]、[アプリのドメイン]、[リダイレクト URL] の値が入力されます。

次の権限リクエストを XML 形式で入力します。

<AppPermissionRequests AllowAppOnlyPolicy="true">
<AppPermissionRequest Scope="http://sharepoint/content/tenant" Right="FullControl"/>
</AppPermissionRequests>

[作成] をクリックします。SharePoint アプリに権限の同意ダイアログが表示されます。
[Trust It] をクリックします。

Google Cloud で OAuth 2.0 クライアント認証情報を指定する

Integration Connectors で接続を作成する場合は、次の詳細を指定する必要があります。

[認証] セクションで、認証タイプとして [OAuth 2.0 クライアント認証情報（クライアントシークレット付き）] を選択し、次の詳細を入力します。

クライアント ID: 作成したアプリに対してコネクタから提供されたクライアント ID を入力します。
クライアントシークレット: 作成した接続されているアプリのクライアントシークレットを含む Secret Manager の Secret を選択します。
シークレットのバージョン: クライアントシークレットのバージョンを選択します。

認証コードの再認可

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

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

クライアント認証情報の接続タイプ

次の表に、OAuth 2.0 クライアント認証情報の接続タイプのサンプル構成値を示します。

フィールド名	詳細
リージョン	europe-west1
コネクタ	SharePoint
コネクタのバージョン	1
接続名	sharepoint-client-credentials
サービスアカウント	SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
ノードの最小数	2
ノードの最大数	50
宛先の種類	ホストアドレス
host 1	http://z8**.sharepoint.com
port 1	****
認証	OAuth 2.0 - クライアントシークレットを使用するクライアント認証情報
クライアント ID	CLIENT_ID
クライアントシークレット	CLIENT_SECRET
シークレットバージョン	1

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

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

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

アクション

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

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

DeleteAttachment アクション

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

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

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

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

CheckInDocument アクション

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

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

パラメータ名	データ型	必須	説明
RelativeURL	文字列	○	フォルダの相対 URL。
DocumentName	文字列	○	チェックインするファイルの名前。
コメント	文字列	×	チェックインメッセージ（省略可）。

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

CheckOutDocument アクション

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

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

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

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

DiscardCheckOutDocument アクション

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

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

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

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

CopyDocument アクション

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

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

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

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

UploadDocument アクション

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

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

パラメータ名	データ型	必須	説明
FileName	文字列	○	アップロードするファイルの名前。
RelativeUrl	文字列	○	フォルダの相対 URL。
Content	文字列	×	ファイルとしてアップロードするコンテンツ。
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。
Content	文字列	○	添付ファイルのコンテンツ。
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] をクリックします。
[CheckOutDocument] アクションを選択してから、[完了] をクリックします。
[コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。
```
{
"RelativeURL": "/Shared Documents/TestFolder",
"DocumentName": "Document.txt"
}
```

アクションが成功すると、CheckOutDocument タスクの 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

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

始める前に

コネクタを構成する

認証を構成する

Windows 認証情報の認証タイプ

PSC を構成してエンドポイント アタッチメントを作成する

Google Cloud で Windows 認証情報の詳細を指定する

Windows 認証情報の接続タイプ

Azure AD 認証の種類

アプリを登録して OAuthClientId と OAuthClientSecret を取得する

Google Cloud で認証情報を指定する

Google Cloud で接続を承認する

リダイレクト URL をアプリに追加する

Azure AD 接続の種類

OAuth 2.0 - JWT Bearer 認証タイプを使用したクライアント認証情報

証明書を生成

Azure Portal に証明書をアップロードする

秘密鍵を取得する

設定を完了する

Google Cloud で OAuth 2.0 JWT Bearer 認証情報を指定する

JWT Bearer 証明書の接続タイプ

OAuth 2.0 - クライアント シークレットの接続タイプ

アドインを登録する

アドインに権限を付与する

Google Cloud で OAuth 2.0 クライアント認証情報を指定する

認証コードの再認可

クライアント認証情報の接続タイプ

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

アクション

DeleteAttachment アクション

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

CheckInDocument アクション

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

CheckOutDocument アクション

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

DiscardCheckOutDocument アクション

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

CopyDocument アクション

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

UploadDocument アクション

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

DownloadDocument アクション

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

MoveAttachmentOrDocument アクション

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

CreateFolder アクション

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

AddAttachments アクション

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

DownloadAttachments アクション

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

アクションの例

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

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

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

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

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

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

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

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

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

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

例 - フォルダを作成する

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

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

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

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

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

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

例 - リストを取得する

例 - レコードを作成する

例 - レコードを削除する

統合で SharePoint 接続を使用する

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

次のステップ

PSC を構成してエンドポイントアタッチメントを作成する

OAuth 2.0 - クライアントシークレットの接続タイプ

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

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

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

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