Office365

Office365 コネクタを使用すると、Office365 インスタンスに接続し、サポートされているオペレーションを実行できます。

始める前に

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

  • Google Cloud プロジェクトで次の操作を行います。
    • 次のサービスを有効にします。
      • secretmanager.googleapis.com（Secret Manager API）
      • connectors.googleapis.com（Connectors API）

      サービスを有効にする方法については、サービスを有効にするをご覧ください。

    以前にプロジェクトでこうしたサービスを有効にしていない場合は、コネクタを構成するときにそれを有効にすることを求められます。

コネクタを構成する

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

  1. Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。

    [接続] ページに移動

  2. [+ 新規作成] をクリックして [接続の作成] ページを開きます。
  3. [ロケーション] セクションで、接続のロケーションを選択します。
    1. リージョン: プルダウン リストからロケーションを選択します

      コネクタをサポートしているリージョンは次のとおりです。

      サポートされているすべてのリージョンの一覧については、ロケーションをご覧ください。

    2. [次へ] をクリックします。
  4. [接続の詳細] セクションで、次の操作を行います。
    1. コネクタ: 使用可能なコネクタのプルダウン リストから [Office365] を選択します。
    2. コネクタのバージョン: 使用可能なバージョンのプルダウン リストからコネクタのバージョンを選択します。
    3. [接続名] フィールドに、接続インスタンスの名前を入力します。

      接続名は次の条件を満たす必要があります。

      • 接続名には英字、数字、ハイフンを使用できます。
      • 文字は小文字のみを使用できます。
      • 接続名の先頭には英字を設定し、末尾には英字または数字を設定する必要があります。
      • 接続名は 49 文字以内で指定してください。
    4. 必要に応じて、接続インスタンスの [説明] を入力します。
    5. 必要に応じて、Cloud Logging を有効にして、ログレベルを選択します。デフォルトのログレベルは Error に設定されています。
    6. サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
    7. 必要に応じて、接続ノードの設定を構成します。

      • ノードの最小数: 接続ノードの最小数を入力します。
      • ノードの最大数: 接続ノードの最大数を入力します。

      ノードは、トランザクションを処理する接続の単位（またはレプリカ）です。1 つの接続でより多くのトランザクションを処理するには、より多くのノードが必要になります。逆に、より少ないトランザクションを処理するには、より少ないノードが必要になります。ノードがコネクタの料金に与える影響については、接続ノードの料金をご覧ください。値を入力しない場合は、デフォルトで最小ノード数は 2 に設定され（可用性を高めるため）、最大ノード数は 50 に設定されます。

    8. Azure テナント: データへのアクセスに使用されている Microsoft Online テナント。指定しない場合、デフォルトのテナントが使用されます。
    9. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    10. [次へ] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

      Office365 接続でサポートされる認証タイプは次のとおりです。

      • OAuth 2.0 認証コード付与

      2. これらの認証タイプの構成方法については、認証を構成するをご覧ください。

    2. [次へ] をクリックします。
  6. Review: 接続と認証の詳細を確認します。
  7. [作成] をクリックします。

