Flow Service API를 사용하여 대상 데이터 흐름 업데이트

이 자습서에서는 대상 데이터 흐름을 업데이트하는 단계를 설명합니다. 데이터 흐름을 활성화 또는 비활성화하거나, 기본 정보를 업데이트하거나, Flow Service API. Experience Platform UI를 사용하여 대상 데이터 흐름 편집에 대한 자세한 내용은 활성화 흐름 편집.

시작하기

이 자습서에서는 유효한 흐름 ID가 있어야 합니다. 유효한 흐름 ID가 없는 경우, 대상 카탈로그 및 다음에 요약된 단계를 따릅니다. 대상에 연결데이터 활성화 이 자습서를 시작하기 전에

노트

용어 흐름데이터 흐름 는 이 자습서에서 서로 교환하여 사용됩니다. 이 자습서의 컨텍스트에서 는 동일한 의미를 갖습니다.

또한 이 자습서에서는 Adobe Experience Platform의 다음 구성 요소를 이해하고 있어야 합니다.

  • 대상: Destinations 는 Adobe Experience Platform에서 데이터를 원활하게 활성화할 수 있도록 대상 플랫폼과의 사전 구축된 통합입니다. 대상을 사용하여 크로스 채널 마케팅 캠페인, 이메일 캠페인, 타겟팅 광고 및 기타 많은 사용 사례에 대해 알려진 데이터와 알 수 없는 데이터를 활성화할 수 있습니다.
  • 샌드박스: Experience Platform은 디지털 경험 애플리케이션을 개발하고 발전시키는 데 도움이 되는 단일 플랫폼 인스턴스를 별도의 가상 환경으로 분할하는 가상 샌드박스를 제공합니다.

다음 섹션에서는 를 사용하여 데이터 흐름을 성공적으로 업데이트하려면 알아야 하는 추가 정보를 제공합니다 Flow Service API.

샘플 API 호출 읽기

이 자습서에서는 요청 형식을 지정하는 방법을 보여주는 예제 API 호출을 제공합니다. 여기에는 경로, 필수 헤더 및 올바른 형식의 요청 페이로드가 포함됩니다. API 응답으로 반환되는 샘플 JSON도 제공됩니다. 샘플 API 호출에 대한 설명서에 사용된 규칙에 대한 자세한 내용은 예제 API 호출을 읽는 방법 Experience Platform 문제 해결 안내서에서 을 참조하십시오.

필수 헤더에 대한 값을 수집합니다

플랫폼 API를 호출하려면 먼저 를 완료해야 합니다 인증 자습서. 인증 자습서를 완료하면 아래와 같이 모든 Experience Platform API 호출에서 각 필수 헤더에 대한 값을 제공합니다.

  • Authorization: Bearer {ACCESS_TOKEN}
  • x-api-key: {API_KEY}
  • x-gw-ims-org-id: {ORG_ID}

에 속하는 리소스를 포함하여 Experience Platform의 모든 리소스 Flow Service은 특정 가상 샌드박스로 구분됩니다. Platform API에 대한 모든 요청에는 작업이 수행될 샌드박스의 이름을 지정하는 헤더가 필요합니다.

  • x-sandbox-name: {SANDBOX_NAME}
노트

만약 x-sandbox-name 헤더를 지정하지 않으면 요청이 prod 샌드박스

페이로드(POST, PUT, PATCH)이 포함된 모든 요청에는 추가 미디어 유형 헤더가 필요합니다.

  • Content-Type: application/json

데이터 흐름 세부 정보 보기

대상 데이터 흐름을 업데이트하는 첫 번째 단계는 흐름 ID를 사용하여 데이터 흐름 세부 사항을 검색하는 것입니다. 에 GET 요청을 수행하여 기존 데이터 흐름의 현재 세부 사항을 볼 수 있습니다 /flows 엔드포인트.

API 형식

GET /flows/{FLOW_ID}
매개 변수 설명
{FLOW_ID} 고유 id 검색할 대상 데이터 흐름의 값입니다.

요청

다음 요청은 흐름 ID에 대한 정보를 검색합니다.

curl -X GET \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 해당 버전, 고유 식별자( )를 포함하여 데이터 흐름의 현재 세부 사항을 반환합니다id) 및 기타 관련 정보.

