설명서Identity 서비스 안내서

옵트인 참조 opt-in-reference

Last update: Wed Jul 17 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 주제:

작성 대상:

  • 개발자
  • 사용자
  • 관리자
  • 기본

옵트인 라이브러리 및 구성 설정 참조용 API입니다.

동의 설정은 범주로 옵트인 기능에 제공됩니다.

adobe.OptInCategories = {
    "AAM": "aam",
    "ANALYTICS": "aa",
    "ECID": "ecid",
    "TARGET": "target"
}

옵트인 구성 매개 변수 section-d66018342baf401389f248bb381becbf

이 섹션에서는 API를 사용하여 옵트인을 구성하는 방법을 설명합니다. 대부분의 구성 및 구현은 Experience Platform Launch 확장을 사용하여 수행할 수 있습니다.

옵트인 구성은 전역 getInstance() 개체를 인스턴스화하는 Visitor JavaScript adobe 함수에 제공됩니다. 다음은 옵트인 서비스와 관련된 Visitor JS 구성 목록입니다.

doesOptInApply (boolean or function that evaluates to a boolean):

false인 경우 방문자가 옵트인할 필요가 없음을 나타냅니다. 옵트인 또는 옵트아웃된 범주에 관계없이 Experience Cloud에서 쿠키를 생성합니다. 이 구성은 옵트인을 전체적으로 활성화 또는 비활성화합니다.

preOptInApprovals (Object <adobe.OptInCategories enum: boolean>)

방문자가 구성 기본값이라고 하는 환경 설정을 아직 설정하지 않은 경우 승인 또는 거부할 카테고리를 정의합니다.

previousPermissions (Object<adobe.OptInCategories enum: boolean>)

방문자가 명시적으로 설정한 환경 설정입니다. 이 구성의 권한은 조직 기본값을 덮어씁니다(previousPermissions가 preOptInApprovals를 덮어씀).

isOptInStorageEnabled (boolean)

자사 쿠키(현재 고객의 도메인 내에 있음)에 권한을 저장하기 위해 옵트인 활성화

(선택 사항) optInCookiesDomain (string)

옵트인 쿠키에 사용할 자사 도메인 또는 하위 도메인(isOptInStorageEnabled가 true인 경우)

(선택 사항) optInStorageExpiry (integer)

기본 만료 기간인 13개월을 재정의하는 시간(초)

동의 매개 변수 변경 section-c3d85403ff0d4394bd775c39f3d001fc

방문자는 귀하의 사이트에서 경험하는 동안 언제든지 처음으로 기본 설정을 지정하거나 CMP를 사용하여 기본 설정을 변경할 수 있습니다. 방문자 JS가 초기 설정으로 초기화되면 다음 함수를 사용하여 방문자의 권한을 변경할 수 있습니다.

adobe.optIn.approve(categories, shouldWaitForComplete)

목록의 모든 카테고리에 대해 방문자를 승인하거나 옵트인하는 함수입니다. shouldWaitForComplete 매개 변수에 대한 자세한 내용은 옵트인 워크플로를 참조하십시오.

adobe.optIn.deny(categories, shouldWaitForComplete)

지정된 모든 카테고리에 대해 방문자를 거부하거나 옵트아웃하는 함수입니다.

adobe.optIn.approveAll():

사용자 사이트에 대한 작성 권한 요청에 방문자 블랭킷이 사용자 사이트에 대한 쿠키 작성 권한을 부여하거나 거부하도록 지정되어 있는 경우 해당 응답을 기준으로 하여 approveAll() 또는 denyAll()을 사용합니다.

adobe.optIn.denyAll():

사용자 사이트에 대한 작성 권한 요청에 방문자 블랭킷이 사용자 사이트에 대한 쿠키 작성 권한을 부여하거나 거부하도록 지정되어 있는 경우 해당 응답을 기준으로 하여 approveAll() 또는 denyAll()을 사용합니다.

옵트인 워크플로우 매개 변수 section-2c5adfa5459c4e72b96d2693123a53c2

옵트인은 환경 설정이 한 번에 하나씩 제공되는 워크플로우처럼, 두 개 이상의 요청 주기를 통해 권한을 수집할 수 있는 워크플로우를 지원합니다. 다음 함수를 사용하여 설정에 trueshouldWaitForComplete를 제공하면 솔루션에서 한 개 솔루션 또는 전체 카테고리의 서브 세트에 대한 동의를 수집한 다음, 다음 솔루션 또는 카테고리의 서브 세트에 대한 동의를 수집할 수 있습니다. adobe.optIn.status 속성은 첫 번째 호출부터 adobe.optIn.complete()가 흐름 끝에서 호출될 때까지 보류 상태가 됩니다. 호출되면 상태는 완료 ​로 설정됩니다.

adobe.optIn.approve(categories, shouldWaitForComplete)

목록의 모든 카테고리에 대해 방문자를 승인하거나 옵트인하는 함수입니다.

adobe.optIn.deny(categories, shouldWaitForComplete)

지정된 모든 카테고리에 대해 방문자를 거부하거나 옵트아웃하는 함수입니다.

adobe.optIn.complete()