認証を構成する

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

  • OAuth 2.0 認証コード付与
    • アクセス トークン: auth-code-flow-based 接続でリクエストを認証するために使用されるアクセス トークン。
    • クライアント ID: アクセス トークンのリクエストに使用されるクライアント ID。
    • クライアント シークレット: アクセス トークンのリクエストに使用されるクライアント シークレット。

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

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

  • エンティティ: エンティティは、接続されているアプリケーションやサービスのオブジェクト、またはプロパティのコレクションと考えることができます。エンティティの定義は、コネクタによって異なります。たとえば、データベース コネクタでは、テーブルがエンティティであり、ファイル サーバー コネクタでは、フォルダがエンティティです。また、メッセージング システム コネクタでは、キューがエンティティです。

    ただし、コネクタでいずれのエンティティもサポートされていない、またはエンティティが存在しない可能性があります。その場合、Entities リストは空になります。

  • オペレーション: エンティティに対して行うことができるアクティビティです。エンティティに対して次のいずれかのオペレーションを行うことができます。

    使用可能なリストからエンティティを選択すると、そのエンティティで使用可能なオペレーションのリストが生成されます。オペレーションの詳細については、コネクタタスクのエンティティ オペレーションをご覧ください。ただし、コネクタがいずれかのエンティティ オペレーションをサポートしていない場合、サポートされていないオペレーションは Operations リストに含まれません。

  • アクション: コネクタ インターフェースを介して統合で使用できる主要な関数の一つです。アクションを使用すると、1 つまたは複数のエンティティに対して変更を加えることができます。また、使用できるアクションはコネクタごとに異なります。通常、アクションには入力パラメータと出力パラメータがあります。ただし、コネクタがどのアクションもサポートしていない可能性があります。その場合は、Actions リストが空になります。

システムの上限

Office365 コネクタは、ノードごとに 1 秒あたり 1 件のトランザクションを処理することができ、この上限を超えるトランザクションすべてをthrottlesします。デフォルトでは、Integration Connectors は、接続に 2 つのノードを割り当てます（可用性を高めるため）。

Integration Connectors に適用される上限の詳細については、上限をご覧ください。

操作

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

CancelEvent アクション

このアクションにより、予定をキャンセルできます。

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

パラメータ名 データ型 必須 説明
EventId 文字列 ○ イベントの ID。
UserId 文字列 × ユーザの ID
UserPrincipalName 文字列 × ライセンスを割り当てる必要があるユーザー名。
コメント 文字列 × 含めるコメント。

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

MoveMail アクション

このアクションにより、メールを移動できます。

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

パラメータ名 データ型 必須 説明
MessageId 文字列 ○ メール ID。
DestinationId 文字列 ○ メールの移動先となるフォルダの ID。

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

AssignLicense アクション

このアクションを行うと、ライセンスを割り当てることができます。

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

パラメータ名 データ型 必須 説明
UserId 文字列 × ライセンスを割り当てる必要があるユーザーの ID。
UserPrincipalName 文字列 × ライセンスを割り当てる必要があるユーザー名。
AddLicenseSkuId 文字列 × SKU の固有識別子。
DisabledPlans 文字列 × 無効化されたプランのカンマ区切りの一意識別子のコレクション。
RemoveLicenses 文字列 × 削除するライセンスを識別する ID のカンマ区切りのコレクション。

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

ForwardEvent アクション

このアクションにより、予定を転送できます。

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

パラメータ名 データ型 必須 説明
EventId 文字列 ○ イベントの ID。
UserId 文字列 × ユーザの ID
UserPrincipalName 文字列 × ライセンスを割り当てる必要があるユーザー名。
コメント 文字列 × 含めるコメント。
ToRecipients 文字列 ○ 受信者のメールアドレスのセミコロン区切りリスト。

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

UploadFile アクション

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

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

パラメータ名 データ型 必須 説明
FileName 文字列 × コンテンツをアップロードする必要があるファイルの名前。
LocalFile 文字列 × アップロードするコンテンツを含むローカル ファイル。
ContentStream 文字列 × localpath または folderpath が指定されていない場合にアップロードされる入力ストリームとしてのコンテンツ。
ParentId 文字列 ○ 現在のアイテムがあるフォルダの ID。
Content 文字列 × アップロードするファイルのコンテンツ。

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

DownloadFile アクション

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

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

パラメータ名 データ型 必須 説明
FileId 文字列 ○ ダウンロードするファイルの ID。
DownloadTo 文字列 × ファイルの保存場所。
エンコード 文字列 × FileData 入力のエンコード タイプ。指定できる値は NONE、BASE64 です。デフォルト値は BASE64 です。
FileStream 文字列 × ファイルデータが書き込まれる出力ストリームのインスタンス。DownloadTo が指定されていない場合にのみ使用されます。

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