{
   "items":[
      {
         "id":"226fb2e1-db69-4760-b67e-9e671e05abfc",
         "createdAt":"{CREATED_AT}",
         "updatedAt":"{UPDATED_BY}",
         "createdBy":"{CREATED_BY}",
         "updatedBy":"{UPDATED_BY}",
         "createdClient":"{CREATED_CLIENT}",
         "updatedClient":"{UPDATED_CLIENT}",
         "sandboxId":"{SANDBOX_ID}",
         "sandboxName":"prod",
         "imsOrgId":"{ORG_ID}",
         "name":"2021 winter campaign",
         "description":"ACME company holiday campaign for high fidelity customers",
         "flowSpec":{
            "id":"71471eba-b620-49e4-90fd-23f1fa0174d8",
            "version":"1.0"
         },
         "state":"enabled",
         "version":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "etag":"\"8b0351ca-0000-0200-0000-61c4d6700000\"",
         "sourceConnectionIds":[
            "5e45582a-5336-4ea1-9ec9-d0004a9f344a"
         ],
         "targetConnectionIds":[
            "8ce3dc63-3766-4220-9f61-51d2f8f14618"
         ],
         "inheritedAttributes":{
            "sourceConnections":[
               {
                  "id":"5e45582a-5336-4ea1-9ec9-d0004a9f344a",
                  "connectionSpec":{
                     "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"0a82f29f-b457-47f7-bb30-33856e2ae5aa",
                     "connectionSpec":{
                        "id":"8a9c3494-9708-43d7-ae3f-cda01e5030e1",
                        "version":"1.0"
                     }
                  },
                  "typeInfo":{
                     "type":"ProfileFragments",
                     "id":"ups"
                  }
               }
            ],
            "targetConnections":[
               {
                  "id":"8ce3dc63-3766-4220-9f61-51d2f8f14618",
                  "connectionSpec":{
                     "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                     "version":"1.0"
                  },
                  "baseConnection":{
                     "id":"7fbf542b-83ed-498f-8838-8fde0c4d4d69",
                     "connectionSpec":{
                        "id":"0b23e41a-cb4a-4321-a78f-3b654f5d7d97",
                        "version":"1.0"
                     }
                  }
               }
            ]
         },
         "transformations":[
            {
               "name":"GeneralTransform",
               "params":{
                  "profileSelectors":{
                     "selectors":[
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"Email",
                              "operator":"EXISTS",
                              "identity":{
                                 "namespace":"Email"
                              },
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"Email",
                                 "destination":"Email",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"Email",
                                 "destinationXdmPath":"Email"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.firstName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.firstName",
                                 "destination":"person.name.firstName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.firstName",
                                 "destinationXdmPath":"person.name.firstName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"person.name.lastName",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"person.name.lastName",
                                 "destination":"person.name.lastName",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"person.name.lastName",
                                 "destinationXdmPath":"person.name.lastName"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"personalEmail.address",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"personalEmail.address",
                                 "destination":"personalEmail.address",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"personalEmail.address",
                                 "destinationXdmPath":"personalEmail.address"
                              }
                           }
                        },
                        {
                           "type":"JSON_PATH",
                           "value":{
                              "path":"segmentMembership.status",
                              "operator":"EXISTS",
                              "mapping":{
                                 "sourceType":"text/x.schema-path",
                                 "source":"segmentMembership.status",
                                 "destination":"segmentMembership.status",
                                 "identity":false,
                                 "primaryIdentity":false,
                                 "functionVersion":0,
                                 "copyModeMapping":false,
                                 "sourceAttribute":"segmentMembership.status",
                                 "destinationXdmPath":"segmentMembership.status"
                              }
                           }
                        }
                     ],
                     "mandatoryFields":[
                        "Email",
                        "person.name.firstName",
                        "person.name.lastName"
                     ],
                     "primaryFields":[
                        {
                           "identityNamespace":"Email",
                           "fieldType":"IDENTITY"
                        }
                     ]
                  },
                  "segmentSelectors":{
                     "selectors":[
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"9f7d37fd-7039-4454-94ef-2b0cd6c3206a",
                              "name":"Interested in Mountain Biking",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"ONCE",
                                 "startDate":"2021-12-25",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"f52a3785-2e7c-40a7-8137-9be99af7794e",
                              "name":"Birth year 1970",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"DAILY_FULL_EXPORT",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"6caa79b9-39e0-4c37-892b-5061cdca2377",
                              "name":"Account Leads",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"DAILY",
                                 "startDate":"2021-12-23",
                                 "endDate":"2021-12-31",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        },
                        {
                           "type":"PLATFORM_SEGMENT",
                           "value":{
                              "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
                              "name":"Batch export for autumn campaign",
                              "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
                              "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
                              "schedule":{
                                 "frequency":"EVERY_6_HOURS",
                                 "startDate":"2022-01-05",
                                 "endDate":"2022-12-30",
                                 "startTime":"20:00"
                              },
                              "createTime":"1640289901",
                              "updateTime":"1640289901"
                           }
                        }
                     ]
                  }
               }
            }
         ]
      }
   ]

