Google Cloud Storage 拡張機能

バージョン: 1.2.0

Cloud Storage バケット内のファイルの一覧表示とダウンロード、および署名付き URL の生成が可能です。

ここでは、この拡張機能の構成および使用方法に関するリファレンスを提供します。API プロキシからこの拡張機能を使用する前に、次の操作を行う必要があります。

  1. Cloud Storage バケットを作成する。

  2. バケットにオブジェクトをアップロードする。

  3. Google Cloud Storage 拡張機能を表す GCP サービス アカウントにバケットにアクセスするための権限を付与します。使用するロールの詳細については、Cloud Storage のロールをご覧ください。Cloud Storage の権限の詳細については、Identity and Access Management（IAM）の権限の使用をご覧ください。

  4. GCP Console でサービス アカウント キーを作成します。

  5. 拡張機能の追加と構成を行うときに、構成リファレンスを使用して、生成されたキーの JSON ファイルのコンテンツを使用します。

Cloud Storage について

Cloud Storage は、安全で耐久性のあるスケーラブルなファイル ストレージです。Cloud Storage を使い始めたばかりの場合は、Cloud Storage ドキュメントのクイックスタートをご覧ください。

例

次の例は、ExtensionCallout ポリシーを使用して Cloud Storage 拡張機能アクションのサポートを構成する方法を示しています。

ファイルの一覧表示

次の例では、拡張機能の listFiles アクションでファイルのリストが取得され、配列で返されます。listFiles アクションは入力パラメータを受け取りません。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-Storage-File-List">
    <DisplayName>Get Storage File List</DisplayName>
    <Connector>cloud-storage-extension-example</Connector>
    <Action>listFiles</Action>
    <Input><![CDATA[{}]]></Input>
    <Output parsed="false">storage.filelist.retrieved</Output>
</ConnectorCallout>

レスポンス値は次のようになります。

["example-text.txt","example-image.png"]

次のメッセージ割り当てポリシーは、上記の ExtensionCallout ポリシーからレスポンス値を取得してレスポンス ペイロードにコピーします。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-List">
    <DisplayName>Assign Storage File List</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{storage.filelist.retrieved}</Payload>
    </Set>
</AssignMessage>

ファイルのダウンロード

次の ExtensionCallout ポリシーでは、Google Cloud Storage 拡張機能を使用して、コンテンツが Some example text. のシンプルなテキスト ファイルをダウンロードします。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Download-File">
    <DisplayName>Download File</DisplayName>
    <Connector>cloud-storage-extension-example</Connector>
    <Action>downloadFile</Action>
    <Input><![CDATA[{"fileName": "example-text.txt"}]]></Input>
    <Output>storage.file.retrieved</Output>
</ConnectorCallout>

レスポンス値は次のようになります。

{"content":"Some example text."}

次のメッセージ割り当てポリシーは、拡張機能によって返された値を取得してレスポンス ペイロードにコピーします。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-List">
    <DisplayName>Assign Storage File List</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{storage.file.retrieved}</Payload>
    </Set>
</AssignMessage>

署名付き URL の生成

次の ExtensionCallout ポリシーは、この拡張機能を使用して、指定されたファイルを Cloud Storage バケットからダウンロードするための URL を生成します。URL の有効期限が切れて機能しなくなる日付とともに、ファイルの名前を渡します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-Signed-URL">
    <DisplayName>Get Signed URL</DisplayName>
    <Connector>cloud-storage-extension-example</Connector>
    <Action>generateSignedURL</Action>
    <Input><![CDATA[{
        "fileName" : "example-text.txt",
        "expiresOn" : "2018-08-05"
    }]]></Input>
    <Output>storage.url.retrieved</Output>
</ConnectorCallout>

拡張機能の戻り値は次のようになります。

{"url":"https://storage.googleapis.com/storage-extension-example/example-text.txt?GoogleAccessId=extension-test%40my-test-33333.iam.gserviceaccount.com&Expires=1533427200&Signature=Y1cE1DCHesWeIZILRhdIuDR%2FhzZXZ%2BPeY3J1PUkRiosFYj41itHBWh2%2BTQgH9kI6E8s2mWrVDFU43YR7s8Tm9W5VgWRwh0nXSactQ0xKbkKbGZmCcWxgIscOezc1zc%2Bp7lnXSx1qd4wIlIKVH4KCd9WLx4qB1dLxGNxMKB32tA3dio5IiMXaHEA%2FR2fYc0Pjh45t8L5rilk5pekv7jfd3sfsgdfgfdglkj%2F7E%2FlJ%2B60RnetqV2IDqrc0sVEgSLTpgTbDGU%2Ft3EcitRUFOSdOb5czt7CiIwKAYSmDEFMSNHHiNTWjvLzq4IU%2BCa4Z5aKyvww%3D%3D"}

