스마트 캠페인

Last update: Mon May 05 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

주제:

작성 대상:

관리자

Marketo은 스마트 캠페인에서 작업을 수행하기 위한 일련의 REST API를 제공합니다. 이러한 API는 쿼리, 만들기, 복제 및 삭제 옵션을 제공하는 에셋 API에 대한 표준 인터페이스 패턴을 따릅니다. 또한 일괄 캠페인을 예약하거나 트리거 캠페인을 요청하여 스마트 캠페인 실행을 관리할 수 있습니다.

쿼리

스마트 캠페인을 쿼리하는 경우 ID, 이름 및 검색의 자산에 대한 표준 쿼리 형식을 따릅니다.

ID별

ID별 Smart Campaign 가져오기 끝점은 단일 Smart Campaign id을(를) 경로 매개 변수로 사용하고 단일 Smart Campaign 레코드를 반환합니다.

GET /rest/asset/v1/smartCampaign/{id}.json

{
    "success": true,
    "errors": [],
    "requestId": "7883#169838a32f0",
    "warnings": [],
    "result": [
        {
            "id": 1001,
            "name": "Process Bounced Emails",
            "description": "System smart campaign for processing bounced email events",
            "createdAt": "2016-09-10T23:16:19Z+0000",
            "updatedAt": "2016-09-10T23:16:19Z+0000",
            "status": "Never Run",
            "type": "batch",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 1001,
            "flowId": 1001,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1001A1"
        }
    ]
}

이 끝점을 사용하면 result 배열의 첫 번째 위치에 항상 단일 레코드가 있습니다.

이름별

이름별 스마트 캠페인 가져오기 끝점은 단일 스마트 캠페인 name을(를) 매개 변수로 사용하고 단일 스마트 캠페인 레코드를 반환합니다.

GET /rest/asset/v1/smartCampaign/byName.json?name=Test Trigger Campaign

{
    "success": true,
    "errors": [],
    "requestId": "14494#16c886ffa44",
    "warnings": [],
    "result": [
        {
            "id": 1069,
            "name": "Test Trigger Campaign",
            "description": "",
            "createdAt": "2018-02-16T01:34:39Z+0000",
            "updatedAt": "2019-08-13T00:45:21Z+0000",
            "folder": {
                "id": 327,
                "type": "Folder"
            },
            "status": "Inactive",
            "type": "trigger",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 2747,
            "flowId": 1088,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1069A1"
        }
    ]
}

이 끝점을 사용하면 result 배열의 첫 번째 위치에 항상 단일 레코드가 있습니다.

찾아보기

스마트 캠페인 가져오기 끝점은 다른 Asset API 검색 끝점과 동일하게 작동하며 여러 선택적 쿼리 매개 변수가 필터링 기준을 지정할 수 있도록 합니다.

earliestUpdatedAt 및 latestUpdatedAt 매개 변수는 ISO-8601 형식(밀리초 없음)으로 datetimes을(를) 허용합니다. 둘 다 설정된 경우 earliestUpdatedAt가 latestUpdatedAt 앞에 와야 합니다.

folder 매개 변수는 아래에서 검색할 상위 폴더를 지정합니다. 형식은 id 및 type 특성이 포함된 JSON 블록입니다.

maxReturn 매개 변수는 반환할 최대 항목 수를 지정하는 정수입니다. 기본값은 20입니다. 최대값은 200입니다.

offset 매개 변수는 항목 검색을 시작할 위치를 지정하는 정수입니다. maxReturn과(와) 함께 사용할 수 있습니다. 기본값은 0입니다.

isActive 매개 변수는 활성 트리거 캠페인만 반환하도록 지정하는 부울입니다.

GET /rest/asset/v1/smartCampaigns.json?earliestUpdatedAt=2016-09-10T23:15:00-00:00&latestUpdatedAt=2016-09-10T23:17:00-00:00

{
    "success": true,
    "errors": [],
    "requestId": "626#16983a92965",
    "warnings": [],
    "result": [
        {
            "id": 1001,
            "name": "Process Bounced Emails",
            "description": "System smart campaign for processing bounced email events",
            "createdAt": "2016-09-10T23:16:19Z+0000",
            "updatedAt": "2016-09-10T23:16:19Z+0000",
            "status": "Never Run",
            "type": "batch",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 1001,
            "flowId": 1001,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1001A1"
        },
        {
            "id": 1002,
            "name": "Process Unsubscribes",
            "description": "System smart campaign for processing unsubscribe events",
            "createdAt": "2016-09-10T23:16:19Z+0000",
            "updatedAt": "2016-09-10T23:16:19Z+0000",
            "status": "Never Run",
            "type": "batch",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 1002,
            "flowId": 1002,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1002A1"
        }
    ]
}

이 끝점을 사용하면 result 배열에 하나 이상의 레코드가 있습니다.

만들기

스마트 캠페인 만들기 끝점은 두 개의 필수 매개 변수가 있는 application/x-www-form-urlencoded POST으로 실행됩니다. name 매개 변수는 만들 스마트 캠페인의 이름을 지정합니다. folder 매개 변수는 스마트 캠페인을 만들 부모 폴더를 지정합니다. 형식은 id 및 type 특성이 포함된 JSON 블록입니다.