데이터 흐름 이름 및 설명 업데이트

데이터 흐름의 이름과 설명을 업데이트하려면 Flow Service 플로우 ID, 버전 및 사용할 새 값을 제공하는 API입니다.

중요

다음 If-Match PATCH 요청을 만들 때는 헤더가 필요합니다. 이 헤더의 값은 업데이트할 데이터 흐름의 고유한 버전입니다. 태그 값은 데이터 흐름을 성공적으로 업데이트할 때마다 업데이트됩니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

다음 요청은 데이터 흐름의 이름과 설명을 업데이트합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
            {
                "op": "replace",
                "path": "/name",
                "value": "2021/2022 winter campaign"
            },
            {
                "op": "replace",
                "path": "/description",
                "value": "ACME company holiday campaign for high fidelity customers and prospects"
            }
        ]'
속성 설명
op 데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove.
path 업데이트할 흐름의 일부를 정의합니다.
value 매개 변수를 업데이트할 새 값입니다.

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 흐름 활성화 또는 비활성화

데이터 흐름이 활성화되면 프로필을 대상으로 내보냅니다. 데이터 흐름은 기본적으로 활성화되지만 프로필 내보내기를 일시 중지하도록 비활성화할 수 있습니다.

에 POST 요청을 만들어 기존 대상 데이터 흐름을 활성화하거나 비활성화할 수 있습니다 Flow Service 흐름을 업데이트할 API 및 제공 상태입니다.

API 형식

POST /flows/{FLOW_ID}/action?op=enable or disable

요청

다음 요청은 데이터 흐름의 상태를 활성화로 업데이트합니다.

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=enable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

다음 요청은 데이터 흐름의 상태를 비활성화로 업데이트합니다.

curl -X POST \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc/action?op=disable' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 플로우에 세그먼트 추가

대상 데이터 플로우에 세그먼트를 추가하려면 Flow Service 추가할 플로우 ID, 버전 및 세그먼트를 제공하는 API입니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

다음 요청은 기존 대상 데이터 플로우에 새 세그먼트를 추가합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"add",
      "path":"/transformations/0/params/segmentSelectors/selectors/-",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"2d79d0d8-724f-49fc-a09d-d1dec338c93c",
            "name":"Winter 2021/2022 campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%SEGMENT_NAME%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"DAILY_FULL_EXPORT",
            "schedule":{
               "startDate":"2022-01-05",
               "frequency":"DAILY",
               "triggerType": "AFTER_SEGMENT_EVAL",
               "endDate":"2022-03-10"
            }
         }
      }
   }
]'
속성 설명
op 데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove. 데이터 플로우에 세그먼트를 추가하려면 add 작업.
path 업데이트할 흐름의 일부를 정의합니다. 데이터 플로우에 세그먼트를 추가할 때는 예제에 지정된 경로를 사용합니다.
value 매개 변수를 업데이트할 새 값입니다.
id 대상 데이터 플로우에 추가할 세그먼트의 ID를 지정합니다.
name (선택 사항입니다). 대상 데이터 플로우에 추가할 세그먼트 이름을 지정합니다. 이 필드는 필수가 아니므로 이름을 제공하지 않고 대상 데이터 플로우에 세그먼트를 성공적으로 추가할 수 있습니다.
filenameTemplate 대상 배치 대상 전용. 이 필드는 Amazon S3, SFTP 또는 Azure Blob과 같은 배치 파일 내보내기 대상의 데이터 플로우에 세그먼트를 추가할 때만 필요합니다.
이 필드는 대상으로 내보내는 파일의 파일 이름 형식을 결정합니다.
다음 옵션을 사용할 수 있습니다.
  • %DESTINATION_NAME%: 필수입니다. 내보낸 파일에 대상 이름이 포함되어 있습니다.
  • %SEGMENT_ID%: 필수입니다. 내보낸 파일에는 내보낸 세그먼트의 ID가 포함되어 있습니다.
  • %SEGMENT_NAME%: (선택 사항). 내보낸 파일에 내보낸 세그먼트의 이름이 포함됩니다.
  • DATETIME(YYYYMMdd_HHmmss) 또는 %TIMESTAMP%: (선택 사항). 파일에서 Experience Platform으로 생성되는 시간을 포함하려면 이 두 옵션 중 하나를 선택합니다.
  • custom-text: (선택 사항). 이 자리 표시자를 파일 이름의 끝에 추가할 사용자 지정 텍스트로 바꿉니다.

