SharePoint
SharePoint コネクタを使用すると、SharePoint のファイル、フォルダ、添付ファイルを管理できます。
サポート対象のバージョン
このコネクタは、Windows SharePoint Services 3.0、Microsoft Office SharePoint Server 2007 以降、SharePoint Online をサポートしています。
始める前に
Google Cloud プロジェクトで次のタスクを行います。
- ネットワーク接続が設定されていることを確認します。詳細については、ネットワーク接続をご覧ください。
- コネクタを構成するユーザーに roles/connectors.admin IAM ロールを付与します。
- コネクタに使用するサービス アカウントに、
roles/secretmanager.viewer
とroles/secretmanager.secretAccessor
の IAM ロールを付与します。 secretmanager.googleapis.com
(Secret Manager API)とconnectors.googleapis.com
(Connectors API)を有効にします。詳細については、サービスを有効にするをご覧ください。
SharePoint 接続を作成する
接続はデータソースに特有です。つまり、多数のデータソースがある場合は、データソースごとに別々の接続を作成する必要があります。接続を作成する手順は次のとおりです。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [+ 新規作成] をクリックして [接続を作成] ページを開きます。
- [ロケーション] セクションで、[リージョン] リストからロケーションを選択し、[次へ] をクリックします。
サポートされているすべてのリージョンのリストについては、ロケーションをご覧ください。
- [接続の詳細] セクションで、次の操作を行います。
- コネクタのリストから [SharePoint] を選択します。
- [コネクタのバージョン] リストからコネクタのバージョンを選択します。
- [接続名] フィールドに、接続インスタンスの名前を入力します。接続名には、小文字、数字、ハイフンを使用できます。名前の先頭は英字、末尾は英字または数字にします。名前は 49 文字を超えないようにします。
- 必要に応じて、接続インスタンスの [説明] を入力します。
- 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは
Error
に設定されています。 - [サービス アカウント] フィールドで、必要なロールを持つアカウントを選択します。
- 必要に応じて、接続ノードの設定を構成します。
- ノードの最小数: 接続ノードの最小数を入力します。
- ノードの最大数: 接続ノードの最大数を入力します。
ノードは、トランザクションを処理する接続の単位(またはレプリカ)です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され(可用性を高めるため)、最大ノード数は 50 に設定されます。
- 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
- [次へ] をクリックします。
- [宛先] セクションに、接続するリモートホスト(バックエンド システム)の詳細を入力し、[次へ] をクリックします。
- 宛先のホスト名または IP アドレスを指定するには、[ホストアドレス] を選択し、[ホスト 1] フィールドにアドレスを入力します。
- プライベート接続を確立するには、[エンドポイント アタッチメント] を選択し、[エンドポイント アタッチメント] リストから必要なアタッチメントを選択します。
-
[認証] セクションで、認証の詳細を入力します。
- [認証タイプ] を選択し、関連する詳細を入力します。
SharePoint 接続でサポートされる認証タイプは次のとおりです。
- Windows 認証情報。SharePoint のオンプレミス エディションを使用している場合は、これを選択します。
- AzureAD。SharePoint のオンライン エディションを使用する場合は、これを選択します。
- JWT Bearer を使用した OAuth 2.0 クライアント認証情報。認証に JWT Bearer OAuth 2.0 クライアント認証情報を使用する場合は、このオプションを選択します。
- クライアント シークレットを使用する OAuth 2.0 クライアント認証情報。認証にクライアント シークレットを使用する OAuth 2.0 クライアント認証情報を使用する場合は、このオプションを選択します。
- [次へ] をクリックします。
これらの認証タイプの構成方法については、認証を構成するをご覧ください。
- [認証タイプ] を選択し、関連する詳細を入力します。
- [確認] セクションで、接続と認証の詳細を確認します。
- [作成] をクリックします。
[宛先の種類] フィールドで、宛先の種類を選択します。たとえば、ホストアドレスは https://<SITE_NAME>.sharepoint.com
です。
セキュリティをさらに強化してバックエンドシステムへのパブリック接続を確立する場合は、接続用の静的アウトバウンド IP アドレスの構成を検討してから、特定の静的 IP アドレスのみを許可リストに登録するようファイアウォール ルールを構成します。
他の宛先を入力するには、[+ 宛先を追加] をクリックします。
認証を構成する
SharePoint コネクタは、次の認証タイプをサポートしています。
Windows 認証情報認証タイプ
Windows 認証情報認証タイプを有効にするには、次の手順を完了する必要があります。
PSC を構成してエンドポイント アタッチメントを作成する
- SharePoint がホストされている IP を使用してインスタンス グループを作成します。
- 内部パススルー ネットワーク ロードバランサを作成し、作成したインスタンス グループをバックエンドとして使用します。TCP 内部ロードバランサでグローバル アクセスが有効になっている必要があります。
- Private Service Connect でロードバランサを公開します。サービス アタッチメントは、ロードバランサの公開後に生成されます。
- サービスを公開し、作成したロードバランサを指定します。
- サービス アタッチメントを使用して、エンドポイント アタッチメントを作成します。
- エンドポイント アタッチメントを作成したら、エンドポイント アタッチメントの IP を使用して SharePoint 接続を作成します。
エンドポイント アタッチメントの作成の詳細については、エンドポイント アタッチメントを作成するをご覧ください。
Google Cloudで Windows 認証情報の詳細を指定する
Integration Connectors で接続を作成するときは、次の詳細を指定する必要があります。
[認証] セクションで、認証タイプとして [Windows 認証情報] を選択し、次の詳細を入力します。
- ユーザー名: ユーザー名を入力します。
- パスワード: パスワードを選択します。
- シークレット バージョン: シークレット バージョンを入力します。
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 |
認証 | Windows 認証情報 |
ユーザー名 | USER_NAME |
パスワード | パスワード |
シークレットのバージョン | 1 |
Azure AD 認証タイプ
Azure AD 認証タイプを有効にするには、次の操作を行います。
- アプリを登録して、OAuthClientId と OAuthClientSecret を取得します。
- Google Cloudで認証情報を指定します。
- Google Cloudで接続を承認します。
- リダイレクト URL をアプリに追加します。
アプリを登録して OAuthClientId と OAuthClientSecret を取得する
アプリを登録して、アプリの OAuthClientId と OAuthClientSecret を取得するには、次の操作を行います。
- Azure Portal にログインします。
- [Azure サービス] で、[アプリの登録]、[新規登録] の順に選択します。
- アプリケーション名を入力し、[Any Microsoft Entra ID tenant - Multitenant] を選択します。
- [Register] をクリックします。
- アプリを作成したら、[証明書とシークレット] ページに移動します。
- アプリケーションのクライアント シークレットを作成し、クライアント シークレットの値を保存します。
- [API 権限] ページに移動します。
- [権限を追加] をクリックします。
- [API のアクセス許可の要求] ダイアログで、次の表から API、タイプ、権限を選択して、アプリケーションでオペレーションを実行します。
- 変更を保存します。
- 管理者権限が必要な権限を使用するように選択した場合は、[API 権限] ページで現在のテナントから権限を付与できます。
- スコープを追加するには、[API を公開する] セクションに移動して
AllSites.Manage, Sites.FullControl.All
スコープを追加し、制御できるユーザー(管理者とユーザー)を選択します。 - [保存] をクリックします。
接続を有効にするには、Microsoft Graph API の Sites.Read.All
権限を付与する必要があります。
API | 権限名 | タイプ |
---|---|---|
Microsoft Graph | ConsentRequest.Read.All |
Application/ Delegated |
Microsoft Graph | ConsentRequest.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | DelegatedAdminRelationship.Read.All |
Application/ Delegated |
Microsoft Graph | DelegatedAdminRelationship.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | DelegatedPermissionGrant.Read.All |
Application/ Delegated |
Microsoft Graph | DelegatedPermissionGrant.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | Files.Read.All |
Application/ Delegated |
Microsoft Graph | Files.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | Sites.FullControl.All |
Application/ Delegated |
Microsoft Graph | Sites.Manage.All |
Application/ Delegated |
Microsoft Graph | Sites.Read.All |
Application/ Delegated |
Microsoft Graph | Sites.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | Sites.Selected |
Application/ Delegated |
Microsoft Graph | TermStore.Read.All |
Application/ Delegated |
Microsoft Graph | TermStore.ReadWrite.All |
Application/ Delegated |
Microsoft Graph | User.Export.All |
Application/ Delegated |
Microsoft Graph | User.Read |
Delegated |
Microsoft Graph | User.Read.All |
Application/ Delegated |
Microsoft Graph | User.ReadWrite.All |
Application/ Delegated |
SharePoint | EnterpriseResource.Read |
Delegated |
SharePoint | EnterpriseResource.Write |
Delegated |
SharePoint | Project.Read |
Delegated |
SharePoint | Project.Write |
Delegated |
SharePoint | ProjectWebApp.FullControl |
Delegated |
SharePoint | ProjectWebAppReporting.Read |
Delegated |
SharePoint | TaskStatus.Submit |
Delegated |
Google Cloudで認証情報を指定する
Integration Connectors で接続を作成するときは、次の詳細を指定する必要があります。
[認証] セクションで、認証タイプとして [AzureAD] を選択し、次の詳細を入力します。
- クライアント ID: アクセス トークンのリクエストに使用するクライアント ID を入力します。
- スコープ: 必要なスコープをカンマ区切りのリストで入力します。例:
Sites.FullControl.All
- クライアント シークレット: 作成した接続されているアプリのクライアント シークレットを含む Secret を入力します。
- シークレット バージョン: 上で選択したシークレットのシークレット バージョン。
- 認証 URL: OAuth クライアントの作成時に生成する認証 URL。URL を
https://login.microsoftonline.com/TENANT_IDENTIFIER/oauth2/v2.0/authorize?prompt=consent
の形式で入力します。例:https://login.microsoftonline.com/9byyyyyyyyy8112/oauth2/v2.0/authorize?prompt=consent
。
Google Cloudで接続を承認する
- 接続ページで、新しく作成された接続を見つけます。
新しいコネクタの [ステータス] は [承認が必要] になります。
- [承認が必要] をクリックします。
これにより、[承認の編集] ペインが表示されます。
- [リダイレクト URI] の値を外部アプリケーションにコピーします。詳しくは、アプリにリダイレクト URL を追加するをご覧ください。
- 認可の詳細を確認します。
- [承認] をクリックします。
認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。
リダイレクト URL をアプリに追加する
- Azure ポータルで、[Azure サービス > アプリの登録] をクリックします。
- アプリ名をクリックします。
- [リダイレクト URI を追加] をクリックします。
- [プラットフォームを追加] をクリックします。
- [ウェブ] ダイアログで、 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 ベアラー認証タイプでクライアント認証情報を有効にするには、次の手順を完了する必要があります。
- 証明書を作成します。
- 証明書を Azure ポータルにアップロードします。
- 秘密鍵を取得します。
- セットアップを完了します。
- Google Cloudで OAuth 2.0 JWT Bearer 認証情報を指定します。
証明書を作成する
- パソコンに空のフォルダを作成します。
- フォルダにテキスト ファイルを作成します。
- 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 ポータルに証明書をアップロードする
- Azure Portal にログインし、次の詳細を指定して新しいアプリケーションを登録します。
- 名前: アプリケーションの名前を入力します。
- [サポートされているアカウントの種類]: [この組織ディレクトリ内のアカウントのみ(アカウント名のみ - 単一テナント)] を選択します。
- [API 権限] > [権限を追加] > [API 権限をリクエスト] > [SharePoint] に移動します。
- [アプリケーションの権限] を選択し、必要な権限を追加します。
- [管理者の同意を得る] を選択し、[はい] を選択します。
- アプリを作成したら、[証明書とシークレット] セクションに移動します。
- [証明書をアップロード] を選択し、パソコンから CER 証明書をアップロードします。アップロードが完了したら、[追加] を選択します。
クライアント シークレットは、証明書ベースの認証フローを妨げるため、アプリに追加しないでください。
- マニフェストに移動し、KeyCredentials を見つけて、customKeyIdentifier をサムプリントとしてコピーします。この値は後で使用します。これで、アプリの登録と証明書のリンクが完了しました。
秘密鍵を取得する
秘密鍵を取得するには、OpenSSL を使用して PFX ファイルを PEM ファイルに変換します。
- コマンド プロンプトで、PFX ファイルを含むフォルダに移動し、次のコマンドを実行します。
openssl pkcs12 -in MyCertificate.pfx -out MyCertificate.pem -nodes
- 証明書の作成プロセスで使用した PFX パスワードを入力します。
- テキスト エディタで PEM ファイルを開き、テキスト全体(秘密鍵)をコピーします。
セットアップを完了する
- Azure ポータルで新しく登録したアプリからクライアント ID とテナント ID をコピーします。
- 次の認証情報を使用して、SharePoint リスト サービス プリンシパルの認証でログインします。
- クライアント ID
- テナント ID
- 秘密鍵
- Thumbprint(秘密鍵のパスワード)
Google Cloudで OAuth 2.0 JWT Bearer 認証情報を指定する
Integration Connectors で接続を作成するときは、次の詳細を指定する必要があります。
[認証] セクションで、認証タイプとして [JWT ベアラーを使用した OAuth 2.0 クライアント認証情報] を選択し、次の詳細を入力します。
- [クライアント ID] フィールドに、アクセス トークンのリクエストに使用するクライアント ID を入力します。これは、Azure ポータルでアプリを登録したときに生成されたコンシューマー キーです。
- [秘密鍵] フィールドで、PEM 形式の秘密鍵ファイルの内容を含む Secret Manager のシークレットを選択します。秘密鍵は、コネクタに提供された公開鍵/証明書と一致する必要があります。
- [シークレットのバージョン] フィールドで、上で選択したシークレットのバージョンを選択します。
- [秘密鍵パスワード] フィールドで、秘密鍵ファイルのパスワード(言い回し)を含む Secret Manager のシークレットを選択します。証明書の作成時に秘密鍵の保護に設定したパスワードと同じパスワードを使用します。
- [シークレットのバージョン] フィールドで、上で選択したシークレットのバージョンを選択します。
- [Azure テナント] フィールドに、データへのアクセスに使用されている Microsoft オンライン テナントを入力します。
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 | **** |
認証 | JWT Bearer を使用した OAuth 2.0 クライアント認証情報 |
OAuth クライアント ID | CLIENT_ID |
秘密鍵 | キー |
シークレットのバージョン | 1 |
秘密鍵のパスワード | パスワード |
シークレットのバージョン | 1 |
Azure テナント | AZURE_TENANT_ID |
OAuth 2.0 - クライアント シークレットの接続タイプ
OAuth 2.0 クライアント シークレット接続タイプを有効にするには、次の手順を完了する必要があります。
アドインを登録する
- 次の URL(
https://<SITE_NAME>.SharePoint.com/_layouts/15/appregnew.aspx
)を使用して、[Register Add-In] ページに移動します。 - [アプリ情報] セクションで、クライアント ID とクライアント シークレットを生成します。
- タイトル、アプリのドメイン、リダイレクト URI の値を指定します。
- [作成] をクリックします。アドインが登録され、SharePoint アプリに作成された情報が表示されます。
アドオンに権限を付与する
- 次の URL(
https://<SITE_NAME>-admin.sharepoint.com/_layouts/15/appinv.aspx
)を使用して SharePoint サイトに移動します。[権限の付与] ページにリダイレクトされます。 - [アプリ ID] 欄に、先ほど生成したクライアント ID を入力し、[参照] をクリックします。[タイトル]、[アプリのドメイン]、[リダイレクト URL] の値が入力されます。
- 次の権限リクエストを XML 形式で入力します。
<AppPermissionRequests AllowAppOnlyPolicy="true"> <AppPermissionRequest Scope="http://sharepoint.com/content/tenant" Right="FullControl"/> </AppPermissionRequests>
- [作成] をクリックします。SharePoint アプリに権限の同意ダイアログが表示されます。
- [Trust it](信頼する)をクリックします。
Google Cloudで OAuth 2.0 クライアント認証情報を指定する
Integration Connectors で接続を作成するときは、次の詳細を指定する必要があります。
[認証] セクションで、認証タイプとして [クライアント シークレットを使用する OAuth 2.0 クライアント認証情報] を選択し、次の詳細を入力します。
- [クライアント ID] フィールドに、作成したアプリ用にコネクタから提供されたクライアント ID を入力します。
- [クライアント シークレット] フィールドで、作成した接続されているアプリのクライアント シークレットを含む Secret Manager のシークレットを選択します。
- [シークレットのバージョン] フィールドで、クライアント シークレットのバージョンを選択します。
認証コードの再認可
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 |
統合で SharePoint 接続を使用する
接続を作成すると、Apigee Integration と Application Integration の両方で使用できるようになります。この接続は、コネクタタスクを介して統合で使用できます。
操作
このセクションでは、コネクタでサポートされているアクションを一覧表示します。アクションの構成方法については、アクションの例をご覧ください。
DeleteAttachment アクション
このアクションにより、添付ファイルが削除されます。
DeleteAttachment アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ListTitle | 文字列 | ○ | リストアイテムのタイトル。 |
ItemId | 文字列 | ○ | リストアイテムの ID。 |
FileName | 文字列 | ○ | ドキュメント ライブラリから削除するファイルの名前。 |
CheckInDocument アクション
このアクションにより、ドキュメントをチェックインできます。
CheckInDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RelativeURL | 文字列 | ○ | フォルダの相対 URL。 |
DocumentName | 文字列 | ○ | チェックインするファイルの名前。 |
コメント | 文字列 | × | チェックイン メッセージ(省略可)。 |
CheckOutDocument アクション
このアクションにより、ファイルをチェックアウトできます。
CheckOutDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RelativeURL | 文字列 | ○ | フォルダの相対 URL。 |
DocumentName | 文字列 | ○ | チェックアウトするファイルの名前。 |
DiscardCheckOutDocument アクション
このアクションにより、ファイルのチェックアウトを元に戻すことができます。
DiscardCheckOutDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RelativeURL | 文字列 | ○ | フォルダの相対 URL。 |
DocumentName | 文字列 | ○ | チェックアウトを元に戻す必要があるファイルの名前。 |
CopyDocument アクション
このアクションにより、ファイルをある場所から別の場所にコピーできます。
CopyDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
SourceFileRelativeUrl | 文字列 | ○ | ソースファイルの相対 URL。 |
DestFileRelativeUrl | 文字列 | ○ | 宛先ファイルの相対 URL。 |
UploadDocument アクション
このアクションにより、ファイルをアップロードできます。
UploadDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
FileName | 文字列 | ○ | アップロードするファイルの名前。 |
RelativeUrl | 文字列 | ○ | フォルダの相対 URL。 |
コンテンツ | 文字列 | × | ファイルとしてアップロードするコンテンツ。 |
ContentBytes | 文字列 | × | ファイルとしてアップロードするバイト コンテンツ(Base64 文字列として)。バイナリデータをアップロードするために使用します。 |
HasBytes | ブール値 | × | アップロードするコンテンツがバイナリかどうかを指定します。デフォルト値は false です。 |
DownloadDocument アクション
このアクションにより、ファイルをダウンロードできます。
DownloadDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RemoteFile | 文字列 | ○ | ダウンロードするファイルの完全な URL。 |
ライブラリ | 文字列 | ○ | SharePoint サーバー上のライブラリの名前。 |
HasBytes | ブール値 | × | コンテンツをバイトとしてダウンロードするかどうかを指定します。デフォルト値は false です。 |
MoveAttachmentOrDocument アクション
このアクションにより、ファイルをフォルダ間で移動できます。
MoveAttachmentOrDocument アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
SourceFileURL | 文字列 | ○ | 移動する必要があるソースファイルの URL。 |
DestinationFolderURL | 文字列 | ○ | 宛先フォルダの URL。 |
CreateFolder アクション
このアクションにより、フォルダを作成できます。
CreateFolder アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RelativeURL | 文字列 | ○ | フォルダの相対 URL。 |
FolderName | 文字列 | ○ | 作成するフォルダの名前。 |
AddAttachments アクション
このアクションにより、添付ファイルを追加できます。
AddAttachments アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
ListTitle | 文字列 | ○ | 添付ファイルリストの名前。 |
FileName | 文字列 | ○ | 添付ファイルの名前。 |
ItemId | 文字列 | ○ | 追加する添付ファイルの ID。 |
コンテンツ | 文字列 | ○ | 添付ファイルのコンテンツ。 |
ContentBytes | 文字列 | × | 添付ファイルとしてアップロードするバイト コンテンツ(Base64 文字列として)。バイナリデータをアップロードするために使用します。 |
HasBytes | ブール値 | × | アップロードするコンテンツがバイナリかどうかを指定します。デフォルト値は false です。 |
DownloadAttachments アクション
このアクションにより、添付ファイルをダウンロードできます。
DownloadAttachments アクションの入力パラメータ
パラメータ名 | データ型 | 必須 | 説明 |
---|---|---|---|
RemoteFile | 文字列 | ○ | ファイルの相対 URL。 |
HasBytes | ブール値 | × | ダウンロードするコンテンツがバイナリかどうかを指定します。デフォルト値は false です。 |
アクションの例
このセクションでは、このコネクタでいくつかのアクションを実行する方法について説明します。
例 - 添付ファイルを削除する
この例では、指定したファイルを削除します。
- [
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
] をクリックします。 - [
DownloadDocument
] アクションを選択してから、[完了] をクリックします。 - [コネクタ] タスクの [タスク入力] セクションで、
connectorInputPayload
をクリックし、Default Value
フィールドに次のような値を入力します。{ "RemoteFile": " http://z8**.sharepoint.com/sites/SharepointGCS/Docs/SharpointGCS.docx", "Library": "Docs", "HasBytes": true }
アクションが成功すると、
DownloadDocument
タスクの connectorOutputPayload
レスポンス パラメータの値は次のようになります。
[ { "Success": "True", "ContentBytes": "UEsDBAoAAAAAAAAAIQD/////TwEAAE8BAAAQAAAAW3RyYXNoXS8wMDAwLmRhdP////nFmjQeC1QbGmk9o7n0xjiLgudAMOrYQBpOZdZp5/OrWkWbudVPccasL5uVSKun3URrHAxow7iMUm2WSi7nlGy2Mr+sjJxQSrYFcFtDQyo/QSutWhbNcAODEWh14mklzxCS9C5CW3Fmwme/gMKGjGoXlSVyvtDoB+u0A6XtA8bkWTnPNHSvxcepoAKIdsR96imCvxe4MxOWqHWnQkLDyjNMOMrrQeMDF7nOMCCvPlVn5Vd6KlDYnHlW1zLOcQf6WmKl2xN4Z8WBXZfkrJZqPv6yNdWyp8ADRmgTdRSqDkPpQqzvqWj3qpdiRZqSwyBRtfr2kHBumkTNjSi6drBMFMxZEgrktw6ZxuEXcx3v16cXd6k5JVO3kOXMg/HFnH" } ]
特定のサイトからファイルをダウンロードするには、リモートファイルの完全なアドレスを指定する必要があります。
例 - 添付ファイルを移動する
この例では、添付ファイルをある場所から別の場所に移動します。
- [
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
を入力します。
- Apigee Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
- Application Integration で Connectors タスクを作成して使用する方法については、Connectors タスクをご覧ください。
Google Cloud コミュニティの助けを借りる
Google Cloud コミュニティの Cloud フォーラムで質問を投稿したり、このコネクタについてディスカッションしたりできます。次のステップ
- 接続を一時停止して再開する方法を確認する。
- コネクタの使用状況をモニタリングする方法を確認する。
- コネクタログを表示する方法を確認する。