프로필 검색 retrieve-profiles

IMPORTANT
이 페이지의 컨텐츠는 정보용으로만 제공됩니다. 이 API를 사용하려면 Adobe의 현재 라이선스가 필요합니다. 허가되지 않은 사용은 허용되지 않습니다.
IMPORTANT
REST API V2 구현은 조절 메커니즘 설명서에 의해 제한됩니다.

요청 request

HTTP
경로
/api/v2/{serviceProvider}/profiles
방법
GET
경로 매개 변수
serviceProvider
온보딩 프로세스 중 서비스 공급자와 연결된 내부 고유 식별자입니다.
필수
헤더
인증
전달자 토큰 페이로드의 생성은 인증 헤더 설명서에 설명되어 있습니다.
필수
AP-Device-Identifier
장치 식별자 페이로드 생성은 AP-Device-Identifier 헤더 문서에 설명되어 있습니다.
필수
X-Device-Info
장치 정보 페이로드의 생성은 X-Device-Info 헤더 설명서에 설명되어 있습니다.

응용 프로그램의 장치 플랫폼에서 유효한 값의 명시적 제공을 허용하는 경우 항상 사용하는 것이 좋습니다.

제공되면 Adobe Pass 인증 백엔드는 명시적으로 설정된 값을 추출된 값과 묵시적으로(기본적으로) 병합합니다.

제공하지 않으면 Adobe Pass 인증 백엔드는 추출된 값을 묵시적으로(기본적으로) 사용합니다.
필수
X-Forwarded-For
스트리밍 장치의 IP 주소입니다.

특히 스트리밍 장치가 아닌 프로그래머 서비스에서 호출하는 경우 항상 서버 대 서버 구현에 사용하는 것이 좋습니다.

클라이언트 대 서버 구현의 경우, 스트리밍 장치의 IP 주소가 암묵적으로 전송됩니다.
선택 사항
Adobe-Subject-Token
or
X-Roku-Reserved-Roku-Connect-Token
플랫폼 ID 메서드에 대한 Single Sign-On 페이로드 생성은 Adobe-Subject-Token / X-Roku-Reserved-Roku-Connect-Token 헤더 설명서에 설명되어 있습니다.

플랫폼 ID를 사용한 Single Sign-On 사용 흐름에 대한 자세한 내용은 플랫폼 ID 흐름을 사용한 Single Sign-On 설명서를 참조하십시오.
선택 사항
광고 서비스 토큰
서비스 토큰 메서드에 대한 Single Sign-On 페이로드의 생성은 AD-Service-Token 헤더 설명서에 설명되어 있습니다.

서비스 토큰을 사용한 Single Sign-On 사용 흐름에 대한 자세한 내용은 서비스 토큰 흐름을 사용한 Single Sign-On 설명서를 참조하십시오.
선택 사항
AP-Partner-Framework-Status
Partner 메서드에 대한 SSO(Single Sign-On) 페이로드의 생성은 AP-Partner-Framework-Status 헤더 문서에 설명되어 있습니다.

파트너를 사용한 Single Sign-On 사용 흐름에 대한 자세한 내용은 파트너 흐름을 사용한 Single Sign-On 설명서를 참조하십시오.
선택 사항
AP-Visitor-Identifier
방문자 식별자 페이로드 생성은 AP-Visitor-Identifier 헤더 문서에 설명되어 있습니다.
선택 사항
Accept
클라이언트 애플리케이션에서 허용하는 미디어 유형입니다.

지정하면 application/json이어야 합니다.
선택 사항
User-Agent
클라이언트 애플리케이션의 사용자 에이전트입니다.
선택 사항

응답 response

코드
텍스트
설명
200
확인
응답 본문에 유효한 프로필 맵이 포함되어 있으며, 이 맵은 비어 있을 수 있습니다.
400
잘못된 요청
요청이 잘못되었습니다. 클라이언트가 요청을 수정하고 다시 시도하십시오. 응답 본문에는 향상된 오류 코드 설명서를 준수하는 오류 정보가 포함될 수 있습니다.
401
승인되지 않음
액세스 토큰이 잘못되었습니다. 클라이언트가 새 액세스 토큰을 얻은 후 다시 시도하십시오. 자세한 내용은 동적 클라이언트 등록 개요 설명서를 참조하십시오.
405
메서드가 허용되지 않음
HTTP 메서드가 잘못되었습니다. 클라이언트가 요청한 리소스에 대해 허용되는 HTTP 메서드를 사용하고 다시 시도하십시오. 자세한 내용은 요청 섹션을 참조하세요.
500
내부 서버 오류
서버 측에서 문제가 발생했습니다. 응답 본문에는 향상된 오류 코드 설명서를 준수하는 오류 정보가 포함될 수 있습니다.

