전환 API

매개변수 빌드 도구 워크플로 및 예시

매개변수 빌드 도구 라이브러리는 대부분의 시스템에 맞게 설계된 오픈 소스 저사양 SDK입니다.

워크플로

각 언어의 데모 예시는 각 하위 디렉터리에서 확인할 수 있습니다. 로컬 호스트 기반 데모 앱은 /example라는 이름의 폴더에 있습니다. README 파일은 로컬 호스트에서 데모 앱을 실행하는 방법을 단계별로 보여줍니다.

클라이언트 측 SDK

디렉터리:

고급 통합 가이드:

  • SDK 읽어들이기: 페이지 초기화 중에 clientParamBuilder를 읽어들입니다.
  • SDK API 호출하기: 광고주의 웹사이트가 clientParamBuilder에서 제공하는 API를 호출합니다. 예를 들면 다음과 같습니다.
    • .processAndCollectAllParams는 fbp, fpc 및 fbi를 저장하고 업데이트합니다(getIpFn 사용 가능 시).
      • getIpFn이 비어 있지 않을 경우 패스인 함수 getIpFn의 결과에 따라 fbi가 쿠키에 저장됩니다.
      • 해당하는 경우 fbc을 저장합니다.
      • 해당하는 경우 fbp를 저장합니다.
    • .getNormalizedAndHashedPII: 입력 값과 유형에 따라 정규화 및 해시된 PII 데이터를 반환합니다.
    • .getFbc(), getFbp(), getClientIpAddress(): 먼저 .processAndCollectAllParams를 호출하여 쿠키에 설정하고 쿠키에서 결과를 가져옵니다. 참고: 이 API는 쿠키를 저장/업데이트합니다. 호출하기 전에 웹사이트가 사용자의 쿠키 동의를 받았는지 확인하세요.
  • 전환 API 페이로드 전송: 광고주 웹사이트가 가져온 매개변수와 함께 전환 API 페이로드를 전송합니다.

자세한 지침은 README 파일을 참조하세요.

서버 측 SDK

디렉터리:

고급 통합 가이드:

  • 매개변수 빌드 도구 라이브러리를 광고주의 웹사이트 서버 앱으로 가져옵니다.
  • 요청 처리하기: 입력 데이터를 사용해 updatedCookieList = builder.processRequest를 호출합니다.
  • 설정할 쿠키 가져오기: updatedCookieList 또는 builder.getCookiesToSet를 사용하여 저장할 쿠키 리스트를 가져옵니다.
  • 쿠키 저장하기: 광고주의 웹사이트 서버가 위의 리스트를 기준으로 쿠키를 저장합니다.
  • 매개변수를 가져옵니다. 다음을 사용하여 값을 가져오세요.
    • getFbc()
    • getFbp()
    • getClientIpAddress()
    • getNormalizedAndHashedPII()
  • 전환 API 페이로드 전송하기: 광고주 웹사이트가 위의 매개변수를 사용하여 페이로드를 전송합니다.

[권장] 클라이언트 측 + 서버 측 SDK

동일한 웹 앱에 클라이언트 측과 서버 측 SDK를 모두 통합할 수도 있습니다. 이들은 서로 호환되며 주요 상호작용에 쿠키를 사용합니다. 이는 매개변수 빌드 도구 라이브러리의 효과를 극대화하는 데 도움이 될 수 있습니다.

클릭하여 이미지 확대



  1. 광고주 클라이언트 앱이 클라이언트 측 매개변수 빌드 도구를 읽어들이고 getIpFn 함수 포인터를 사용하여 제공된 API processAndCollectAllParams를 호출합니다.
  2. 제공된 getIpFn이 호출되고 실제 getIpFn 구현에 따라 광고주가 구성한 엔드포인트에서 IPv6를 가져옵니다.
  3. IPv6가 광고주가 구성한 엔드포인트에서 반환되고 getIpFn의 반환 값에서 클라이언트 측 매개변수 빌드 도구로 다시 전달됩니다. 가져온 IPv6는 나중에 가져올 수 있도록 _fbi 키가 있는 쿠키에 저장됩니다.
  4. 클라이언트 측에서 자사 쿠키가 포함된 가져오기 API를 사용하여 백엔드 서버에 대한 기존 커뮤니케이션을 시작하거나 기타 프론트-백엔드 커뮤니케이션을 시작합니다.
  5. 서버 측에서 수신자 엔드포인트(예: ExampleController)의 언어 선택에 따라 서버 측 라이브러리를 통합하고 제공된 API processRequest를 호출하여 요청을 처리합니다.
  6. processRequest API가 클라이언트 측에서 업데이트하도록 권장되는 쿠키 리스트를 반환합니다.
  7. 응답 헤더에 추천 쿠키를 설정하여 클라이언트 브라우저에 저장을 지시합니다.
  8. getFbc(), getFbp(), getClientIpAddress() 및 getNormalizedAndHashedPII() 등 제공된 다양한 API를 호출합니다.
  9. SDK가 fbc, fbp, client_ip_address, email, phone number 등의 다양한 값을 반환합니다.
  10. 이렇게 가져온 값을 전환 API를 통해 Meta로 다시 보냅니다.