次のメッセージ割り当てポリシーは、拡張機能によって返された値を取得してレスポンス本文にコピーします。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<AssignMessage async="false" continueOnError="false" enabled="true" name="Assign-Storage-File-URL">
    <DisplayName>Assign Storage File URL</DisplayName>
    <AssignTo type="response" createNew="false"/>
    <Set>
        <Payload contentType="application/json">{storage.url.retrieved}</Payload>
    </Set>
</AssignMessage>

アクション

downloadFile

指定されたファイルをダウンロードします。

リクエスト パラメータ

パラメータ 説明 型 デフォルト 必須
fileName ダウンロードするファイル。 文字列 なし ○

構文

<Input><![CDATA[{"fileName" : "the-file-to-download"}]]></Input>

例

<Input><![CDATA[{"fileName" : "example-text.txt"}]]></Input>

レスポンス

ダウンロードしたファイルの内容を保持するオブジェクトを表す JSON 形式の値。次に例を示します。

{"content":"Some example text."}

listFiles

ダウンロード可能なファイルを一覧表示します。

リクエスト パラメータ

なし

レスポンス

ファイル名の配列。次に例を示します。

["example-text.txt","example-image.png"]

generateSignedURL

バケット内の指定されたファイルの署名付き URL を作成します。この URL を使用してファイルをダウンロードできます。

リクエスト パラメータ

パラメータ 説明 型 デフォルト 必須
fileName 署名付き URL を生成する Cloud Storage オブジェクトの名前。 文字列 なし ○
expiresOn 署名付き URL が期限切れになる日付。 文字列 なし ×

構文

<Input><![CDATA[{
  "fileName" : "file-for-which-to-generate-url",
  "expiresOn" : "date-to-expire-url"
}]]></Input>

例

<Input><![CDATA[{
  "fileName" : "example-text.txt",
  "expiresOn" : "2018-08-05"
}]]></Input>

レスポンス

署名付き URL を生成したオブジェクトを表す JSON 形式の値。例:

{"url":"https://storage.googleapis.com/storage-extension-example/example-text.txt?GoogleAccessId=extension-test%40my-test-33333.iam.gserviceaccount.com&Expires=1533427200&Signature=Y1cE1DCHesWeIZILRhdIuDR%2FhzZXZ%2BPeY3J1PUkRiosFYj41itHBWh2%2BTQgH9kI6E8s2mWrVDFU43YR7s8Tm9W5VgWRwh0nXSactQ0xKbkKbGZmCcWxgIscOezc1zc%2Bp7lnXSx1qd4wIlIKVH4KCd9WLx4qB1dLxGNxMKB32tA3dio5IiMXaHEA%2FR2fYc0Pjh45t8L5rilk5pekv7jfd3sfsgdfgfdglkj%2F7E%2FlJ%2B60RnetqV2IDqrc0sVEgSLTpgTbDGU%2Ft3EcitRUFOSdOb5czt7CiIwKAYSmDEFMSNHHiNTWjvLzq4IU%2BCa4Z5aKyvww%3D%3D"}

構成リファレンス

この拡張機能を API プロキシで使用するように構成してデプロイする場合は、以下のプロパティを使用します。Apigee Console で拡張機能を構成する手順については、拡張機能の追加と構成をご覧ください。

拡張機能の共通プロパティ

すべての拡張機能には次のプロパティがあります。

プロパティ 説明 デフォルト 必須
name この拡張機能に付ける名前。 なし ○
packageName Apigee Edge から提供された拡張機能パッケージの名前。 なし ○
version 拡張機能を構成する拡張機能パッケージのバージョン番号。 なし ○
configuration 追加する拡張機能に固有の構成値。この拡張機能パッケージのプロパティをご覧ください。 なし ○

この拡張機能パッケージに固有のプロパティ

プロパティ 説明 デフォルト 必須
bucketName この拡張機能で操作する GCS バケット。 なし。 ○