성공 success

헤더
상태
200
필수
Content-Type
application/json
필수
본문
프로필

키, 값 쌍의 맵이 포함된 JSON.

키 요소는 다음 값으로 정의됩니다.

table 0-row-3 1-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff layout-auto html-authored
mvpd 온보딩 프로세스 중 ID 공급자와 연결된 내부 고유 식별자입니다. 필수

값 요소는 다음 속성으로 정의됩니다.

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 1-bgcolor-eff2f7 2-bgcolor-eff2f7 3-bgcolor-eff2f7 5-bgcolor-deebff 9-bgcolor-deebff 13-bgcolor-deebff 17-bgcolor-deebff 21-bgcolor-deebff layout-auto html-authored
속성
notBefore 프로필이 유효하지 않은 타임스탬프(밀리초)입니다. 필수
notAfter 프로필이 유효하지 않은 타임스탬프(밀리초)입니다. 필수
발급자

프로필을 소유하는 엔티티입니다.

가능한 값은 다음과 같습니다.

  • mvpd(예: Spectrum, Cablevision 등)
    기본 인증, 플랫폼 ID를 사용한 SSO(Single Sign-On) 또는 서비스 토큰을 사용한 SSO(Single Sign-On)의 결과로 프로필이 만들어졌습니다.
  • Apple
    Single Sign-On으로 인해 파트너 Apple을 사용하여 프로필이 만들어졌습니다.
필수
유형

프로필의 유형입니다.

가능한 값은 다음과 같습니다.

  • 일반
    기본 인증의 결과로 프로필이 만들어졌습니다.
  • appleSSO
    Single Sign-On으로 파트너 Apple을 사용하여 프로필이 만들어졌습니다.
  • platformSSO
    Single Sign-On으로 인해 플랫폼 ID를 사용하여 프로필이 만들어졌습니다.
  • serviceTokenSSO
    서비스 토큰을 사용하여 SSO(Single Sign-On)로 인해 프로필이 만들어졌습니다.
필수
속성

키, 값 쌍의 맵이 포함된 JSON.

키 요소는 사용자 메타데이터 특성으로 정의되며 다음과 같은 작업을 수행할 수 있습니다.

  • 필수, 예: 'userID'
  • 'zip', 'householdID', 'maxRating' 등과 같이 필수가 아닙니다.

속성의 값은 다음과 같을 수 있습니다.

  • 단순
  • 목록

사용자 메타데이터는 인증 흐름이 완료된 후에 사용할 수 있게 되지만 특정 메타데이터 속성은 MVPD 및 해당 특정 메타데이터 속성에 따라 인증 흐름 중에 업데이트될 수 있습니다.

필수
필수

오류 error

헤더
상태
400, 401, 405, 500
필수
Content-Type
application/json
필수
본문
응답 본문은 향상된 오류 코드 설명서를 준수하는 추가 오류 정보를 제공할 수 있습니다.
필수

샘플 samples

​1. 기본 인증을 통해 얻은 프로필 검색

요청
code language-https
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
응답
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
    "profiles": {
        "Cablevision": {
            "notBefore": 1752149281000,
            "notAfter": 1783685280000,
            "issuer": "Cablevision",
            "type": "regular",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                },
                "householdID": {
                    "value": "BASE64_value_householdId",
                    "state": "plain"
                },
                "zip": {
                    "value": "BASE64_value_zip",
                    "state": "enc"
                }
            }
        },
        "Spectrum": {
            "notBefore": 1752149272300,
            "notAfter": 1783685284670,
            "issuer": "Spectrum",
            "type": "regular",
            "attributes": {
                "userID": {
                    "value": "BASE64_value_userId",
                    "state": "plain"
                }
            }
        }
     }
}

​2. 서비스 토큰 방법을 사용하여 기본 인증 또는 SSO(Single Sign-On)를 통해 얻은 프로필 검색

