登録経路作成
curl --request POST \
--url https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>"
}
'import requests
url = "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings"
payload = {
"name": "<string>",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tracking_group_id: '<string>',
ads_setting_id: '<string>',
ads_event: '<string>',
auto_label_type: 'none',
auto_label_name: '<string>'
})
};
fetch('https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tracking_group_id' => '<string>',
'ads_setting_id' => '<string>',
'ads_event' => '<string>',
'auto_label_type' => 'none',
'auto_label_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"type": "mail",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>",
"url": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "このアカウントでは種類にlineを指定できません"
}
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "ページが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "入力内容に誤りがあります",
"details": {
"name": [
"管理用タイトルは必須です"
]
}
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}登録経路
登録経路作成
登録経路を作成し、登録用の url を発行します。「登録経路」画面の追加と同じ内容を保存します。
type(種類)はメールの配信アカウントでは mail、LINE の配信アカウントでは line が既定で、他の値は指定できません(400 bad_request)。メール・LINE併用の配信アカウントでは必須です(省略すると 422)。
広告連携(ads_setting_id・ads_event)は省略するとコンバージョンを送信しません。ads_event は広告連携設定の events の value から選びます。
コンバージョンを送信するのは type=line の登録経路で LINE 登録されたときだけです。type=mail の登録経路に指定しても保存されるだけで送信されません(画面でも type=mail では広告連携の欄は表示されません)。
登録時のラベル自動付与(auto_label_type)は、この登録経路で登録された読者に、指定した名前のラベルを付与します。このシナリオの配信アカウントで同じ名前(完全一致)のラベルを探して付与し、無ければ新規に作成して付与します。
登録経路作成
curl --request POST \
--url https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>"
}
'import requests
url = "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings"
payload = {
"name": "<string>",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
tracking_group_id: '<string>',
ads_setting_id: '<string>',
ads_event: '<string>',
auto_label_type: 'none',
auto_label_name: '<string>'
})
};
fetch('https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'tracking_group_id' => '<string>',
'ads_setting_id' => '<string>',
'ads_event' => '<string>',
'auto_label_type' => 'none',
'auto_label_name' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"tracking_group_id\": \"<string>\",\n \"ads_setting_id\": \"<string>\",\n \"ads_event\": \"<string>\",\n \"auto_label_type\": \"none\",\n \"auto_label_name\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "<string>",
"name": "<string>",
"type": "mail",
"tracking_group_id": "<string>",
"ads_setting_id": "<string>",
"ads_event": "<string>",
"auto_label_type": "none",
"auto_label_name": "<string>",
"url": "<string>",
"created_at": "<string>",
"updated_at": "<string>"
}
}{
"error": {
"code": "bad_request",
"message": "このアカウントでは種類にlineを指定できません"
}
}{
"error": {
"code": "unauthorized",
"message": "APIキーが無効です"
}
}{
"error": {
"code": "not_found",
"message": "ページが見つかりません"
}
}{
"error": {
"code": "validation_error",
"message": "入力内容に誤りがあります",
"details": {
"name": [
"管理用タイトルは必須です"
]
}
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "レート制限を超過しました"
}
}POST
https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings
Body
application/json