# Sendgrid Export Integration

SendGridは、クラウドベースのSMTPプロバイダーで、メールサーバーを維持することなくメールを送信できます。Treasure Dataの統合により、すべてのマーケティングメールキャンペーンのためにプロファイルセグメントをSendgridに簡単にエクスポートできます。

## 前提条件

- Treasure Dataの基本知識
- Sendgrid JSONメールテンプレートの知識


## 要件と制限事項

Sendgridコネクタ機能を使用する際には、いくつかのレート制限と制約があります: **Mail Send**および**Send Test Marketing Mail**。

- 添付ファイルを含むメールの合計サイズは、30MB未満である必要があります。
- 受信者の合計数は1000以下である必要があります。これには、personalizationsアレイに含める各オブジェクト全体のto、cc、およびbccパラメータ内で定義されたすべての受信者が含まれます。
- カスタム引数の合計長は10000バイト未満である必要があります。
- fromフィールドではUnicodeエンコーディングはサポートされていません。
- to.name、cc.name、およびbcc.nameのパーソナライゼーションには、`;`または`,`文字を含めることはできません。
- 置換の場合、NULL値は""（空文字列）に切り捨てられます。置換が数値列の場合は、文字列に変換されます。
- メッセージはバッチで送信されるため、セッション全体をロールバックしません。エラーメッセージはコンソールにログ記録されますが、ジョブは続行されます。
- Sendgrid JSONメールテンプレートに関する強力な知識が**必須**です。
- **Mail Send**操作では:
  - **Template ID**は、Personalization Bodyで定義された**substitution**を上書きします。
  - **Skip invalid records**は、無効なpersonalization bodyにのみ適用されます。
- **Send Test Marketing Mail**操作では:
  - **Unsubscribe URL**または**Suppression group ID**のいずれかのみを入力する必要があります。
  - **Skip invalid records**は無効なメールに適用されます。


## Sendgrid APIキーの取得

Sendgridアプリケーションへの接続を確立するには、APIキーが必要です。

アプリケーション、メールクライアント、またはWebサイトはすべて、API（Application Programming Interface）キーを使用してSendGridサービスへのアクセスを認証できます。SendGridのすべてのサービスに接続するためにAPIキーを使用することをお勧めします。これらは、ユーザー名とパスワードを使用するよりも推奨される代替手段です。なぜなら、APIキーはユーザー名とパスワードを変更することなく、いつでも取り消すことができるためです。

Sendgrid APIキーには以下が含まれます:

- **Full Access**は、APIキーが請求とメールアドレス検証を除くアカウントのすべての部分のGET、PATCH、PUT、DELETEおよびPOSTエンドポイントにアクセスできるようにします。
- **Restricted Access**は、請求とメールアドレス検証を除くアカウントのすべての部分のアクセスレベルをカスタマイズします。
- **Billing Access**は、APIキーがアカウントの請求エンドポイントにアクセスできるようにします。


Sendgrid内で:

1. 左側のナビゲーションバーの**Settings**に移動します。
2. **API Keys**を選択します。
3. Treasure Dataへの接続に使用する必要があるAPIキーの値をコピーまたは書き留めます。


## TD Consoleを使用して接続を作成

### 新しい接続を作成

Treasure Dataでは、クエリを実行する前にデータ接続を作成して設定する必要があります。データ接続の一部として、統合にアクセスするための認証を提供します。

1. **TD Console**を開きます。
2. **Integrations Hub** > **Catalog**に移動します。
3. Sendgridを検索して選択します。 ![](/assets/image2021-2-26_10-21-36.48cf8543ea916e9de32c8419beffeb54b46d97a5df60d8e5125507e84a28eb52.5a81bb91.png)
4. 認証するための資格情報を入力します。


![](/assets/image2021-2-10_16-45-55.e1a536fbffaa0dc27ef3d26407df0728ddbf80b8c38bdb16aa11b94cc42603c7.5a81bb91.png)

![](/assets/image2021-2-10_16-57-38.39afd2a33247d44a207719dcd20f02dd81dee400397970f7d3ec8fef0e2f0d97.5a81bb91.png)

1. 接続の名前を入力します。
2. **Done**を選択します。


### クエリの定義