요청
code language-https
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    AD-Service-Token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJkZDNmYWIyN2NmMjg0ZmU2ZWU0ZDY3ZmExZjY4MzE3YyIsImlzcyI6IkFkb2JlIiw.....
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
응답
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
   "profiles": {
      "AdobeShibboleth": {
         "notBefore": 1748073636999,
         "notAfter": 1748105173000,
         "issuer": "AdobeShibboleth",
         "type": "serviceTokenSSO",
         "attributes": {
            "upstreamUserID": {
               "value": "AAdzZWNyZXQxydCkywfPBl0KExk8OWhdbUBVDDJBttfKD7RAcRlc32Pbuwd1...",
               "state": "plain"
            },
            "userID": {
               "value": "AAdzZWNyZXQxydCkywfPBl0KExk8OWhdbUBVDDJBttfKD7RAcRlc32Pbuwd14aTV....",
               "state": "plain"
            },
            "mvpd": {
               "value": "AdobeShibboleth",
               "state": "plain"
            }
         }
      },
      "Spectrum": {
         "notBefore": 1752149281000,
         "notAfter": 1783685280000,
         "issuer": "Spectrum",
         "type": "regular",
         "attributes": {
            "userID": {
               "value": "BASE64_value_userId",
               "state": "plain"
            }
         }
      }
   }
}

​3. 플랫폼 ID 방법을 사용하여 기본 인증 또는 SSO(Single Sign-On)를 통해 얻은 프로필 검색

요청
code language-https
GET /api/v2/REF30/profiles HTTP/1.1

    Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJjNGZjM2U3ZS0xMmQ5LTQ5NWQtYjc0Mi02YWVhYzhhNDkwZTciLCJuYmYiOjE3MjQwODc4NjgsImlzcyI6ImF1dGguYWRvYmUuY29tIiwic2NvcGVzIjoiYXBpOmNsaWVudDp2MiIsImV4cCI6MTcyNDEwOTQ2OCwiaWF0IjoxNzI0MDg3ODY4fQ.DJ9GFl_yKAp2Qw-NVcBeRSnxIhqrwxhns5T5jU31N2tiHxCucKLSQ5guBygqkkJx6D0N_93f50meEEyfb7frbHhVHHwmRjHYjkfrWqHCpviwVjVZKKwl8Y3FEMb0bjKIB8p_E3txX9IbzeNGWRufZBRh2sxB5Q9B7XYINpVfh8s_sFvskrbDu5c01neCx5kEagEW5CtE0_EXTgEb5FSr_SfQG3UUu_iwlkOggOh_kOP_5GueElf9jn-bYBMnpObyN5s-FzuHDG5Rtac5rvcWqVW2reEqFTHqLI4rVC7UKQb6DSvPBPV4AgrutAvk30CYgDsOQILVyrjniincp7r9Ww
    AP-Device-Identifier: fingerprint YmEyM2QxNDEtZDcxNS01NjFjLTk0ZjQtZTllNGM5NjZiMWVi
    X-Device-Info: ewoJInByaW1hcnlIYXJkd2FyZVR5cGUiOiAiU2V0VG9wQm94IiwKCSJtb2RlbCI6ICJUViA1dGggR2VuIiwKCSJtYW51ZmFjdHVyZXIiOiAiQXBwbGUiLAoJIm9zTmFtZSI6ICJ0dk9TIgoJIm9zVmVuZG9yIjogIkFwcGxlIiwKCSJvc1ZlcnNpb24iOiAiMTEuMCIKfQ==
    Adobe-Subject-Token: eyJhbGciOiJSUzI1NiJ9.eyJzdWIiOiIyMmM4MDU1MjEzMDIwYzhmZGYzOGZkMTI1YWViMzUzYSIsImlzcyI6....
    Accept: application/json
    User-Agent: Mozilla/5.0 (Apple TV; U; CPU AppleTV5,3 OS 11.0 like Mac OS X; en_US)
응답
code language-https
HTTP/1.1 200 OK

Content-Type: application/json;charset=UTF-8

{
   "profiles": {
      "AdobePass_SMI": {
         "notBefore": 1724337476000,
         "notAfter": 1724345252000,
         "issuer": "AdobePass_SMI",
         "type": "platformSSO",
         "attributes": {
            "upstreamUserID": {
               "value": "38524bdc3d1caac0b3e139003ea0954e15ad9648",
               "state": "plain"
            },
            "userID": {
               "value": "38524bdc3d1caac0b3e139003ea0954e15ad9648",
               "state": "plain"
            },
            "mvpd": {
               "value": "AdobePass_SMI",
               "state": "plain"
            }
         }
      },
      "Cablevision": {
         "notBefore": 1752149281000,
         "notAfter": 1783685280000,
         "issuer": "Spectrum",
         "type": "regular",
         "attributes": {
            "userID": {
               "value": "BASE64_value_userId",
               "state": "plain"
            }
         }
      }
   }
}
recommendation-more-help
3f5e655c-af63-48cc-9769-2b6803cc5f4b