Webhook 알림

Webhook

Webhook은 네이티브 광고를 위해서만 선택적으로 사용됩니다.

Webhook URL을 제공하면 광고주의 정보 또는 광고 소재가 생성, 업데이트될 때마다 실시간 알림을 받을 수 있습니다.

Webhook URL은 다음 경로를 통해 얻을 수 있습니다.

Adrop 콘솔 > 프로젝트 > 좌측 네비게이션 메뉴바 : 프로젝트 설정 > Webhook URL

Webhook URL 제공하기

Webhook URL을 등록하고 Client credential을 제공하세요.

Webhook URL 등록하기

좌측 네비게이션 메뉴바에서 프로젝트 설정을 선택하세요.
Webhook URL 필드의 수정 아이콘을 클릭하세요.
받으실 Webhook URL을 입력하세요.
'저장'을 눌러주세요.

Client Credentials 설정하기

Webhook URL을 등록하면, 클라이언트가 사용할 수 있는 비밀키를 지정할 수 있습니다.

Adrop 서버는 해당 비밀키를 포함하여 Webhook URL로 POST 요청을 보냅니다.

Client Credentials 필드의 수정 아이콘을 눌러주세요.
입력 필드에 webhook URL로 POST할 때 사용할 비밀키를 알려주세요
"저장"을 눌러주세요.

실시간 알림

Webhook URL을 제공하면 광고주의 정보 또는 광고 소재가 생성, 업데이트될 때마다 실시간 알림을 받을 수 있습니다.

이러한 업데이트 및 변경 알림은 Webhook URL으로 전달됩니다.

Event formats

// Advertiser account created
{
  "type": "AD_ACCOUNT_CREATED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "",
    "icon": "",
    "cover": "",
    "advertiserURL": ""
  }
}

// Advertiser account updated
{
  "type": "AD_ACCOUNT_UPDATED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "AdropAds",
    "icon": "https://my-icon.png",
    "cover": "https://my-cover.png",
    "advertiserURL": "https://openrhapsody.com"
  }
}

// Advertiser account deleted
{
  "type": "AD_ACCOUNT_DELETED",
  "account": {
    "id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "advertiser": "AdropAds",
    "icon": "https://my-icon.png",
    "cover": "https://my-cover.png",
    "advertiserURL": "https://openrhapsody.com"
  }
}

// Creative created
{
  "type": "CREATIVE_CREATED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "headline text",
    "body": "body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

// Creative updated
{
  "type": "CREATIVE_UPDATED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "changed headline text",
    "body": "changed body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

// Creative deleted
{
  "type": "CREATIVE_DELETED",
  "creative": {
    "account_id": "01HP3QXSASJ613ZM45HFQV1TYG",
    "id": "01HP3R4AMGWN5JWQC8E7B0HKAV:01HP3RN8WTVC91NJEYWVD69HT8:BAnNDJJSJeS05Fb2RMnCO",
    "creative": "<html>..<html>",
    "headline": "changed headline text",
    "body": "changed body Text",
    "callToAction": "Go Now",
    "destinationURL": "https://adrop.io"
  }
}

추가 정보 태깅하기

Webhook을 통해 전달받은 Account ID 또는 Creative ID에 대해 원하는 추가 정보(태그)를 JSON 형식으로 Adrop 서버에 등록할 수 있습니다.

광고 수신 시 accountTag 또는 creativeTag 필드를 통해 태그 데이터를 확인할 수 있습니다.

인증 액세스 토큰

태그 지정을 위한 POST 요청을 수행하려면 액세스 토큰이 필요합니다.

Webhook URL을 등록한 후 인증 카드에서 액세스 토큰을 찾을 수 있습니다

태그 정보 등록 요청

Request header에 액세스 토큰을 'Authorization' 에 포함시켜주세요.
POST https://api-rest.adrop.io/tag Docs를 참조하여 POST 요청을 보내주세요.

이제 광고를 검색할 때마다 accountTag 또는 creativeTag 필드에 태그한 정보를 받을 수 있습니다.

PreviousAdrop에 API를 활용해 등록하기 Next광고 유닛 생성하기

Last updated 5 months ago