필요한 경우 description 매개 변수(최대 2,000자)를 사용하여 스마트 캠페인을 설명할 수 있습니다.

POST /rest/asset/v1/smartCampaigns.json

Content-Type: application/x-www-form-urlencoded

name=Smart Campaign 02&folder={"type": "folder","id": 640}&description=This is a smart campaign creation test.

{
    "success": true,
    "errors": [],
    "requestId": "25bc#16c9138f148",
    "warnings": [],
    "result": [
        {
            "id": 1076,
            "name": "Smart Campaign 02",
            "description": "This is a smart campaign creation test.",
            "createdAt": "2019-08-14T17:42:04Z+0000",
            "updatedAt": "2019-08-14T17:42:04Z+0000",
            "folder": {
                "id": 640,
                "type": "Folder"
            },
            "status": "Never Run",
            "type": "batch",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": true,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 5132,
            "flowId": 1095,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1076A1"
        }
    ]
}

업데이트

스마트 캠페인 업데이트 끝점은 application/x-www-form-urlencoded POST으로 실행됩니다. 단일 스마트 캠페인 id을(를) 경로 매개 변수로 사용합니다. name 매개 변수를 사용하여 스마트 캠페인의 이름을 업데이트하거나 description 매개 변수를 사용하여 스마트 캠페인의 설명을 업데이트할 수 있습니다.

POST /rest/asset/v1/smartCampaign/{id}.json

Content-Type: application/x-www-form-urlencoded

name=Smart Campaign 02 Update&description=This is a smart campaign update test.

{
    "success": true,
    "errors": [],
    "requestId": "14b6a#16c924b992f",
    "warnings": [],
    "result": [
        {
            "id": 1076,
            "name": "Smart Campaign 02 Update",
            "description": "This is a smart campaign update test.",
            "createdAt": "2019-08-14T17:42:04Z+0000",
            "updatedAt": "2019-08-14T22:42:04Z+0000",
            "folder": {
                "id": 640,
                "type": "Folder"
            },
            "status": "Never Run",
            "type": "batch",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": true,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 5132,
            "flowId": 1095,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1076A1"
        }
    ]
}

복제

복제 스마트 POST 끝점은 세 개의 필수 매개 변수가 있는 application/x-www-form-urlencoded 캠페인으로 실행됩니다. 복제할 스마트 캠페인을 지정하는 id 매개 변수, 새 스마트 캠페인의 이름을 지정하는 name 매개 변수 및 새 스마트 캠페인이 만들어지는 상위 폴더를 지정하는 folder 매개 변수를 사용합니다. 형식은 id 및 type 특성이 포함된 JSON 블록입니다.

필요한 경우 description 매개 변수(최대 2,000자)를 사용하여 스마트 캠페인을 설명할 수 있습니다.

POST /rest/asset/v1/smartCampaign/{id}/clone.json

Content-Type: application/x-www-form-urlencoded

name=Test Trigger Campaign Clone&folder={"type": "folder","id": 640}&description=This is a smart campaign clone test.

{
    "success": true,
    "errors": [],
    "requestId": "681d#16c9339499b",
    "warnings": [],
    "result": [
        {
            "id": 1077,
            "name": "Test Trigger Campaign Clone",
            "description": "This is a smart campaign clone test.",
            "createdAt": "2019-08-15T03:01:41Z+0000",
            "updatedAt": "2019-08-15T03:01:41Z+0000",
            "folder": {
                "id": 640,
                "type": "Folder"
            },
            "status": "Inactive",
            "type": "trigger",
            "isSystem": false,
            "isActive": false,
            "isRequestable": false,
            "isCommunicationLimitEnabled": false,
            "recurrence": {
                "weekdayOnly": false
            },
            "qualificationRuleType": "once",
            "workspace": "Default",
            "smartListId": 5135,
            "flowId": 1096,
            "computedUrl": "https://app-sjqe.marketo.com/#SC1077A1"
        }
    ]
}

삭제

스마트 캠페인 삭제 끝점은 단일 스마트 캠페인 id을(를) 경로 매개 변수로 사용합니다.

POST /rest/asset/v1/smartCampaign/{id}/delete.json

{
    "success": true,
    "errors": [],
    "requestId": "d757#16c934216ac",
    "warnings": [],
    "result": [
        {
            "id": 1077
        }
    ]
}

배치

일괄 스마트 캠페인은 특정 시간에 시작되며 특정 리드 세트에 한 번에 영향을 줍니다.

예약

캠페인 예약 끝점을 사용하여 일괄 캠페인을 즉시 또는 미래 날짜에 실행하도록 예약합니다. id 캠페인은 필수 경로 매개 변수입니다. 선택적 매개 변수는 요청 본문에 application/json으로 전달되는 tokens, runAt 및 cloneToProgram입니다.