CreateFolder アクション

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

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

パラメータ名 データ型 必須 説明
ParentId 文字列 × 現在のアイテムが存在するフォルダの ID。
FolderName 文字列 ○ 作成するフォルダの名前。

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

SendMail アクション

このアクションにより、メールを送信できます。

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

パラメータ名 データ型 必須 説明
ToRecipients 文字列 × メールを送信する受信者。
Content 文字列 × メールの内容
件名 文字列 × メールの件名。
ID 文字列 × 送信するメッセージの ID（省略可）。ユーザーは、既存のメール ID を使用するか、他のフィールドに必要に応じて入力して新しいメールを送信できます。
添付ファイル 文字列 × 添付ファイル。添付ファイルは次の形式で指定します。

filename1,filecontent1;filename2,filecontent2。各ファイルの内容は、BASE64 データまたは @ 文字が先頭にあるローカル ファイルのパスです。
FileName 文字列 × 受信者として、次の順序で受信者を指定します。
LocalFile 文字列 × 添付ファイルのコンテンツを含むファイル。
ContentBytes 文字列 × BASE64 でエンコードされた添付ファイルのコンテンツ。
CCRecipients 文字列 × CC の受信者の値セミコロンで区切ったもの。
SenderEmail 文字列 × 代わりにメールを送信するユーザーのメールアドレス。別のユーザーのアカウントに代わってメールを送信する場合は、この値を設定します。
FromEmail 文字列 × メールを送信するユーザーのメールアドレス。他のユーザーのアカウントからメールを送信する場合は、この値を設定します。
ContentType 文字列 × メール本文のコンテンツ タイプ。有効な値は text、html です。 デフォルト値は text です。

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

ForwardMail アクション

このアクションにより、メールを転送できます。

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

パラメータ名 データ型 必須 説明
MessageId 文字列 ○ メールの ID。
ToRecipients 文字列 ○ 受信者のメールアドレスのセミコロン区切りリスト。
コメント 文字列 × 元のメッセージに加えたコンテンツ。

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

DownloadEmail アクション

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

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

パラメータ名 データ型 必須 説明
MessageId 文字列 ○ ダウンロードするメッセージの ID。
エンコード 文字列 × ファイルデータ入力のエンコード タイプ。
DownloadTo 文字列 × ファイルの保存場所。
FileStream 文字列 × ファイルデータの書き込み先となる出力ストリームのインスタンス。この値は、DownloadTo が指定されていない場合にのみ使用されます。

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

DownloadAttachments アクション

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

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

パラメータ名 データ型 必須 説明
MessageId 文字列 ○ 添付ファイルを取得するメールの ID。
エンコード 文字列 × FileData 入力のエンコード タイプ。 指定できる値は NONE、BASE64 です。
DownloadTo 文字列 × 添付ファイルを保存する場所。指定しない場合、添付ファイルのコンテンツ バイトが返されます。MessageId が指定されている場合、この値は必須です。
AttachmentId 文字列 × ダウンロードする添付ファイルの ID。指定しない場合、メールのすべての添付ファイルを返します。
UserId 文字列 × ユーザの IDこのアクションは、認証されたユーザーに管理者権限がある場合にのみ機能します。
FileStream 文字列 × ファイルデータが書き込まれる出力ストリームのインスタンス。DownloadTo が指定されていない場合にのみ使用されます。

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

アクションの例

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

例 - イベントをキャンセルする

この例では、指定された ID のイベントをキャンセルします。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [CancelEvent] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-GAAA=",   
"Comment": "Canceled due to rain"
}

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

    [{
"Status": "Success"
}]

例 - ライセンスの割り当てと削除を行う

この例では、指定したユーザーにライセンスを割り当て、削除します。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [AssignLicense] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"UserID": "ee58217f-b22e-4300-a876-53db3c71a87b",   
"AddLicenseSkuId": "c42b9cae-ea4f-4ab7-9717-81576235ccac",   
"RemoveLicenses": "c42b9cae-ea4f-4ab7-9717-81576235ccac"
}

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

    [{
"Status": "Success"
}]