파일 이름 구성에 대한 자세한 내용은 파일 이름 구성 섹션에 나열된 상태로 남아 있습니다.
exportMode 대상 배치 대상 전용. 이 필드는 Amazon S3, SFTP 또는 Azure Blob과 같은 배치 파일 내보내기 대상의 데이터 플로우에 세그먼트를 추가할 때만 필요합니다.
필수입니다. "DAILY_FULL_EXPORT" 또는"FIRST_FULL_THEN_INCREMENTAL"를 선택합니다. 두 옵션에 대한 자세한 내용은 전체 파일 내보내기증분 파일 내보내기 배치 대상 활성화 자습서에서 를 참조하십시오.
startDate 세그먼트가 대상에 프로필 내보내기를 시작할 날짜를 선택합니다.
frequency 대상 배치 대상 전용. 이 필드는 Amazon S3, SFTP 또는 Azure Blob과 같은 배치 파일 내보내기 대상의 데이터 플로우에 세그먼트를 추가할 때만 필요합니다.
필수입니다.
  • 대상 "DAILY_FULL_EXPORT" 내보내기 모드, ONCE 또는 DAILY.
  • 대상 "FIRST_FULL_THEN_INCREMENTAL" 내보내기 모드, "DAILY", "EVERY_3_HOURS", "EVERY_6_HOURS", "EVERY_8_HOURS", "EVERY_12_HOURS".
triggerType 대상 배치 대상 전용. 이 필드는 "DAILY_FULL_EXPORT" 모드 frequency 선택기.
필수입니다.
  • 선택 "AFTER_SEGMENT_EVAL" 을(를) 통해 일별 플랫폼 배치 세분화 작업이 완료된 후 즉시 활성화 작업을 실행할 수 있습니다. 이렇게 하면 활성화 작업이 실행될 때 최신 프로필을 대상으로 내보낼 수 있습니다.
  • 선택 "SCHEDULED" 를 입력하여 고정된 시간에 활성화 작업을 실행합니다. 이렇게 하면 Experience Platform 프로필 데이터를 매일 동시에 내보낼 수 있지만, 내보내는 프로필은 활성화 작업이 시작되기 전에 배치 세그먼테이션 작업이 완료되었는지 여부에 따라 최신 프로필이 아닐 수 있습니다. 이 옵션을 선택할 때는 startTime 를 입력하여 일별 내보내기가 발생해야 하는 시간을 UTC로 나타냅니다.
endDate 대상 배치 대상 전용. 이 필드는 Amazon S3, SFTP 또는 Azure Blob과 같은 배치 파일 내보내기 대상의 데이터 플로우에 세그먼트를 추가할 때만 필요합니다.
선택할 때 해당 사항 없음 "exportMode":"DAILY_FULL_EXPORT""frequency":"ONCE".
세그먼트 구성원이 대상으로 내보내기를 중지하는 날짜를 설정합니다.
startTime 대상 배치 대상 전용. 이 필드는 Amazon S3, SFTP 또는 Azure Blob과 같은 배치 파일 내보내기 대상의 데이터 플로우에 세그먼트를 추가할 때만 필요합니다.
필수입니다. 세그먼트의 구성원이 포함된 파일을 생성하여 대상으로 내보내는 시간을 선택합니다.

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 흐름에서 세그먼트 제거

기존 대상 데이터 플로우에서 세그먼트를 제거하려면 다음 항목에 PATCH 요청을 수행하십시오 Flow Service 제거할 세그먼트의 흐름 ID, 버전 및 색인 선택기를 제공하는 동안 API입니다. 색인화는 다음 시점부터 시작됩니다 0. 예를 들어 아래의 샘플 요청은 데이터 흐름에서 첫 번째 세그먼트와 두 번째 세그먼트를 제거합니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