tokens array 매개 변수는 기존 프로그램 토큰을 재정의하는 My 토큰의 배열입니다. 캠페인 실행 후 토큰이 삭제됩니다. 각 토큰 배열 항목에는 이름/값 쌍이 포함되어 있습니다. 토큰 이름의 형식은 "{{my.name}}"이어야 합니다.

runAt datetime 매개 변수는 캠페인을 실행할 시기를 지정합니다. 지정하지 않으면 끝점이 호출된 후 5분 후에 캠페인이 실행됩니다. datetime 값은 미래까지 2년을 초과할 수 없습니다.

이 API를 통해 예약된 캠페인은 항상 실행 전 최소 5분 동안 대기합니다.

cloneToProgram 문자열 매개 변수에 결과 프로그램의 이름이 포함되어 있습니다. 설정하면 캠페인, 상위 프로그램 및 모든 자산이 결과 새 이름으로 만들어집니다. 상위 프로그램이 복제되고 새로 생성된 캠페인이 예약됩니다. 결과 프로그램은 상위 아래에 만들어집니다. 코드 조각, 푸시 알림, 인앱 메시지, 정적 목록, 보고서 및 소셜 자산이 있는 프로그램은 이러한 방식으로 복제되지 않을 수 있습니다. 이 끝점을 사용하면 하루에 20회 호출로 제한됩니다. 복제 프로그램 끝점이 권장되는 대안입니다.

POST /rest/v1/campaigns/{id}/schedule.json

{
   "input":
      {
         "runAt": "2018-03-28T18:05:00+0000",
         "tokens": [
            {
               "name": "{{my.message}}",
               "value": "Updated message"
            },
            {
               "name": "{{my.other token}}",
               "value": "Value for other token"
            }
          ]
      }
}

{
    "requestId": "52b#161d90e1743",
    "result": [
        {
            "id": 3713
        }
    ],
    "success": true
}

트리거

스마트 캠페인 트리거는 트리거된 이벤트를 기반으로 한 번에 한 명에게 영향을 줍니다.

요청

캠페인 요청 끝점을 사용하여 캠페인 흐름을 통해 실행할 트리거 캠페인으로 리드 집합을 전달합니다. 캠페인에는 "웹 서비스 API"를 소스로 하는 "캠페인 요청" 트리거가 있어야 합니다.

이 끝점에는 경로 매개 변수로 캠페인 id이(가) 필요하며 리드 ID가 포함된 정수 배열 매개 변수 leads이(가) 필요합니다. 호출당 최대 100개의 리드가 허용됩니다.

선택적으로 tokens 배열 매개 변수를 사용하여 캠페인의 상위 프로그램에 로컬인 내 토큰을 재정의할 수 있습니다. tokens은(는) 최대 100개의 토큰을 허용합니다. 각 tokens 배열 항목에는 이름/값 쌍이 있습니다. 토큰 이름의 형식은 "{{my.name}}"이어야 합니다. 전자 메일에 시스템 토큰을 링크로 추가 접근 방식을 사용하여 "viewAsWebpageLink" 시스템 토큰을 추가하는 경우 tokens을(를) 사용하여 재정의할 수 없습니다. 대신 tokens을(를) 사용하여 "viewAsWebPageLink"를 재정의할 수 있는 전자 메일에 웹 페이지로 보기 링크를 추가 방법을 사용하십시오.

leads 및 tokens 매개 변수가 요청 본문에 application/json으로 전달됩니다.

POST /rest/v1/campaigns/{id}/trigger.json

{
   "input":
      {
         "leads" : [
            {
               "id" : 318592
            },
            {
               "id" : 318593
            }
         ],
         "tokens" : [
            {
               "name": "{{my.message}}",
               "value": "Updated message"
            },
            {
               "name": "{{my.other token}}",
               "value": "Value for other token"
            }
         ]
      }
}

{
    "requestId": "9e01#161d922f1aa",
    "result": [
        {
            "id": 3712
        }
    ],
    "success": true
}

활성화

스마트 캠페인 활성화 끝점은 간단합니다. id 경로 매개 변수가 필요합니다. 활성화가 성공하려면 캠페인에 대해 다음 내용이 충족되어야 합니다.

비활성화해야 함
하나 이상의 트리거와 흐름 단계가 있어야 합니다.
오류를 사용하지 않는 트리거, 필터 및 흐름 단계가 있어야 합니다.

POST /rest/asset/v1/smartCampaign/{id}/activate.json

{
    "success": true,
    "errors": [],
    "requestId": "a33a#161d9c0dcf3",
    "result": [
        {
            "id": 1069
        }
    ]
}

비활성화

스마트 캠페인 비활성화는 간단합니다. id 경로 매개 변수가 필요합니다. 비활성화가 성공하려면 캠페인이 활성화되어야 합니다.

POST /rest/asset/v1/smartCampaign/{id}/deactivate.json

{
    "success": true,
    "errors": [],
    "requestId": "6228#161d9c29fbf",
    "result": [
        {
            "id": 1069
        }
    ]
}

recommendation-more-help

bb269a6d-047a-4bf7-9acd-23ad9a63dc59