例 - イベントを転送する

この例では、イベントを転送します。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [ForwardEvent] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"EventId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAENAAAhfASdetQfTZ3pESzwWnAbAAA_CxGjAAA=",   
"Comment": "forwarded due to rain",   
"ToRecipients": "test99@example.com"
}

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

    [{
"Status": "Success"
}]

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

この例では、ファイルをアップロードします。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [UploadFile] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"FileName": "Document1234.docx",   
"ParentId": "01VCU572N6Y2GOVW7725BZO354PWSELRRZ",   
"Content": "test"
}

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

     [{
"Id": "01VCU572JX6F3L3NKLQVB2BXETRHLEAUAY",   
"@test.context": "https://example.com/v1.0/$metadata#users('7954f490-5a43-083fc215362a')/drive/items('01VCU5BZO354PWSELRRZ')/test/$entity",   
"@example.downloadurl": "https://example.com/test/admin123/_layouts/15/download.aspx?UniqueId=bd76224r7-4........
"Status": "Success"
}]

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

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

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [DownloadFile] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"FileId": "01VCU572LDCGQYZOSMHZDZGN5HCXS5P6EP"
}

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

    [{
"Status": "Success",
"FileData": "UEsDBBQAAAAIAEoTdVdSWj6GTAEAABoFAAATAAAAWNdLnhtbLWUTU7DMBCFr2J"
}]

例 - フォルダを作成する

この例では、フォルダを作成します。

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

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

    [{
"Status": "Success"
}]

例: メールを送信する

この例では、指定した受信者にメールを送信します。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [SendMail] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"ToRecipients": "test097@example.com",   
"Content": "Testing",   
"Subject": "Test subject",   
"FileName": "Google"
}

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

    [{
"Status": "Success"
}]

例 - メールを転送する

この例では、メールを転送します。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [ForwardMail] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"MessageId": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGAAAAAACvzgT4b7T_Qav2LM_bB-PKBwAhfASdetQfTpESzwWnAbAAA0sITVAAA=",   
"ToRecipients": "test097@example.com",   
"Comment": "forwarded message"
}

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

    [{
"Status": "Success"
}]

例 - メールをダウンロードする

この例では、メールをダウンロードします。

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [DownloadEmail] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"MessageId": "fTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITVAAA="
}

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

    [{
"Status": "Success",   
"FileData": "RnJvbTogRk5VIExOVSA8YWRtaW4xMjNANzNzY21nLm9ubWljcm9zb2Z0LmNvbT4NClRvOiB0ZXN0IDx0ZXN0.......
}]

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

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

  1. [Configure connector task] ダイアログで、[Actions] をクリックします。
  2. [DownloadAttachments] アクションを選択してから、[完了] をクリックします。
  3. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
{"MessageId": "PKBwAhfASdetQfTZ3pESzwWnAbAAAAAAEJAAAhfASdetQfTZ3pESzwWnAbAAA0sITWAAA=",   
"DownloadTo": "My files/Office355/reports/"}
}

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

    [{
"Id": "AAMkAGQ2NGQwNWU0LTU2MjUtNDZmNy04NGQzLTY4ZmU4Y2E4Y2JiNgBGTWAAABEgAQAF3EBDrnTc1Cj8akAYrJjdM=",
"Name": "demoattachment.docx",
"ContentBytes": "UEsDBBQAAAAIALskYlcppqeszQEAAHQJAAATAAAAWAAAI3RyYXNoXS8wMDAwLmRhdP........",
"LastmodifiedDatetime": "2023-11-21T10:09:09Z",
"ContentType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"FileData": null,
"json:repeatelementorder#": null,
"size": "23575",
"isinline": "false
}]

統合で Office365 接続を使用する

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

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

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

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

次のステップ