Box

Box コネクタを使用すると、Box バックエンドに接続し、SQL を使用して Box データを取得および更新できます。

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

このコネクタは Box Content API バージョン 2.0 をサポートしています。

準備

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

  • 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）

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

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

コネクタを構成する

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

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

    [接続] ページに移動

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

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

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

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

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

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

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

    8. なりすましユーザーモード: ユーザーのなりすましのタイプを指定します。ユーザーモードか管理モードかを指定します。
    9. Use proxy: このチェックボックスを選択して、接続用のプロキシ サーバーを構成し、次の値を構成します。
      • Proxy Auth Scheme: プロキシ サーバーで認証する認証タイプを選択します。次の認証タイプがサポートされています。
        • 基本: 基本的な HTTP 認証。
        • ダイジェスト: ダイジェスト HTTP 認証。
      • Proxy User: プロキシ サーバーでの認証に使用されるユーザー名。
      • プロキシ パスワード: ユーザーのパスワードの Secret Manager シークレット。
      • Proxy SSL Type: プロキシ サーバーへの接続時に使用する SSL タイプ。次の認証タイプがサポートされています。
        • 自動: デフォルトの設定。URL が HTTPS URL の場合は、[トンネル] オプションが使用されます。URL が HTTP URL の場合、[なし] オプションが使用されます。
        • 常に: 接続は常に SSL 対応です。
        • なし: 接続は SSL に対応していません。
        • トンネル: 接続はトンネリング プロキシ経由で行われます。プロキシ サーバーがリモートホストへの接続を開き、トラフィックはプロキシを経由するようになります。
      • [Proxy Server] セクションで、プロキシ サーバーの詳細を入力します。
        1. [+ 宛先を追加] をクリックします。
        2. [宛先の種類] を選択します。
          • Host address: 宛先のホスト名または IP アドレスを指定します。

            バックエンドへのプライベート接続を確立する場合は、次のようにします。

    10. 必要に応じて、[+ ラベルを追加] をクリックして Key-Value ペアの形式でラベルを接続に追加します。
    11. [NEXT] をクリックします。
  5. [認証] セクションで、認証の詳細を入力します。
    1. [認証タイプ] を選択し、関連する詳細を入力します。

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

      • JWT 認証
      • OAuth 2.0 - 認証コード
      • Box JSON
      • OAuth 2.0 - クライアント認証情報

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

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

認証を構成する

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

  • JWT 認証
    • クライアント ID: 作成したアプリ用に Box から提供されたクライアント ID。
    • クライアント シークレット: 作成したアプリのクライアント シークレットを含む Secret Manager のシークレット。
    • シークレットのバージョン: クライアント シークレットのバージョン。
    • 秘密鍵: 秘密鍵ファイルの内容を格納する Secret Manager のシークレット。秘密鍵は、コネクタに提供された公開鍵 / 証明書と一致する必要があります。
    • シークレットのバージョン: 秘密鍵シークレットのバージョン。
    • 秘密鍵パスワード: 秘密鍵ファイルのパスワード（言い回し）を含む Secret Manager のシークレット。
    • シークレットのバージョン: 秘密鍵パスワードのバージョン。
    • Box アプリケーションのアクセスレベル: Box アプリのアプリケーション アクセスレベル。
    • エンタープライズ ID / ユーザー ID: アプリレベルがエンタープライズの場合はエンタープライズ ID、アプリレベルがユーザーの場合はユーザー ID
    • OAuth JWT 公開鍵 ID: JWT の公開鍵の ID。
    • Auth スキーム: Box コネクタの認証スキーム
    • OAuth を開始する: Box コネクタの OAuth パラメータを開始します。
    • OAuth JWT 証明書タイプ: Box コネクタの OAuth JWT 証明書タイプ。
  • OAuth 2.0 - 認証コード
    • クライアント ID: 作成したアプリ用に Box から提供されたクライアント ID。
    • スコープ: 権限スコープ。例: root_readonlyスコープの仕組みと Box で利用可能なすべてのスコープを確認するには、スコープをご覧ください。
    • クライアント シークレット: Secret Manager のシークレットを選択します。 この認可を構成する前に、Secret Manager のシークレットを作成する必要があります。
    • シークレットのバージョン: クライアント シークレットの Secret Manager シークレットのバージョン。
  • Box JSON
    • JWT Auth 用の Box JSON: Box から提供された JSON ファイルの内容を含むシークレット。
    • シークレットのバージョン: JSON ファイル シークレットのバージョン。
  • OAuth 2.0 - クライアント認証情報
    • OAuth クライアント ID: 作成したアプリ用に Box から提供されたクライアント ID。
    • クライアント シークレット: 作成したアプリのクライアント シークレットを含む Secret Manager のシークレット。
    • シークレットのバージョン: クライアント シークレットのバージョン。
    • サブジェクト ID: アプリケーションがアクセス権の委任をリクエストするユーザー サブジェクト。
    • Box アプリケーションのアクセスレベル: Box アプリのアプリケーション アクセスレベル。

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

