Loader

광고를 로드할 수 있는 객체입니다.

nestads.Loader

메서드 요약

메서드	설명
addService	이 로더에 Service를 추가합니다.
clearTargeting	이 로더에 대한 특정 또는 모든 타겟팅 매개변수를 삭제합니다.
getTargeting	이 로더에 설정된 특정 타겟팅 매개변수를 반환합니다.
getTargetingKeys	이 로더에 설정된 모든 타겟팅 키의 목록을 반환합니다.
getPlacementCode	이 로더에 설정된 게재위치 코드를 반환합니다.
getCreativeSpecIds	이 로더에 설정된 소재스펙 ID 목록을 반환합니다.
setConfig	이 로더의 광고 요청 옵션을 설정합니다.
setTargeting	이 로더에 대한 타겟팅 매개변수를 설정합니다.
load	이 로더에 설정된 값으로 광고를 요청합니다.

---

addService

addService(service: Service): Loader

이 로더에 Service를 추가합니다.

예시

nestads.defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
       .addService(nestads.pubAds());

매개변수	설명
service: Service	추가할 서비스입니다.

반환 값	설명
Loader	메서드가 호출된 로더 객체입니다.

---

clearTargeting

clearTargeting(key?: string): Loader

로더의 타겟팅 매개변수를 삭제합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .setTargeting("age", 30)
  .setTargeting("gender", "MALE")
  .addService(nestads.pubAds());

loader.clearTargeting("gender");
loader.clearTargeting(); //All targeting cleared

매개변수	설명
key?: string	타겟팅 매개변수 키. 키는 선택사항입니다. 지정하지 않으면 모든 타겟팅 매개변수가 삭제됩니다.

반환 값	설명
Loader	메서드가 호출된 로더 객체입니다.

---

getTargeting

getTargeting(key: string): string[]

이 로더에 설정된 특정 타겟팅 매개변수를 반환합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .setTargeting("age", 30)
  .addService(nestads.pubAds());

loader.getTargeting("age");
// Returns [30].

loader.getTargeting("test");
// Returns [] (empty array).

매개변수	설명
key: string	찾을 타겟팅 키입니다.

반환 값	설명
string[]	이 키와 연결된 값 또는 키가 없는 경우 빈 배열입니다.

---

getTargetingKeys

getTargetingKeys(): string[]

이 로더에 설정된 모든 타겟팅 키의 목록을 반환합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .setTargeting("age", 30)
  .setTargeting("gender", "MALE")
  .addService(nestads.pubAds());

loader.getTargetingKeys(); // Returns ['age', 'gender'].

반환 값	설명
string[]	타겟팅 키의 배열입니다. 순서는 정의되지 않습니다.

---

getPlacementCode

getPlacementCode(): string

이 로더에 설정된 게재위치 코드를 반환합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .addService(nestads.pubAds());

loader.getPlacementCode(); // Returns `${placementCode}`.

반환 값	설명
string	게재위치 코드

---

getCreativeSpecIds

getCreativeSpecIds(): string[]

이 로더에 설정된 소재스펙 ID를 반환합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .addService(nestads.pubAds());

loader.getCreativeSpecIds(); // Returns [creativeSpecId1,creativeSpecId2,...].

반환 값	설명
string[]	소재스펙 ID

---

setConfig

setConfig(config: LoaderSettingConfig): void

광고 요청 옵션을 설정합니다.

매개변수	설명
config: LoaderSettingConfig	광고 요청 옵션 객체입니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .setConfig({httpTimeout: 1000, maxNumberOfAds: 3});

---

setTargeting

setTargeting(key: string, value: string | string[] | Object): Slot

로더에 대한 타겟팅 매개변수를 설정합니다.

유효한 타겟팅 key 값은 아래에서 참고해주세요.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .addService(nestads.pubAds());

loader.setTargeting("age", 30);
loader.setTargeting("customTargeting", {"custom1":"custom1Value", "custom2":"custom2Value"});
loader.setTargeting("customTargeting", {"custom1":["custom1Value", "custom2Value"], "custom2":["custom1Value", "custom2Value"]});
loader.setTargeting("audienceParameters", {"region": ["265700", "245422"], "career_period": [120]});

매개변수	설명
key: string	타겟팅 매개변수 키
value: string | string[] | Object	타겟팅 매개변수 값입니다.

타겟팅 매개변수 유효한 값

Key	Value Type	설명
appVersion	string	클라이언트 앱/웹 버전
country	string	광고 요청한 유저 국가코드(3자리) ISO-3166-1-alpha-3 UNKNOWN default: PC - 브라우저 설정 국가 Mobile - 디바이스의 시스템 설정 국가
language	string	광고 요청한 유저 언어 설정값(2자리) ISO-639-1-alpha-2 UNKNOWN default: PC - 브라우저 표시 언어 Mobile - 디바이스의 시스템 설정 언어
deviceBrand	string	광고 요청한 유저 디바이스의 브랜드
deviceModel	string	광고 요청한 유저 디바이스의 모델명
carrier	string	광고 요청한 유저 기기의 통신사 식별자
lat	boolean	광고 요청한 유저 기기의 광고추적제한 (LAT, Limit Ad Tracking) 설정 여부 true : 광고 추적 불가 false : 광고 추적 가능
adid	string	광고 요청한 디바이스 식별자 (for Android)
idfa	string	광고 요청한 디바이스 식별자 (for iOS)
idfv	string	광고 요청한 벤더 식별자 (for iOS)
loginId	string	매체 서비스에서 이용하는 고유 로그인아이디
gender	string	광고 요청한 유저 성별 MALE : 남성 FEMALE : 여성 UNKNOWN : 알 수 없음
age	number	광고 요청한 유저 연령
customTargeting	Object(JSON)	매체의 맞춤 타겟팅 값 {customTargetingKey: string | string[]} 형태로 넣어 줍니다.
audienceParameters	Object(JSON)	오디언스 파라미터 값 {[key: string]: string[] | number[]} 형태로 넣어 줍니다.

반환 값	설명
Loader	메서드가 호출된 로더 객체입니다.

---

load

async load(): Promise<void>

로더에 설정된 값으로 광고를 요청합니다.

예시

const loader = nestads
  .defineLoader(`${placementCode}`, [creativeSpecId1,creativeSpecId2,...])
  .addService(nestads.pubAds());

loader.load();