Sendgrid-nodejs: 動的テンプレートサポートの追加

ドキュメントを更新してください-v3APIで置換が機能しなかった理由を理解するために1時間費やしました。

@ jharris-codeのエクスペリエンスが悪いことをお詫びします。

この問題にあなたの投票を追加して、優先順位を上げるのに役立てました。 PR＃711があるので、もうすぐ更新されると思います。

ドキュメントがないために実際のコードのリリースが妨げられるのは非常にばかげています。

こんにちは@catamphetamine 、

コードはv6.3.1でリリースされ

敬具、

エルマー

@thinkingseriousああ、かっこいい、実際、ライブラリのバージョンを更新することは私の頭を
私はそれを試してみます、thx。

ユーザーへの注意：テンプレートを使用する場合は、 substitutionsではなくdynamic_template_data渡します。

次に、「substitutions：」を「dynamic_template_data：」に変更する必要があります。

また、テンプレートはハンドルバーを使用するため、「substitutionWrappers」を指定する必要はありません。

このユースケースの例では、dynamic_template_dataではなく置換を使用しています。 Plzの更新です。このスレッドを見つけるまでに、SDKで遊んで検索するのに数時間かかりました。 （また、あなたのAPIドキュメントはこれについて何も言及していませんが、それも役に立ちませんでした。
また、substitutionWrappersはdynamic_template_dataではまったく機能しないようです。 メッセージオブジェクトにキーと値のペアsubstitutionWrappers: ['*|', '|*']を含めるかどうかに関係なく、中括弧で囲まれたテンプレート変数のみが入力されました（テンプレートにハンドルバー構文を使用するように意図的に強制しているのですか？）

謝罪@ josh-yonomi、

フィードバックに基づいてドキュメントを更新しました。

新しいテンプレートでは、ハンドルバー構文を使用します。 従来のテンプレートは以前と同じように機能します。

敬具、

エルマー

メールを受け取りましたが、置換が機能しません。 何が問題を引き起こす可能性がありますか？

const msg = {
    to: email,
    from: sendGridMail,
    templateId: emailTemplate.confirmationEmail,
    dynamic_template_data: {
      firstName: firstName,
      lastName: lastName,
      link: link
    }
  };

@thinkingserious経由EDIT

問題がどこにあるか教えていただけませんか？ 私たちはあなたの欲求不満を理解して、私たちが改善できるようにしたいと思っています。

@ drav96 、

テンプレートがどのように見えるかを共有してもよろしいですか？

敬具、

エルマー

なぜsubstitutionWrappersで特別な文字を削除するのですか？

dynamic_template_data: {
      'foo-bar': 'wtf',
      'bar_baz': 'wtf',
      'baz.bro': 'wtf',
      'foo': 'wtf'
    }

{{foo}}のみが電子メールでwtf文字列を返します。

@larafaleはわかりませんが、それは確かに合理的ではないようです。 このSDKのソースコードを見ると、これらのキーがどこで変更されているのかわかりません。

この問題について別の問題を作成し、HTMLテンプレートがどのように見えるかを含めてもよろしいですか？ 新しい問題をバグとしてマークし、必要に応じて再現して修正を試みます。

こんにちは、

そのため、動的テンプレートメールを送信しようとしていますが、置換またはdynamic_template_dataを使用できません。
私のテンプレートには{{fullname}}や{{date}}などのタグがあり、これらのプロパティはsend関数に送信されます。

const msg = {
        to,
        from,
        templateId: template.id,
        dynamic_template_data: substitutions,
    };

    return sgMail.send(msg)

substitutionsオブジェクトに適切な値を持つ適切なプロパティがあることを確認しましたが、置換が機能しません。

私が間違っていることについて何か考えはありますか？

ありがとう。

@ gianfelipe93
構造は正しいです。 私も同じ問題を抱えていました。
私の解決策は、プロジェクトから@sendgridパッケージをアンインストールして、再度インストールすること
それがあなたのために働くかどうか私に知らせてください
const msg= { to: email, from: sendGridMail, templateId: emailTemplate.requestDemoEmail, dynamic_template_data: { name: data.name, email: data.email, } };

@ drav96ありがとう、メイト、今は動いている

これにさらに1時間時間を費やした後、私が望むものを追加すると、いくつかの決定的なドキュメントになります。 （まず、私の前で何時間も時間を無駄にしてくれたすべての人に感謝します。）

1. テンプレートIDがd-で始まる場合、 substitutionsは機能しないため、CAMEL-CASE dynamicTemplateDataを使用する必要があります（とにかく、snake_caseキーをcamelCaseに変換するここを参照して
2. テンプレートがd-で始まる場合、 setSubstitutionWrappersは黙って無視されるため、テンプレートで{{と}}を使用する必要があります

これにさらに1時間時間を費やした後、私が望むものを追加すると、いくつかの決定的なドキュメントになります。 （まず、私の前で何時間も時間を無駄にしてくれたすべての人に感謝します。）