接続構成のサンプル

このセクションでは、接続の作成時に構成するさまざまなフィールドのサンプル値を示します。

OAuth JWT トークン メソッドの接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ Box
コネクタのバージョン 1
接続名 box-conn
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
なりすましユーザーモード ユーザー
ノードの最小数 2
ノードの最大数 2
認証 JWT 認証
クライアント ID XXXX
クライアント シークレット XXXX
シークレット バージョン 1
秘密鍵 XXXX
シークレット バージョン 1
秘密鍵のパスワード XXXX
シークレット バージョン 1
Box アプリケーションのアクセスレベル Enterprise
エンタープライズ ID / ユーザー ID XXXX
OAuth JWT 公開鍵 ID XXXX
認証スキーム OAuthJWT
OAuth を開始する GETANDREFRESH
OAuth JWT 証明書タイプ PEMKEY_BLOB

クライアント ID、クライアント シークレット、Box アプリケーションのアクセスレベル、エンタープライズ ID / ユーザー ID には、Box アカウントからアクセスできます。

秘密鍵と秘密鍵パスワードには、ダウンロードした Private keypair.json ファイルからアクセスできます。詳細については、公開鍵と秘密鍵のペアに関する情報をご覧ください。また、秘密鍵のパスワードを渡す前に、json ファイルの \n を新しい行に置き換えます。

OAuth 認証コードの接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ Box
コネクタのバージョン 1
接続名 box-conn
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
なりすましユーザーモード ユーザー
承認 OAuth 2.0 - 認証コード
ノードの最小数 2
ノードの最大数 2
クライアント ID XXXX
スコープ root_readwrite
クライアント シークレット XXXX
シークレット バージョン 1

Box OAuth の構成については、OAuth アプリケーションを作成するをご覧ください。

Box JSON for JWT Auth メソッドの接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ Box
コネクタのバージョン 1
接続名 gcp-box-conn-new
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
なりすましユーザーモード ユーザー
As User Id XXXX
ノードの最小数 2
ノードの最大数 2
認証 Box JSON
Box JSON for JWT Auth XXXX
シークレット バージョン 1

Box アカウントを使用して、JWT 認証用の Box Json を設定できます。JWT 用の Box JSON を設定する方法については、JWT トークンの作成手順をご覧ください。

ダウンロードした Private keypair.json ファイルから、JWT 認証値の Box JSON にアクセスします。詳細については、公開鍵と秘密鍵のペアに関する情報をご覧ください。.json ファイルの内容全体を [Box JSON for JWT Auth] フィールドに渡す必要があります。

OAuth Client Credentials の接続タイプ

フィールド名 詳細
ロケーション us-central1
コネクタ Box
コネクタのバージョン 1
接続名 oauth-clientcred-conn
Cloud Logging を有効にする ○
サービス アカウント XXXX@serviceaccount
なりすましユーザーモード ユーザー
As User Id XXXX
ノードの最小数 2
ノードの最大数 2
認証 OAuth クライアント認証情報
OAuth クライアント ID XXXX
OAuth クライアント シークレット XXXX
シークレット バージョン 1
サブジェクト ID XXXX
Box アプリケーションのアクセスレベル エンタープライズ

クライアント ID、クライアント シークレット、Box アプリケーションのアクセスレベル、エンタープライズ ID / ユーザー ID には、Box アカウントからアクセスできます。

認証コードの再認可

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

  1. [接続] ページで必要な接続をクリックします。

    これにより、[接続の詳細] ページが開きます。

  2. [編集] をクリックして、接続の詳細を編集します。
  3. [認証] セクションで [OAuth 2.0 - 認証コード] の詳細を確認します。

    必要に応じて必要な変更を加えます。

  4. [保存] をクリックします。接続の詳細ページに移動します。
  5. [認証] セクションで [承認の編集] をクリックします。これにより、[承認] ペインが表示されます。
  6. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

接続作成後の追加手順

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

  1. 接続ページで、新しく作成された接続を見つけます。

    新しいコネクタの [ステータス] は [承認が必要] になります。

  2. [承認が必要] をクリックします。

    これにより、[承認の編集] ペインが表示されます。

  3. [リダイレクト URI] の値を外部アプリケーションにコピーします。
  4. 認可の詳細を確認します。
  5. [Authorize（承認）] をクリックします。

    認可が成功すると、[接続] ページの接続ステータスが「有効」に設定されます。

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

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

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

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

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

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

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

アクション

このセクションでは、Box 接続でサポートされているすべてのアクションを一覧表示します。