다음 요청은 기존 대상 데이터 흐름에서 두 개의 세그먼트를 제거합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
{
   "op":"remove",
   "path":"transformations/0/params/segmentSelectors/selectors/0/",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
},
{
   "op":"remove",
   "path":"transformations/0/params/segmentSelectors/selectors/1/",
   "value":{
      "type":"PLATFORM_SEGMENT",
      "value":{
      }
   }
}
]'
속성 설명
op 데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove. 데이터 흐름에서 세그먼트를 제거하려면 remove 작업.
path 세그먼트 선택기의 인덱스를 기반으로 대상 데이터 플로우에서 제거해야 하는 기존 세그먼트를 지정합니다. 데이터 흐름에서 세그먼트 순서를 검색하려면 /flows 엔드포인트 및 검사 transformations.segmentSelectors 속성을 사용합니다. 데이터 흐름에서 첫 번째 세그먼트를 삭제하려면 "path":"transformations/0/params/segmentSelectors/selectors/0/".

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 흐름에서 세그먼트의 구성 요소 업데이트

기존 대상 데이터 플로우에서 세그먼트의 구성 요소를 업데이트할 수 있습니다. 예를 들어 내보내기 빈도를 변경하거나 파일 이름 템플릿을 편집할 수 있습니다. 이렇게 하려면 Flow Service 업데이트할 세그먼트의 흐름 ID, 버전 및 색인 선택기를 제공하는 동안 API를 참조하십시오. 색인화는 다음 시점부터 시작됩니다 0. 예를 들어, 아래 요청은 데이터 흐름의 9번째 세그먼트를 업데이트합니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

기존 대상 데이터 흐름에서 세그먼트를 업데이트할 때는 먼저 GET 작업을 수행하여 업데이트할 세그먼트의 세부 사항을 검색해야 합니다. 그런 다음 업데이트할 필드뿐만 아니라 페이로드의 모든 세그먼트 정보를 제공합니다. 아래 예에서는 파일 이름 템플릿의 끝에 사용자 정의 텍스트가 추가되고 내보내기 예약 빈도가 6시간에서 12시간으로 업데이트됩니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
   {
      "op":"replace",
      "path":"/transformations/0/params/segmentSelectors/selectors/8",
      "value":{
         "type":"PLATFORM_SEGMENT",
         "value":{
            "id":"4c41c318-9e8c-4a4f-b880-877cdd629fc7",
            "name":"Batch export for autumn campaign",
            "filenameTemplate":"%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_custom-text",
            "exportMode":"FIRST_FULL_THEN_INCREMENTAL",
            "schedule":{
               "frequency":"EVERY_12_HOURS",
               "startDate":"2022-01-05",
               "endDate":"2022-01-30",
               "startTime":"20:00"
            },
            "createTime":"1640289901",
            "updateTime":"1640289901"
         }
      }
   }
]'

페이로드의 속성에 대한 설명은 섹션을 참조하십시오 데이터 플로우에 세그먼트 추가.

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 플로우에서 업데이트할 수 있는 세그먼트 구성 요소에 대한 자세한 예는 아래 예를 참조하십시오.

세그먼트 평가 후 예약에서 세그먼트로 세그먼트의 내보내기 모드를 업데이트합니다

 플랫폼 배치 세분화 작업이 완료된 후 지정된 시간에 세그먼트 내보내기가 매일 활성화되지 않도록 업데이트되어 매일 활성화되는 예를 보려면 를 클릭합니다.

세그먼트는 매일 16:00 UTC에 내보내집니다.

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

세그먼트는 일별 배치 세그먼테이션 작업이 완료된 후 매일 내보내집니다.

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "AFTER_SEGMENT_EVAL",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

파일 이름에 추가 필드를 포함하도록 파일 이름 템플릿을 업데이트합니다

 파일 이름에 추가 필드를 포함하도록 파일 이름 템플릿을 업데이트하는 예를 보려면 을 클릭합니다

내보낸 파일에는 대상 이름 및 Experience Platform 세그먼트 ID가 포함되어 있습니다

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

내보낸 파일에는 대상 이름, Experience Platform 세그먼트 ID, Experience Platform에서 파일을 생성한 날짜 및 시간, 파일 끝에 추가된 사용자 지정 텍스트가 포함되어 있습니다.

{
  "type": "PLATFORM_SEGMENT",
  "value": {
    "id": "b1e50e8e-a6e2-420d-99e8-a80deda2082f",
    "name": "12JAN22-AEP-NA-NTC-90D-MW",
    "filenameTemplate": "%DESTINATION_NAME%_%SEGMENT_ID%_%DATETIME(YYYYMMdd_HHmmss)%_%this is custom text%",
    "exportMode": "DAILY_FULL_EXPORT"
    "schedule": {
      "frequency": "DAILY",
      "triggerType": "SCHEDULED",
      "startDate": "2022-01-13",
      "endDate": "2023-01-13",
      "startTime":"16:00"
    },
    "createTime": "1642041770",
    "updateTime": "1642615573"
  }
}

