ドライブ - 一覧表示タスク

ドライブ - 一覧表示タスクを使用すると、Google ドライブ アカウントに保存されているファイルやフォルダの検索と取得ができます。

Google ドライブは、共同作業の共有ファイルとフォルダをクラウドに保存し、アクセスするための個人用のストレージを提供するクラウド ファイル ストレージ サービスです。

始める前に

ドライブ - 一覧表示タスクを構成する前に、Google Cloud プロジェクトで次のタスクを行う必要があります。

  1. Google Sheets API（sheets.googleapis.com）を有効にします。

    Google Drive API を有効にする

  2. 認証プロファイルを作成します。Apigee Integration では、認証プロファイルを使用して、ドライブ - 一覧表示タスクの認証エンドポイントに接続します。

    サービス アカウントへの追加のロールや権限の付与については、アクセス権の付与、変更、取り消しをご覧ください。

ドライブ - 一覧表示タスクを構成する

  1. Apigee UI で、Apigee 組織を選択します。
  2. [Develop] > [Integrations] の順にクリックします。
  3. 既存のインテグレーションを選択するか、[Create Integration] をクリックして新しいインテグレーションを作成します。

    新しいインテグレーションを作成する場合:

    1. [Create Integration] ダイアログで名前と説明を入力します。
    2. サポートされているリージョンのリストから、インテグレーションのリージョンを選択します。
    3. [Create] をクリックします。

    インテグレーション デザイナーでインテグレーションが開きます。

  4. 統合デザイナーのナビゲーション バーで、[+ +Add a task/trigger] > [Tasks] の順にクリックして、使用可能なタスクのリストを表示します。
  5. 統合デザイナーで、[Drive - List] 要素をクリックして配置します。
  6. デザイナーで [Drive - List] 要素をクリックして、[Drive - List] タスク構成ペインを表示します。
  7. [Authentication] に移動し、使用する既存の認証プロファイルを選択します。

    省略可。タスクを構成する前に認証プロファイルを作成していない場合は、[+ New authentication profile] をクリックし、新しい認証プロファイルを作成するに記載されている手順に沿って操作します。

  8. [Task Input] に移動し、次の「タスクの入力パラメータ」の表を使用して目的の入力フィールドを構成します。

    入力フィールドの変更は自動的に保存されます。

タスクの入力パラメータ

次の表に、ドライブ - 一覧表示タスクの入力パラメータを示します。

プロパティ データ型 説明
Corpora 文字列 corpora 内のファイルを検索するオプションのパラメータ。
DriveId 文字列 Google 共有ドライブの ID。
IncludeItemsFromAllDrives ブール値 検索結果に個人用ドライブと共有ドライブの両方のアイテムを含める場合は、値を true に設定します。

デフォルト値: false。
IncludeLabels 文字列 レスポンスの labelInfo 部分に含まれるラベル ID のカンマ区切りのリスト。ラベル ID の詳細については、ラベルの概要をご覧ください。
IncludePermissionsForView 文字列 published を指定します。詳しくは、ファイル、フォルダ、ドライブを共有するをご覧ください。
OrderBy 文字列 ファイルを並べ替える順序。

使用できる値は次のとおりです。

  • createdTime
  • folder
  • modifiedByMeTime
  • modifiedTime
  • name
  • name_natural
  • quotaBytesUsed
  • recency
  • sharedWithMeTime
  • starred
  • viewedByMeTime
PageSize 整数 ページごとに返されるファイルの最大数。

有効な値は 1 から 1000 です。

デフォルト値: 100。
PageToken 文字列 前のドライブ - 一覧表示タスクを続行するためのトークン。この値は、前のレスポンスの nextPageToken の値に設定します。
Q 文字列 ファイル結果をフィルタリングするためのクエリ。詳しくは、ファイルを検索するをご覧ください。
Spaces 文字列 コーパス内でクエリするスペースのカンマ区切りのリスト。

指定できる値は drive と appDataFolder です。
SupportsAllDrives ブール値 リクエスト元のアプリケーションがマイドライブと共有ドライブの両方をサポートしている場合は、値を true に設定します。

デフォルト値: false。

タスク出力

ドライブ - 一覧表示タスクは、ファイルのリストを含むレスポンス出力を返します。出力例を次に示します。

  {
    "nextPageToken": string,
    "kind": string,
    "incompleteSearch": boolean,
    "files": [
      {
        object (File)
      }
    ]
  }

エラー処理方法

タスクのエラー処理方法では、一時的なエラーによってタスクが失敗した場合のアクションを指定します。エラー処理方式の使用方法と、さまざまな種類のエラー処理方式の詳細については、エラー処理の方式をご覧ください。

次のステップ

  1. エッジとエッジの条件を追加する。
  2. インテグレーションをテストして公開する。
  3. トリガーを構成する。
  4. データ マッピング タスクを追加する。
  5. Google Cloud サービス向けのすべてのタスクを確認する。