설명서Experience Platform태그

Reactor API의 관계

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

작성 대상:

  • 개발자

Reactor API의 리소스는 서로 관련이 있는 경우가 많습니다. 이 문서에서는 API에서 리소스 관계가 설정되는 방식과 각 리소스 유형의 관계 요구 사항에 대한 개요를 제공합니다.

해당 리소스의 유형에 따라 몇 가지 관계가 필요합니다. 필수 관계는 상위 리소스가 관계 없이 존재할 수 없음을 의미합니다. 다른 모든 관계는 선택 사항입니다.

필수 또는 선택 사항인지 여부에 관계없이 관계는 관련 리소스가 생성될 때 시스템에 의해 자동으로 설정되거나 수동으로 생성되어야 합니다. 수동으로 관계를 만드는 경우 해당 리소스에 따라 두 가지 방법이 있습니다.

각 리소스 유형에 대해 호환되는 관계 목록과 해당되는 경우 해당 관계를 설정하는 데 필요한 메서드를 보려면 관계 요구 사항의 섹션을 참조하십시오.

페이로드로 관계 만들기 payload

리소스를 처음 만들 때 일부 관계를 수동으로 설정해야 합니다. 이렇게 하려면 먼저 상위 리소스를 만들 때 요청 페이로드에 relationship 개체를 제공해야 합니다. 이러한 관계의 예는 다음과 같습니다.

API 형식

POST /properties/{PROPERTY_ID}/{RESOURCE_TYPE}
매개변수
설명
{PROPERTY_ID}
리소스가 속한 속성의 ID입니다.
{RESOURCE_TYPE}
만들 리소스의 유형입니다.

요청

다음 요청은 새 rule_component을(를) 만들어 rules 및 extension과(와) 관계를 설정합니다.

curl -X POST \
  https://reactor.adobe.io/properties/PRf606dbddfbdc44f580fc6f342b5ff9be/rule_components \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'x-api-key: [KEY]' \
  -H 'x-gw-ims-org-id: [ORG_ID]' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
        "data": {
          "attributes": {
            "delegate_descriptor_id": "kessel-test::events::click",
            "name": "My Example Click Event",
            "settings": "{\"elementSelector\":\".accordion\",\"bubbleFireIfChildFired\":true}"
          },
          "relationships": {
            "extension": {
              "data": {
                "id": "EXa2865f4d14204fa094f247406424371b",
                "type": "extensions"
              }
            },
            "rules": {
              "data": [
                {
                  "id": "RLd53598e3f1884e63bbc8e9c95e463dcf",
                  "type": "rules"
                }
              ]
            }
          },
          "type": "rule_components"
        }
      }'
속성
설명
relationships
페이로드로 관계를 만들 때 제공해야 하는 개체입니다. 이 개체의 각 키는 특정 관계 유형을 나타냅니다. 위의 예에서는 rule_components에 해당하는 extension 및 rules 관계가 설정되어 있습니다. 다른 리소스에 대해 호환되는 관계 유형에 대한 자세한 내용은 리소스별 관계 요구 사항에 대한 섹션을 참조하십시오.
data
relationship 개체에 제공된 각 관계 형식에는 관계가 설정되는 리소스의 id 및 type을(를) 참조하는 data 속성이 있어야 합니다. data 속성을 개체 배열로 형식을 지정하여 같은 형식의 여러 리소스와 관계를 만들 수 있습니다. 각 개체에는 적용 가능한 리소스의 id 및 type이(가) 포함되어 있습니다.
id
리소스의 고유 ID입니다. 각 id에는 해당 리소스의 유형을 나타내는 형제 type 속성이 있어야 합니다.
type
형제 id 필드에서 참조한 리소스의 유형입니다. 허용되는 값은 data_elements, rules, extensions 및 environments입니다.

URL로 관계 만들기 url

다른 리소스와 달리 라이브러리는 전용 /relationship 끝점을 통해 관계를 설정합니다. 해당 예는 다음과 같습니다.

API 형식

POST /properties/{PROPERTY_ID}/libraries/{LIBRARY_ID}/relationships/{RESOURCE_TYPE}
매개변수
설명
{PROPERTY_ID}
라이브러리가 속한 속성의 ID입니다.
{LIBRARY_ID}
관계를 만들 라이브러리의 ID입니다.
{RESOURCE_TYPE}
관계가 타겟팅하는 리소스의 유형입니다. 사용 가능한 값은 environment, data_elements, extensions 및 rules입니다.

요청