방문자의 환경 설정을 설정하기 위해 approve() 및 deny()에 대한 이전 호출 집계를 한 개의 요청으로 트리거하는 함수입니다. 아래 옵트인 변경을 구독할 때(adobe.optIn.fetchPermissions(callback, shouldAutoSubscribe 참조) 콜백은 이 함수를 호출할 때만 트리거됩니다.

방문자 옵트인 권한 매개 변수 section-7fe57279b5b44b4f8fe47e336df60155

다음 권한 함수 중 하나를 사용하여 언제든지 방문자의 옵트인 권한을 수집합니다.

adobe.optIn.permissions

방문자가 부여하거나 거부한 모든 Experience Cloud 솔루션을 카테고리로 나열하는 개체입니다.

adobe.optIn.isApproved(categories)

모든 카테고리가 승인된 경우 이 함수는 true를 반환합니다.

adobe.optIn.fetchPermissions(callback, shouldAutoSubscribe)

권한 목록을 비동기 적으로 검색합니다. 권한 부여/거부 프로세스가 완료되면 권한 목록과 함께 콜백이 호출됩니다. 에 대해 trueshouldAutoSubscribe 값을 제공하면 옵트인 변경 사항을 전달하기 위해 콜백이 등록됩니다. 다음은 adobe.OptIn의 속성입니다.

permissions

방문자가 부여하거나 거부한 모든 Experience Cloud 솔루션을 나열하는 개체. 예: { aa: true, ecid: false, aam: true... }

status

  • 보류 중
  • 변경됨
  • 완료

doesOptInApply

초기화에 제공한 구성을 나타내는 True 또는 False

isPending

상태 값에 따라 True 또는 False. 아직 명시적으로 권한을 수락하거나 거부하지 않은 방문자의 경우 옵트인은 이 속성에 대해 true를 보고합니다.

isComplete

상태 값에 따라 True 또는 False. 워크플로 스타일 동의가 시작되었지만 완료되지 않은 경우 옵트인이 이 속성에 대해 false를 보고할 수 있습니다.

옵트인 개체의 메서드 section-e0417801a82548d199d833010033e433

approve(categories, shouldWaitForComplete)

categories: 승인할 하나 이상의 범주. 예: adobe.optIn.approve([adobe.OptInCategories.AAM, adobe.OptInCategories.ECID])
shouldWaitForComplete: (선택 사항) 부울 매개 변수, 기본적으로 false입니다. true를 전달하면 adobe.optIn.complete()()를 호출할 때까지 옵트인이 승인 프로세스를 완료하지 않습니다. 이 프로세스는 워크플로우와 유사합니다.

<codeblock>
  adobe.optIn.approve(adobe.OptInCategories.ANALYTICS,
         true); adobe.optIn.approve(adobe.OptInCategories.ECID, true);
         adobe.optIn.complete()
</codeblock>

deny(categories, shouldWaitForComplete)

  • 승인 여부를 확인하기 위해 1개 이상의 범주를 전달합니다.
  • 전달된 범주가 없으면 사용 가능한 모든 범주가 확인됩니다.

isApproved(categories)

고객이 하나 이상의 카테고리를 승인하는지 확인합니다.

isPreApproved(categories)

고객이 하나 이상의 카테고리를 사전 승인했는지 확인합니다. (하나 이상의 카테고리가 preOptInApprovals 구성에서 전달된 경우).

fetchPermissions(callback, shouldAutoSubscribe)

권한 목록을 검색하는 비동기 API입니다. 권한 부여/거부 프로세스가 완료되면 권한 목록과 함께 콜백이 호출됩니다. shouldAutoSubscribe: 도우미 유틸리티는 이 콜백을 향후 모든 이벤트에 자동으로 구독합니다. 즉, 옵트인에서 승인 또는 거부 트리거가 발생할 때마다 콜백이 호출됩니다. 이렇게 하면 이벤트를 직접 구독하지 않고도 항상 업데이트됩니다.

예

fetchPermissions

optIn.fetchPermissions(function (permissions) {
    // Here you can check if your category has been approved or not.
    // We recommend using `optIn.isApproved()` to check for permissions because it abstracts
       out the details of knowing exactly how the `permissions` list looks like.

    if (adobe.optIn.isApproved(MY_CATEGORY) {
        sendBeacon(); // Or something
    }
});

// OR: You can pass in `shouldAutoSubscribe` as true, your callback will be used to subscribe
to all OptIn events going forward:

function callback() {
    if (adobe.optIn.isApproved(MY_CATEGORY) {
        sendBeacon(); // Or something
    }
}

optIn.fetchPermissions(callback, true);

complete():

NOTE
승인하거나 거부할 shouldWaitForComplete 매개 변수를 전달한 경우에만 사용합니다. 이 API는 승인 프로세스를 완료합니다. 예: adobe.optIn.complete().

approveAll():

기존의 모든 카테고리를 승인합니다.

denyAll()

모든 기존 범주를 거부합니다.

옵트인 개체의 이벤트 section-06f25b33cab54bafb053183e937fb710

complete:

승인 프로세스가 완료되면 이벤트 트리거를 완료합니다. shouldWaitForComplete 또는 approveAll/denyAll을 전달하지 않고 승인/거부를 호출하는 경우 이 이벤트가 트리거됩니다. 또는 shouldWaitForComplete를 전달하는 경우 complete가 호출되면 이 이벤트가 트리거됩니다.

예

<codeph>
  adobe.optIn.on("complete", callback);
</codeph>
recommendation-more-help
9c9e8ca9-9f7e-42c9-a5d5-a0d82776362a