DownloadFile アクション

このアクションを行うと、Box インスタンスからファイルをダウンロードできます。

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

パラメータ名 データ型 必須 説明
FileID 文字列 ○ ダウンロードするファイルの ID。
HasBytes ブール値 ○ ファイルを文字列としてダウンロードするか、Base64 でエンコードされた文字列としてダウンロードするかを指定します。

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

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

パラメータ名 データ型 説明
Success 文字列 ファイルのダウンロードが成功したかどうかを指定します。
ContentBytes 文字列 ファイルの内容（Base64 でエンコードされた文字列）。

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

UploadFile アクション

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

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

パラメータ名 データ型 必須 説明
ParentID 文字列 ○ ファイルをアップロードするフォルダの ID。このパラメータが指定されていない場合、ファイルは Box アカウントのルートにアップロードされます。デフォルト値は 0 です。
Content 文字列 ○ アップロードするファイルの内容。

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

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

パラメータ名 データ型 説明
Success 文字列 ファイルのアップロードが成功したかどうかを示します。
ID 文字列 新しく作成されたファイルの ID。
VersionID 文字列 ファイルの特定のバージョンの ID。
ハッシュ 文字列 ファイルの SHA1 ハッシュ。
etag 文字列 ファイルまたはフォルダの Etag 値。デフォルト値は 0 です。

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

CopyFile アクション

このアクションを行うと、Box インスタンスからファイルをコピーできます。

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

パラメータ名 データ型 必須 説明
FileID 文字列 ○ コピーするファイルの ID。
DestinationFolderId 文字列 × ファイルのコピー先のフォルダの ID。値を指定しない場合は、ファイルの最新バージョンがコピーされます。
NewName 文字列 ○ コピーしたファイルの新しいファイル名。

CopyFile アクションの出力パラメータ

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

パラメータ名 データ型 説明
Success 文字列 ファイルのコピーが成功したかどうかを示します。
ID 文字列 コピーしたファイルの ID。

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

CopyFolder アクション

このアクションでは、Box インスタンスからフォルダ全体をコピーできます。

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

パラメータ名 データ型 必須 説明
FolderID 文字列 ○ コピーするフォルダの ID。
DestinationFolderId 文字列 ○ フォルダのコピー先のフォルダの ID。
NewName 文字列 × コピーしたフォルダの新しいファイル名。

CopyFolder アクションの出力パラメータ

このアクションは、結果を示すレスポンスの本文でステータス 200（OK）を返します。

パラメータ名 データ型 説明
Success 文字列 フォルダのコピーが成功したかどうかを示します。
ID 文字列 コピーしたフォルダの ID。

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

アクションの例

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

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

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

    4. この例では、ファイルを Base64 でエンコードされた文字列としてダウンロードします。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

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

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

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

    4. この例では、文字列コンテンツをファイルとしてアップロードします。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": "true",
"ID": "1283902965389",
"VersionID": "1403546001389",
"Hash": "8cb2237d0679ca88db6464eac60da96345513964",
"Etag": "0"
}]

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

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

    4. この例では、ID が 1288751886061 のファイルを ID が 219105724517 のフォルダにコピーします。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": "true",
"ID": "1308006018536"
}]

例 - フォルダをコピーする

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

    4. この例では、ID が 218475301279 のフォルダを ID が 219105724517 のフォルダにコピーします。アクションが成功すると、コネクタタスクの connectorOutputPayload レスポンス パラメータの値は次のようになります。

    [{
"Success": "true",
"ID": "226312444517"
}]

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

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

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Files を選択します。
  3. [LIST] オペレーションを選択し、[完了] をクリックします。

LIST オペレーションは、Folders、TrashedItems、SharedItems、Collaborations、TaskAssignments、Tasks のエンティティに対して実行できます。

例 - ファイルを取得する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Files を選択します。
  3. [GET] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を 1262397830475 に設定します。これは渡されるキーです。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] に 1262397830475 を入力します。

エンティティ ID の値は、1262397830475 など、直接渡す必要があります。ここで、1262397830475 は一意の主キー値です。

GET オペレーションは、Folders、SharedItems、Collaborations、TaskAssignments、Tasks のエンティティに対して実行できます。

例 - ファイルを削除する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Files を選択します。
  3. [DELETE] オペレーションを選択し、[完了] をクリックします。
  4. エンティティ ID を 1258725940971 に設定します。これは渡されるキーです。エンティティ ID を設定するには、[コネクタ] タスクの [タスク入力] セクションで [EntityId] をクリックし、[デフォルト値] に 1258725940971 を入力します。

    または、エンティティに 2 つの複合ビジネスキーまたは主キーがある場合、entityId を指定する代わりに、filterClause を Id='1258725940971' に設定することもできます。

