이 페이지는 기존 대상 구성을 업데이트하는 데 사용할 수 있는 API 요청 및 페이로드를 다음과 같이 예시합니다. /authoring/destinations
API 엔드포인트.
프로덕션/공용 대상에 대한 모든 업데이트 작업은 를 사용한 후에만 표시됩니다. API 게시 Adobe 검토를 위해 업데이트를 제출합니다.
대상 구성의 기능에 대한 자세한 설명은 다음 문서를 참조하십시오.
Destination SDK에서 지원하는 모든 매개변수 이름 및 값은 다음과 같습니다. 대소문자 구분. 대소문자 구분 오류를 방지하려면 설명서에 표시된 대로 매개 변수 이름과 값을 정확히 사용하십시오.
계속하기 전에 다음을 검토하십시오. 시작 안내서 필수 대상 작성 권한 및 필수 헤더를 가져오는 방법을 포함하여 API를 성공적으로 호출하기 위해 알아야 하는 중요한 정보입니다.
다음을 업데이트할 수 있습니다. 기존 다음을 수행하여 대상 구성: PUT
에 대한 요청 /authoring/destinations
업데이트된 페이로드가 있는 엔드포인트.
API 끝점: platform.adobe.io/data/core/activation/authoring/destinations
기존 대상 구성 및 해당 구성 가져오기 {INSTANCE_ID}
, 다음에 대한 문서 참조: 대상 구성 검색.
API 형식
PUT /authoring/destinations/{INSTANCE_ID}
매개변수 | 설명 |
---|---|
{INSTANCE_ID} |
업데이트할 대상 구성의 ID입니다. 기존 대상 구성 및 해당 구성 가져오기 {INSTANCE_ID} , 참조 대상 구성 검색. |
다음 요청은에서 만든 대상을 업데이트합니다. 이 예 다름 filenameConfig
옵션.
curl -X POST https://platform.adobe.io/data/core/activation/authoring/destinations/{INSTANCE_ID} \
-H 'Authorization: Bearer {ACCESS_TOKEN}' \
-H 'Content-Type: application/json' \
-H 'x-gw-ims-org-id: {ORG_ID}' \
-H 'x-api-key: {API_KEY}' \
-H 'x-sandbox-name: {SANDBOX_NAME}' \
-d '
{
"name":"Amazon S3 destination with predefined CSV formatting options",
"description":"Amazon S3 destination with predefined CSV formatting options",
"status":"TEST",
"customerAuthenticationConfigurations":[
{
"authType":"S3"
}
],
"customerEncryptionConfigurations":[
],
"customerDataFields":[
{
"name":"bucket",
"title":"Enter the name of your Amazon S3 bucket",
"description":"Amazon S3 bucket name",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false
},
{
"name":"path",
"title":"Enter the path to your S3 bucket folder",
"description":"Enter the path to your S3 bucket folder",
"type":"string",
"isRequired":true,
"pattern":"^[A-Za-z]+$",
"readOnly":false,
"hidden":false
},
{
"name":"compression",
"title":"Compression format",
"description":"Select the desired file compression format.",
"type":"string",
"isRequired":true,
"readOnly":false,
"enum":[
"SNAPPY",
"GZIP",
"DEFLATE",
"NONE"
]
},
{
"name":"fileType",
"title":"File type",
"description":"Select the exported file type.",
"type":"string",
"isRequired":true,
"readOnly":false,
"hidden":false,
"enum":[
"csv",
"json",
"parquet"
],
"default":"csv"
}
],
"uiAttributes":{
"documentationLink":"https://www.adobe.com/go/destinations-amazon-s3-en",
"category":"cloudStorage",
"icon":{
"key":"amazonS3"
},
"connectionType":"S3",
"frequency":"Batch"
},
"destinationDelivery":[
{
"deliveryMatchers":[
{
"type":"SOURCE",
"value":[
"batch"
]
}
],
"authenticationRule":"CUSTOMER_AUTHENTICATION",
"destinationServerId":"{{destinationServerId}}"
}
],
"schemaConfig":{
"profileRequired":true,
"segmentRequired":true,
"identityRequired":true
},
"batchConfig":{
"allowMandatoryFieldSelection":true,
"allowDedupeKeyFieldSelection":true,
"defaultExportMode":"DAILY_FULL_EXPORT",
"allowedExportMode":[
"DAILY_FULL_EXPORT",
"FIRST_FULL_THEN_INCREMENTAL"
],
"allowedScheduleFrequency":[
"DAILY",
"EVERY_3_HOURS",
"EVERY_6_HOURS",
"ONCE"
],
"defaultFrequency":"DAILY",
"defaultStartTime":"00:00",
"filenameConfig":{
"allowedFilenameAppendOptions":[
"SEGMENT_NAME",
"DESTINATION_INSTANCE_NAME",
"ORGANIZATION_NAME",
"SANDBOX_NAME",
"DATETIME",
"CUSTOM_TEXT"
],
"defaultFilenameAppendOptions":[
"DATETIME"
],
"defaultFilename":"%DESTINATION%_%SEGMENT_ID%_%DESTINATION_INSTANCE_ID%,"
},
"backfillHistoricalProfileData":true
}
}'
성공적인 응답은 업데이트된 대상 구성의 세부 정보와 함께 HTTP 상태 200을 반환합니다.
Destination SDK API 엔드포인트는 일반적인 Experience Platform API 오류 메시지 원칙을 따릅니다. 을(를) 참조하십시오 API 상태 코드 및 요청 헤더 오류 플랫폼 문제 해결 안내서에서 확인할 수 있습니다.
이제 이 문서를 읽고 Destination SDK을 통해 대상 구성을 업데이트하는 방법을 배웁니다 /authoring/destinations
API 엔드포인트.
이 끝점으로 수행할 수 있는 작업에 대한 자세한 내용은 다음 문서를 참조하십시오.