Google Cloud Firestore 拡張機能

データの追加

次の ExtensionCallout ポリシーは、freewill@example.com というドキュメントを users コレクションに追加しています。data プロパティでは、新しいドキュメントのフィールドと値を指定しています。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Add-User-Data">
        <DisplayName>Add User Data</DisplayName>
        <Connector>my-cloud-firestore-extension</Connector>
        <Action>setDocument</Action>
        <Input><![CDATA[{
            "colName" : "users",
            "docName" : "freewill@example.com",
            "data" : {
                "firstName": "Will",
                "lastName": "Witman",
                "address": "270-8243 Tempor St.",
                "city": "Fort Worth",
                "region": "TX",
                "postalCode": "86519",
                "email": "freewill@example.com",
                "username": "freewill444"
            }
        }]]></Input>
    </ConnectorCallout>
    

データの取得

次の例では、ExtensionCallout ポリシーが、freewill@example.com ドキュメントの値を users コレクションから取得しています。ここで、<Output> 要素の parsed 属性が false に設定されているため、結果の JSON がオブジェクトとして解析されず、文字列として返されます。詳細については、<Output> 要素リファレンスをご覧ください。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Get-User-Data">
        <DisplayName>Get User Data</DisplayName>
        <Connector>straut-cloud-firestore-extension</Connector>
        <Action>getDocument</Action>
        <Input><![CDATA[{
            "colName" : "users",
            "docName" : "freewill@example.com"
        }]]></Input>
        <Output parsed="false">firestore.userdata.retrieved</Output>
    </ConnectorCallout>
    

次の Assign Message ポリシーは、拡張機能のレスポンスを格納する変数の値を使用して、レスポンス ペイロードを割り当てています。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <AssignMessage name="CopyUserDataToResponse">
        <DisplayName>Copy User Data To Response</DisplayName>
        <AssignTo type="response" createNew="false"/>
        <Set>
            <Payload contentType="application/json">{firestore.userdata.retrieved}</Payload>
        </Set>
    </AssignMessage>
    

データの削除

次の例では、ExtensionCallout ポリシーにより、users コレクションから lizzie@example.com ドキュメントを削除します。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Delete-User-Data">
        <DisplayName>Delete User Data</DisplayName>
        <Connector>my-cloud-firestore-extension</Connector>
        <Action>deleteDocument</Action>
        <Input><![CDATA[{
            "colName" : "users",
            "docName" : "lizzie@example.com"
        }]]></Input>
    </ConnectorCallout>
    

クエリでデータを取得

この例では、ExtensionCallout ポリシーがクエリで cities コレクションを取得しています。クエリの結果は、state フィールドと population フィールドでフィルタリングされています。ここで、<Output> 要素の parsed 属性が false に設定されているため、結果の JSON がオブジェクトとして解析されず、文字列として返されます。詳細については、<Output> 要素リファレンスをご覧ください。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ConnectorCallout async="false" continueOnError="true" enabled="true" name="Query-City-Data">
        <DisplayName>Query City Data</DisplayName>
        <Connector>cloud-firestore-extension</Connector>
        <Action>query</Action>
        <Input><![CDATA[{
            "colName":"cities",
            "queryArray":[
              ["state", "==", "CA"],
              ["population","<",1000000]
            ]
        }]]></Input>
        <Output parsed="false">compound-query-output</Output>
    </ConnectorCallout>
    

次の Assign Message ポリシーは、拡張機能のレスポンスを格納する変数の値を使用して、レスポンス ペイロードを割り当てています。

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <AssignMessage name="CopyQueryResultsToResponse">
        <DisplayName>Copy Query Results To Response</DisplayName>
        <AssignTo type="response" createNew="false"/>
        <Set>
            <Payload contentType="application/json">{firestore.querydata.retrieved}</Payload>
        </Set>
    </AssignMessage>
    

構文

<Input><![CDATA[{
      "colName" : "firestore-collection-name",
      "queryArray" : "queryArray": query-condition-array
    }]]></Input>
    

例

この例では、queryArray パラメータに 2 つの条件を指定しています。これにより、colName パラメータで指定した cities 条件のフィルタリングを行います。

複数の条件を含むクエリは、Cloud Firestore で複合インデックスによってサポートされる必要があります。詳細については、Cloud Firestore でのインデックス タイプをご覧ください。

<Input><![CDATA[{
      "colName":"cities",
      "queryArray":[["state", "==", "CA"],["population","<",1000000]]
    }]]></Input>
    

このアクションは、ランタイムに次のようなクエリとして解釈されます。

state = 'CA' で population < 1000000 の条件満たすすべての都市を選択します。