DELETE オペレーションは、Folders、Tasks、Collaborations、SharedItems、TaskAssignments のエンティティに対して実行できます。

例 - フォルダを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Folders を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Name": "Google Cloud Platforms_created_folders",
"ParentId": "0"
}

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

     
{
"Id": "222269371053"
}

例 - コラボレーションを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Collaborations を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"ItemId": "216592737829",
"ItemType": "folder",
"AccessibleById": "27370766275",
"AccessibleByType": "user",
"AccessibleByLogin": "sunita.venkata@bristlecone.com",
"Role": "editor"
}

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

     
{
"Success": false
}

例 - タスクを作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Tasks を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"ItemId": "1253997361112",
"ItemType": "file",
"Action": "review",
"Message": "Creating a task from Google Cloud Platform",
"DueAt": "2023-12-12 09:01:15.0",
"CompletionRule": "all_assignees"
}

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

     
{
"Id": "1253997361112"
}

例 - taskassignments を作成する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから TaskAssignments を選択します。
  3. [Create] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"TaskId": "21507516872",
"AssignedToId": "27370766275"
}

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

     
{
"Id": "50804351753"
}

例 - ファイルを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Files を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Name": "Get Started with Box Files.pdf"
}
  5. エンティティ ID を 1253997361112 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「1253997361112」と入力します。

    [entityId] を指定する代わりに、[filterClause] を 1253997361112 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
"Id": "1253997361112"
}

UPDATE オペレーションは、Folders、Tasks、Collaborations、SharedItems、TaskAssignments のエンティティに対して実行できます。

例 - フォルダを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Folders を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Name": "Demo Update"
}
  5. エンティティ ID を 216457668125 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「216457668125」と入力します。

    [entityId] を指定する代わりに、[filterClause] を 216457668125 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
"Id": "216457668125"
}

例 - コラボレーションを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Collaborations を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Role": "Viewer"
}
  5. エンティティ ID を 46685648757 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「46685648757」と入力します。

    [entityId] を指定する代わりに、[filterClause] を 46685648757 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {

}

例 - タスクを更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Tasks を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Message": "This is a new task is updated and assigned to you by me"
}
  5. エンティティ ID を 21507516872 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「21507516872」と入力します。

    [entityId] を指定する代わりに、[filterClause] を 21507516872 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
"Id": "21507516872"
}

例 - taskassignments を更新する

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから TaskAssignments を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Message": "Looks good to me",
"ResolutionState": "completed"
}
  5. エンティティ ID を 49542929469 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「49542929469」と入力します。

    [entityId] を指定する代わりに、[filterClause] を 49542929469 に設定することもできます。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
"Id": "49542929469"
}

例 - Transferfolders

  1. [Configure connector task] ダイアログで、[Entities] をクリックします。
  2. Entity リストから Folders を選択します。
  3. [Update] オペレーションを選択し、[完了] をクリックします。
  4. [コネクタ] タスクの [タスク入力] セクションで、connectorInputPayload をクリックし、Default Valueフィールドに次のような値を入力します。 
    {
"Name": "Demo Update"
"ParentId": "216596059374"
}
  5. エンティティ ID を 216457668125 に設定します。エンティティ ID を設定するには、[エンティティ ID] をクリックし、[デフォルト値] フィールドに「216457668125」と入力します。

    この例を実行すると、コネクタ タスクの connectorOutputPayload 出力変数で次のようなレスポンスが返されます。

    {
"Id": "216457668125"
}

Terraform を使用して接続を作成する

Terraform リソースを使用して、新しい接続を作成できます。

Terraform 構成を適用または削除する方法については、基本的な Terraform コマンドをご覧ください。

接続作成用の Terraform テンプレートのサンプルを表示するには、サンプル テンプレートをご覧ください。

Terraform を使用してこの接続を作成する場合は、Terraform 構成ファイルで次の変数を設定する必要があります。

パラメータ名 データ型 必須 説明
impersonate_user_mode ENUM True ユーザーのなりすましのタイプを指定します。ユーザーモードか管理モードかを指定します。サポートされている値は、User、Admin です。
proxy_enabled BOOLEAN False 接続用のプロキシ サーバーを構成するには、このチェックボックスをオンにします。
proxy_auth_scheme ENUM False ProxyServer プロキシへの認証に使用する認証タイプです。サポートされている値は、BASIC、DIGEST、NONE です。
proxy_user STRING False ProxyServer プロキシへの認証に使用されるユーザー名です。
proxy_password SECRET False ProxyServer プロキシの認証に使用されるパスワード。
proxy_ssltype ENUM False ProxyServer プロキシへの接続時に使用する SSL のタイプです。サポートされている値は AUTO、ALWAYS、NEVER、TUNNEL です。

統合で Box 接続を使用する

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

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

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

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

次のステップ