1. テンプレートIDがd-で始まる場合、 substitutionsは機能しないため、CAMEL-CASE dynamicTemplateDataを使用する必要があります（とにかく、snake_caseキーをcamelCaseに変換するここを参照して
2. テンプレートがd-で始まる場合、 setSubstitutionWrappersは黙って無視されるため、テンプレートで{{と}}を使用する必要があります

私の場合はそれがで動作しますdynamic_template_dataでもテンプレートIDで手紙を持っている場合d-

はい、それはスネークケースキーで機能しますが、開発者がキャメルケースに内部的にコミットしているように見えます（上記のレポートでリンクした行を参照してください）。 したがって、すべての新しいコードでキャメルケースを使用することをお勧めします。

こんにちは@ kael-shipman、

お手数をおかけしますが、よろしくお願いいたします。

このドキュメントを見た

敬具、

エルマー

@thinkingserious 、状況を改善するためのあなたの理解と意欲に感謝します。 そして、そこに断片的になってすみません。 looooooooooooooong日がありました;）。

とにかく、問題は正しい（っぽい）ドキュメントがどこかに存在するほどではありません、それは多くの古いドキュメントがまだグーグル検索に巻き込まれているということです。 「sendgridテンプレートフィールド」を検索しました（ちょうど今）。最初の非広告結果はこれです。これはすべての兆候によって公式のドキュメントですが、明らかに古くなっています。 それだけでなく、2つの異なる置換形式（ -firstName-と%firstName% ）があり、「使用するものは使用するSDKライブラリに依存する可能性があります」とだけ書かれています。すべてのSDKライブラリがおそらく同じ単一のテンプル（置換タグのスタイルが1つしかない）を指していること。

sendgridでの私の経験では、構築されたものに大いに感謝していますが、このドキュメントの混乱は実際には例外ではなく規則です。 おそらく他のソフトウェアの世界と同じくらい前向きになっていることはわかっていますが、すべてのドキュメントを正規化し、バージョン番号を付けて、何かをするのに1か月ほどかかるといいでしょう。 Googleのトップヒット。

とにかく、ありがとう！

また、リンクしたドキュメントには、スネークケースでdynamic_template_dataれています。それが正しければ、コード自体がキャメルケースに変換しているように見える理由がわかりません。 上記のように、私はスネークケースが機能することを認識していますが、コードを考えると、ドキュメントがそれを使用することを推奨するべきではないようです。

こんにちは@ kael-shipman、

詳細なフィードバックを提供するために時間を割いていただきありがとうございます！

ご提供いただいたリンクに関して、そのドキュメントは、このSDKがサポートするSendGrid v3 REST APIではなく、SendGrid SMTPAPIを参照しています。 そうは言っても、あなたはそれを知っていると期待されるべきではありません。 この問題をドキュメンテーションチームに知らせて、それを明確にする方法があるかどうかを確認します。

最近、オープンソースのドキュメントを更新して

一貫性を保つためにキャメルケースを使用するようにREADMEを修正します。 それをキャッチして私たちの注意を引いてくれてありがとう！

再度感謝し、あなたの詳細なフィードバックに対する感謝の印として、私たちはあなたにいくつかの盗品を提供したいと思います。 楽しみ！

敬具、

エルマー

かっこいい、ありがとう：D

18:09エルマー・トーマスの火、2018年9月18日には[email protected]
書きました：

こんにちは@ kael-shipman https://github.com/kael-shipman 、

詳細なフィードバックを提供するために時間を割いていただきありがとうございます！

あなたが提供したリンクに関して、そのドキュメントは参照されています
このSDKが使用するSendGridv3 REST APIではなく、SendGrid SMTPAPIに
サポートします。 そうは言っても、あなたはそれを知っていると期待されるべきではありません。 私は持っていきます
この問題は、ドキュメンテーションチームが注意を払って、
それを明確にする方法。

最近、オープンソースのドキュメントを更新して再起動しました
https://sendgrid.com/blog/how-to-get-the-most-from-sendgrids-new-knowledge-center/ 。
ナビゲートしやすいと思います。

一貫性を保つためにキャメルケースを使用するようにREADMEを修正します。 についてありがとうございました
それをキャッチして私たちの注意を引く！

もう一度ありがとう、そしてあなたの詳細に対する私たちの感謝の印として
フィードバック、私たちはあなたにいくつかの盗品を提供したいと思います
https://dx.sendgrid.com/swag 。 楽しみ！

敬具、

エルマー

—
あなたが言及されたのであなたはこれを受け取っています。
このメールに直接返信し、GitHubで表示してください
https://github.com/sendgrid/sendgrid-nodejs/issues/703#issuecomment-422588492 、
またはスレッドをミュートします
https://github.com/notifications/unsubscribe-auth/ADUIglZIH2d7imy-H7dekTo5A-v2Xau8ks5ucX0agaJpZM4Vev8b
。

dynamic_template_dataを一般的な電子メール変数で機能させることはできますが、受信者ごとに動的データを追加する必要がある場合はどうなりますか？ 例：注文番号、注文数量など。ドキュメントにはこれの使用例はありませんが、見落としている可能性があります。