다음 요청은 라이브러리에 대해 /relationships/environment 끝점을 사용하여 환경과의 관계를 만듭니다.

curl -X POST \
  https://reactor.adobe.io/properties/PRf606dbddfbdc44f580fc6f342b5ff9be/libraries/LB10c1fd171cd347f19fcb8659a8d679ef/relationships/environment \
  -H 'Authorization: Bearer [TOKEN]' \
  -H 'x-api-key: [KEY]' \
  -H 'x-gw-ims-org-id: [ORG_ID]' \
  -H 'Accept: application/vnd.api+json;revision=1' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
        "data": {
          "id": "ENf395a477d2b24ad696d65b901055b9dc",
          "type": "environments",
        }
      }'
속성
설명
data
관계에 대한 대상 리소스의 id 및 type을(를) 참조하는 개체입니다. 같은 유형의 여러 리소스(예: extensions 및 rules)로 관계를 만드는 경우 data 속성은 개체 배열로 형식이 지정되어야 하며 각 개체에는 적용 가능한 리소스의 id 및 type이(가) 포함되어 있습니다.
id
리소스의 고유 ID입니다. 각 id에는 해당 리소스의 유형을 나타내는 형제 type 속성이 있어야 합니다.
type
형제 id 필드에서 참조한 리소스의 유형입니다. 허용되는 값은 data_elements, rules, extensions 및 environments입니다.

자원별 관계 요구 사항 requirements

다음 표에서는 각 리소스 유형에 사용할 수 있는 관계, 해당 관계가 필요한지 여부 및 해당되는 경우 관계를 수동으로 만들 수 있는 허용 방법에 대해 설명합니다.

NOTE
관계가 페이로드 또는 URL로 생성된 것으로 나열되지 않으면 시스템에서 관계를 자동으로 지정합니다.

이벤트 감사

관계
필수 여부
페이로드로 만들기
URL로 만들기
property
✓ 덧신
entity
✓ 덧신

빌드

관계
필수 여부
페이로드로 만들기
URL로 만들기
data_elements
extensions
rules
environment
✓ 덧신
library
✓ 덧신
property
✓ 덧신

콜백

관계
필수 여부
페이로드로 만들기
URL로 만들기
property
✓ 덧신

회사

관계
필수 여부
페이로드로 만들기
URL로 만들기
properties

데이터 요소

관계
필수 여부
페이로드로 만들기
URL로 만들기
libraries
revisions
✓ 덧신
notes
property
✓ 덧신
origin
✓ 덧신
extension
✓ 덧신
✓ 덧신
updated_with_extension
✓ 덧신
updated_with_extension_package
✓ 덧신

환경

관계
필수 여부
페이로드로 만들기
URL로 만들기
library
builds
host
✓ 덧신
✓ 덧신
property
✓ 덧신

확장

관계
필수 여부
페이로드로 만들기
URL로 만들기
libraries
revisions
✓ 덧신
notes
property
✓ 덧신
origin
✓ 덧신
extension_package
✓ 덧신
✓ 덧신
updated_with_extension_package
✓ 덧신

호스트

관계
필수 여부
페이로드로 만들기
URL로 만들기
property
✓ 덧신

라이브러리

관계
필수 여부
페이로드로 만들기
URL로 만들기
builds
environment
✓ 덧신
data_elements
✓ 덧신
extensions
✓ 덧신
rules
✓ 덧신
notes
upstream_library
✓ 덧신
property
✓ 덧신
last_build

참고

관계
필수 여부
페이로드로 만들기
URL로 만들기
resource
✓ 덧신

속성

관계
필수 여부
페이로드로 만들기
URL로 만들기
company
✓ 덧신
callbacks
environments
libraries
data_elements
extensions
extensions

규칙 구성 요소

관계
필수 여부
페이로드로 만들기
URL로 만들기
updated_with_extensions_package
✓ 덧신
updated_with_extension
✓ 덧신
extension
✓ 덧신
✓ 덧신
notes
origin
✓ 덧신
property
✓ 덧신
rules
✓ 덧신
✓ 덧신
revisions
✓ 덧신

규칙

관계
필수 여부
페이로드로 만들기
URL로 만들기
libraries
revisions
✓ 덧신
notes
property
✓ 덧신
origin
✓ 덧신
rule_components

비밀

관계
필수 여부
페이로드로 만들기
URL로 만들기
property
✓ 덧신
✓ 덧신
environment
✓ 덧신
✓ 덧신
recommendation-more-help
12b4e4a9-5028-4d88-8ce6-64a580811743