1. [Creating a Destination Integration](https://docs.treasuredata.com/display/PD/Creating+a+Destination+Integration)の手順を完了します。
2. **Data Workbench > Queries**に移動します。
3. データをエクスポートするクエリを選択します。
4. クエリを実行して結果セットを検証します。
5. **Export Results**を選択します。
6. 既存の統合認証を選択します。


![](https://docs.treasuredata.com/download/attachments/328524/image2020-12-18_13-44-6.png?version=1&modificationDate=1608327840458&api=v2)

1. 追加のExport Resultsの詳細を定義します。エクスポート統合コンテンツで統合パラメータを確認します。
例えば、Export Results画面が異なる場合や、入力する追加の詳細がない場合があります:


![](https://docs.treasuredata.com/download/attachments/328524/image2023-5-17_14-42-52.png?version=1&modificationDate=1684348721512&api=v2)

1. **Done**を選択します。
2. クエリを実行します。
3. 指定した宛先にデータが移動したことを検証します。


### SendgridのIntegration Parameters

![](/assets/image2021-2-10_16-59-54.dab9bd594d863cd9effa5f4106ee562b5d06cb3623c2263f9ad929cfcb8f2d54.5a81bb91.png)

![](/assets/image2021-2-18_22-21-13.c2c0648aab16ece92af6b1aa79cd1ba53287911216f46f06538c58beee5805cb.5a81bb91.png)

| Parameter  | Req. or Optional  | Description |
|  --- | --- | --- |
| Action | Required | - Send Mail
- Send Test Marketing Mail

 |
| From Email | Required | メール値を次の形式で入力します: name@domain |
| From Name | optional |  |
| Column Name to Send | Required | Send Test Marketing Mailの場合。エクスポートされたクエリ結果から受信者の列名を入力します |
| Personalized Email Body
 | Required
 | 設定されたメールテンプレートを入力します。__column_name__を使用して置換列/エイリアスをマークします。すべての置換列/エイリアスはエクスポートされたデータに含まれている必要があります。
例:

```json
{"personalizations" : [{"to": [{"email": "__email__"}], "subject": "subject test __email__", "substitutions": {"--name--": "meg"}} ]}
```
 |
| Content | Required | 例:
```json
{"content": [
    {
        "type": "text/plain",
        "value": "content root --name--"
    }
]}
```
 |
| Number of Recipients per API Call
 | Required
 | Sendgridへの各リクエスト呼び出しに対して、コネクタはこの数までpersonalizationsボディを構築します
最小: 1、最大: 1000、デフォルト: 1000
例: Export SQLクエリが50,000レコードを返し、デフォルト設定1000の場合、コネクタはSendgridに50リクエストを送信し、リクエストごとに1000のパーソナライゼーションを含めます
 |
| Attachments | optional | JSON文字列 |
| Template ID
 | optional
 | Send Mailの場合はオプション。指定すると、このテンプレートIDはPersonalized email bodyのSubstitutionsを上書きします。
Send Test Marketing Mailの場合は必須。
 |
| Unsubscribe Group ID | optional | 受信者に受け取りたいメールのタイプをより詳細に制御できるようにすることで、特定のグループからのメッセージをオプトアウトできるようにします。 |
| Unsubscribe Url | optional |  |
| Suppression Group ID | optional | 購読解除グループを指定するために使用される方法。 |
| Mail Settings | optional | JSON文字列 |
| Tracking Settings | optional | JSON文字列 |


### クエリ例


```sql
SELECT
  to_email as email
FROM
  email_2_records
```

### (Optional) Schedule Query Export Jobs

You can use Scheduled Jobs with Result Export to periodically write the output result to a target destination that you specify.

Treasure Data's scheduler feature supports periodic query execution to achieve high availability.

When two specifications provide conflicting schedule specifications, the specification requesting to execute more often is followed while the other schedule specification is ignored.

For example, if the cron schedule is `'0 0 1 * 1'`, then the 'day of month' specification and 'day of week' are discordant because the former specification requires it to run every first day of each month at midnight (00:00), while the latter specification requires it to run every Monday at midnight (00:00). The latter specification is followed.

#### Scheduling your Job Using TD Console

1. Navigate to **Data Workbench > Queries**
2. Create a new query or select an existing query.
3. Next to **Schedule**, select None.
![](/assets/image2021-1-15_17-28-51.f1b242f6ecc7666a0097fdf37edd1682786ec11ef80eff68c66f091bc405c371.0f87d8d4.png)
4. In the drop-down, select one of the following schedule options:
![](/assets/image2021-1-15_17-29-47.45289a1c99256f125f4d887e501e204ed61f02223fde0927af5f425a89ace0c0.0f87d8d4.png)
| Drop-down Value | Description |
|  --- | --- |
| Custom cron... | Review [Custom cron... details](#custom-cron-details). |
| @daily (midnight) | Run once a day at midnight (00:00 am) in the specified time zone. |
| @hourly (:00) | Run every hour at 00 minutes. |
| None | No schedule. |


#### Custom cron... Details

![](/assets/image2021-1-15_17-30-23.0f94a8aa5f75ea03e3fec0c25b0640cd59ee48d1804a83701e5f2372deae466c.0f87d8d4.png)

| **Cron Value** | **Description** |
|  --- | --- |
| `0 * * * *` | Run once an hour. |
| `0 0 * * *` | Run once a day at midnight. |
| `0 0 1 * *` | Run once a month at midnight on the morning of the first day of the month. |
| "" | Create a job that has no scheduled run time. |



```
 *    *    *    *    *
 -    -    -    -    -
 |    |    |    |    |
 |    |    |    |    +----- day of week (0 - 6) (Sunday=0)
 |    |    |    +---------- month (1 - 12)
 |    |    +--------------- day of month (1 - 31)
 |    +-------------------- hour (0 - 23)
 +------------------------- min (0 - 59)
```

The following named entries can be used:

- Day of Week: sun, mon, tue, wed, thu, fri, sat.
- Month: jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec.


A single space is required between each field. The values for each field can be composed of:

| Field Value | Example | Example Description |
|  --- | --- | --- |
| A single value, within the limits displayed above for each field. |  |  |
| A wildcard `'*'` to indicate no restriction based on the field. | `'0 0 1 * *'` | Configures the schedule to run at midnight (00:00) on the first day of each month. |
| A range `'2-5'`, indicating the range of accepted values for the field. | `'0 0 1-10 * *'` | Configures the schedule to run at midnight (00:00) on the first 10 days of each month. |
| A list of comma-separated values `'2,3,4,5'`, indicating the list of accepted values for the field. | `0 0 1,11,21 * *'` | Configures the schedule to run at midnight (00:00) every 1st, 11th, and 21st day of each month. |
| A periodicity indicator `'*/5'` to express how often based on the field's valid range of values a schedule is allowed to run. | `'30 */2 1 * *'` | Configures the schedule to run on the 1st of every month, every 2 hours starting at 00:30. `'0 0 */5 * *'` configures the schedule to run at midnight (00:00) every 5 days starting on the 5th of each month. |
| A comma-separated list of any of the above except the `'*'` wildcard is also supported `'2,*/5,8-10'`. | `'0 0 5,*/10,25 * *'` | Configures the schedule to run at midnight (00:00) every 5th, 10th, 20th, and 25th day of each month. |


1. (Optional) You can delay the start time of a query by enabling the Delay execution.


### Execute the Query

Save the query with a name and run, or just run the query. Upon successful completion of the query, the query result is automatically exported to the specified destination.

Scheduled jobs that continuously fail due to configuration errors may be disabled on the system side after several notifications.

(Optional) You can delay the start time of a query by enabling the Delay execution.

## Activate a Segment in Audience Studio

You can also send segment data to the target platform by creating an activation in the Audience Studio.

1. Navigate to **Audience Studio**.
2. Select a parent segment.
3. Open the target segment, right-mouse click, and then select **Create Activation.**
4. In the **Details** panel, enter an Activation name and configure the activation according to the previous section on Configuration Parameters.
5. Customize the activation output in the **Output Mapping** panel.


![](/assets/ouput.b2c7f1d909c4f98ed10f5300df858a4b19f71a3b0834df952f5fb24018a5ea78.8ebdf569.png)

- Attribute Columns
  - Select **Export All Columns** to export all columns without making any changes.
  - Select **+ Add Columns** to add specific columns for the export. The Output Column Name pre-populates with the same Source column name. You can update the Output Column Name. Continue to select **+ Add Columns**to add new columns for your activation output.
- String Builder
  - **+ Add string** to create strings for export. Select from the following values:
    - String: Choose any value; use text to create a custom value.
    - Timestamp: The date and time of the export.
    - Segment Id: The segment ID number.
    - Segment Name: The segment name.
    - Audience Id: The parent segment number.


1. Set a **Schedule**.


![](/assets/snippet-output-connector-on-audience-studio-2024-08-28.a99525173709da1eb537f839019fa7876ffae95045154c8f2941b030022f792c.8ebdf569.png)

- Select the values to define your schedule and optionally include email notifications.


1. Select **Create**.


If you need to create an activation for a batch journey, review [Creating a Batch Journey Activation](/products/customer-data-platform/journey-orchestration/batch/creating-a-batch-journey-activation).

## （オプション）ワークフローでエクスポート結果を設定

Treasure Workflow内で、このデータコネクタを使用してデータをエクスポートすることを指定できます。

詳細については、[Using Workflows to Export Data with the TD Toolbelt](https://api-docs.treasuredata.com/en/tools/cli/api/#workflow-commands)をご覧ください。

### Sendgridのワークフロー例

sendgrifd_marketing_test_mail.dig


```yaml
_export:
  td:
 database: sendgrid_db

+sendgrid_send_mail_task:
  td>: marketing_test_mail.sql
  database: ${td.database}
  result_connection: meg_sendgrid_auth
  result_settings:
  	type: sendgrid
	  action: send_mail
  	from_email: test@treasure-data.com
    from_name: lee
  	personalized_template: |
      {
        "personalizations": [{
        "to": [{
        "email": "__email__"
        }],
        "subject": "Subject in personalization __email__",
        "substitutions": {
        "--name--": "substitution value"
        }
        }]
      }
  	content: |
	    {"content": [
        {
          "type": "text/plain",
          "value": "Hello --name--"
        }
      ]}
    batch_size: 1000
    unsubscribe_group_id: null
    attachment: null
    mail_settings: null
    tracking_settings: null
```

#### for send_test_marketing_mail


```yaml
    type: sendgrid
    action: send_test_marketing_mail
    from_email: meg+sendgrid@treasure-data.com
    from_name: lee
    receiver_column_name: email
    template_id_send_testing: d-d86cc2d8bxx4400e903adf052e53d55a
    unsubscribe_url: null
    suppression_group_id: null
```