ユーザーへの注意：テンプレートを使用する場合は、 substitutionsではなくdynamic_template_data渡します。

@catamphetamine残念ながら、みんなのコードがdynamicTemplateDataで機能しているように見える理由を理解するのに時間がかかりすぎたため、コメントを却下しましたが、私の場合、置換は単に削除されます。 他の人がより良い経験をすることを願っています。

私のバージョン：
"@sendgrid/mail": "^6.3.1"

私にとって、私は次のことをしなければならなかったことがわかりました（人々が言うことの反対）：

// This seems to be the default, however, to avoid unexpected API changes,
// I'd rather set this manually
setSubstitutionWrappers("{{", "}}");

{
      subject: EMAIL_SUBJECT_ONBOARDING,
      templateId: "templateId",
      personalizations: [{
        to,
        // NOT WORKING WITH THIS ❌
        // dynamicTemplateData: {
        //   senderName: EMAIL_FROM_NAME,
        //   senderAddress: "an actual adress",
        // },

        // WORKS WITH THIS ✅
        substitutions: {
            senderName: EMAIL_FROM_NAME,
            senderAddress: "an actual adress",
        },
    }],
}

@thinkingseriousはツールが大好きです。 ドキュメントの改善、エッジケースのカバーなどを続けてください。🎉❤️

アップデート：

@catamphetamineの反対票に感謝します。 setSubstitutionWrappers("{{", "}}");を実行したので、 substitutions機能したのではないかと思いました。 ああ、いや。 何が起こったのかわからないので疲れているかもしれませんが、 dynamicTemplateDataは機能します。 キャメルケースであることに注意してください_（@ kael-shipmanのコメントを参照）_ほとんどの例のスネークケースが表示されます。 また、sendgridにはTSタイプを使用しています。 定義で使用できるsnake_caseキーはありません。

更新2：

利用可能なタイプについて。 PersonalizationJSONタイプでdynamic_template_dataを見つけました。 以下を使用する場合：
import { send } from "@sendgrid/mail";
次に、送信の最初のパラメーターを確認すると、次の定義を持つMailDataが表示されます。

export interface MailData {
  // ...
  personalizations?: PersonalizationData[],
  // ...
}

次に、次の2つのタイプに遭遇します。

export interface PersonalizationData {
  // omitted keys...
  dynamicTemplateData?: { [key: string]: string; };
  customArgs?: { [key: string]: string };
  sendAt?: number;
}

export interface PersonalizationJSON {
  // same omitted keys...
  dynamic_template_data?: { [key: string]: string; };
  custom_args?: { [key: string]: string; };
  send_at?: number;
}

最後に、 dynamic_template_dataが次のように一貫して機能するようになります。

{
    templateId: "d-templateId",
    dynamic_template_data: { name: "elton yet again"}, // <-- either here
    personalizations: [{
        to,
        dynamic_template_data: { name: "Elton again" }, // <-- or here
    }],
}

@thinkingserious明らかに、修正が必要な型定義の問題があります。 後でPRを作成するかもしれません。

わかりました、もう一度調査する必要があります。 今ではdynamicTemplateDataもsubstitutions機能しないので、私はうんざりしています。

アップデート：
いくつかのテーブルをめくりましたが、それを機能させ、以前のコメントを更新しました。

最後に、 dynamic_template_dataが次のように一貫して機能するようになります。

{
    templateId: "d-templateId",
    dynamic_template_data: { name: "elton yet again"}, // <-- either here
    personalizations: [{
        to,
        dynamic_template_data: { name: "Elton again" }, // <-- or here
    }],
}

これは私にとって重要なポイントでした。 toとccの電子メールで異なるトランザクションテンプレートの件名を設定しようとしていました。 上記のように、dynamic_template_dataプロパティをパーソナライズ配列内に配置すると機能しました。

    const msg = {


         personalizations: [
            {
              to: req.body.to,
              dynamic_template_data : {
                subject: "Just to adsf...",
                full_name_from: req.body.full_name_from,
                full_name_to: req.body.full_name_to,
                manager: req.body.manager,
                message: req.body.message,
                badge: req.body.badge,
                badge_image: 'https://asdf' + req.body.badge_image
             }
            },
            {
              to: req.body.manager,
              dynamic_template_data : {
                subject: req.body.full_name_from + ' received a asdf asdf',
                full_name_from: req.body.full_name_from,
                full_name_to: req.body.full_name_to,
                manager: req.body.manager,
                message: req.body.message,
                badge: req.body.badge,
                badge_image: 'https://asdf' + req.body.badge_image
             }
            }
          ]
    };

私のために働いた解決策は、以下に示す正確な方法で、dynamic_template_dataをパーソナライズオブジェクト内に配置することです。

    "personalizations": [
        {
              "dynamic_template_data": {
            "fullname": "full Name",
            "useremail": ":[email protected]",
            "userphone": "56456",
            "usermsg": "tex fdsfgasdf t"
    },
            "to": [
                {
                    "email": "[email protected]"
                }
            ],
            "cc": [
                {
                    "email": "[email protected]"
                }
            ]
        }
]