데이터 집합에 프로필 속성 추가

대상 데이터 플로우에 프로필 속성을 추가하려면 Flow Service 추가할 흐름 ID, 버전 및 프로필 속성을 제공하는 API입니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

다음 요청은 기존 대상 데이터 플로우에 새 프로필 속성을 추가합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"add",
    "path":"/transformations/0/params/profileSelectors/selectors/-",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
속성 설명
op 데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove. 데이터 플로우에 프로필 속성을 추가하려면 add 작업.
path 업데이트할 흐름의 일부를 정의합니다. 데이터 플로우에 프로필 속성을 추가할 때 예제에 지정된 경로를 사용합니다.
value.path 데이터 플로우에 추가할 프로필 속성 값입니다.

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

데이터 흐름에서 프로필 속성 제거

기존 대상 데이터 플로우에서 프로필 속성을 제거하려면 Flow Service 제거할 프로필 속성의 흐름 ID, 버전 및 색인 선택기를 제공하는 동안 API입니다. 색인화는 다음 시점부터 시작됩니다 0. 예를 들어 아래의 샘플 요청은 데이터 흐름에서 다섯 번째 프로필 속성을 제거합니다.

API 형식

PATCH /flows/{FLOW_ID}

요청

다음 요청은 기존 대상 데이터 흐름에서 프로필 속성을 제거합니다.

curl -X PATCH \
    'https://platform.adobe.io/data/foundation/flowservice/flows/226fb2e1-db69-4760-b67e-9e671e05abfc' \
    -H 'Authorization: Bearer {ACCESS_TOKEN}' \
    -H 'x-api-key: {API_KEY}' \
    -H 'x-gw-ims-org-id: {ORG_ID}' \
    -H 'x-sandbox-name: {SANDBOX_NAME}'
    -H 'If-Match: "1a0037e4-0000-0200-0000-602e06f60000"' \
    -d '[
    {
    "op":"remove",
    "path":"/transformations/0/params/profileSelectors/selectors/4",
    "value":{
        "type":"JSON_PATH",
        "value":{
            "path":"mobilePhone.status"
        }
    }
    }
]'
속성 설명
op 데이터 흐름을 업데이트하는 데 필요한 작업을 정의하는 데 사용되는 작업 호출입니다. 작업은 다음과 같습니다. add, replace, 및 remove. 데이터 흐름에서 세그먼트를 제거하려면 remove 작업.
path 세그먼트 선택기의 인덱스를 기반으로 대상 데이터 플로우에서 제거해야 하는 기존 프로필 속성을 지정합니다. 데이터 흐름에서 프로필 속성 순서를 검색하려면 다음 항목에 대한 GET 호출을 수행하십시오 /flows 엔드포인트 및 검사 transformations.profileSelectors 속성을 사용합니다. 데이터 흐름에서 첫 번째 세그먼트를 삭제하려면 "path":"transformations/0/params/segmentSelectors/selectors/0/".

응답

성공적인 응답은 플로우 ID와 업데이트된 태그를 반환합니다. 에 GET 요청을 수행하여 업데이트를 확인할 수 있습니다 Flow Service 흐름 ID를 제공하는 동안 API를 사용하여 규칙 세트를 단순화하는 것이 좋습니다.

{
    "id": "2edc08ac-4df5-4fe6-936f-81a19ce92f5c",
    "etag": "\"50014cc8-0000-0200-0000-6036eb720000\""
}

API 오류 처리

이 자습서의 API 엔드포인트는 일반 Experience Platform API 오류 메시지 원칙을 따릅니다. 을(를) 참조하십시오. API 상태 코드요청 헤더 오류 오류 응답 해석에 대한 자세한 내용은 플랫폼 문제 해결 가이드를 참조하십시오.

다음 단계

이 자습서에서는 다음을 사용하여 세그먼트 또는 프로필 속성을 추가 또는 제거하는 등 대상 데이터 흐름의 다양한 구성 요소를 업데이트하는 방법을 알아보았습니다 Flow Service API. 대상에 대한 자세한 내용은 대상 개요.

이 페이지에서는