클래스: ImaSdkSettings

google.ima.ImaSdkSettings를 참고하세요.

class public 정적

이 클래스에는 SDK 전체 설정이 포함되어 있습니다.

열거형

컴패니언 백업 광고 모드

상수 정적

문자열

컴패니언 백업 광고 설정을 위한 상수 집합을 정의합니다. 이 설정은 다양한 시나리오에서 컴패니언을 백필해야 하는지 여부를 나타냅니다.

값이 ALWAYS인 경우 반환되는 기본 광고가 없는 경우에도 모든 상황에서 컴패니언 백업 광고를 시도합니다.

값이 ON_MASTER_AD인 경우 컴패니언 광고가 컴패니언 슬롯보다 적은 기본 광고가 있는 경우 컴패니언 백업 광고가 시도됩니다. 누락된 컴패니언은 백업됩니다.

기본값은 ALWAYS입니다.

클라이언트 컴패니언 백업 광고를 사용하려면 컴패니언을 Google 게시자 태그 (GPT)로 올바르게 태그해야 합니다. 백업 광고를 사용 설정하려면 표준 GPT 설정을 다음과 같이 변경해야 합니다. 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
자동재생 동영상의 경우 컴패니언 슬롯이 미리 로드된 후 즉시 컴패니언으로 대체되지 않도록 하려면 다음과 같은 추가 변경사항이 권장됩니다. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

값

항상

ON_MASTER_AD

VPAID 모드

상수 정적

숫자

VPAID 기능을 사용 설정하기 위한 상수 집합입니다.

값

사용 중지됨

VPAID 광고가 재생되지 않고 오류가 반환됩니다.

사용 설정됨

VPAID 광고는 교차 도메인 iframe을 사용하여 사용 설정됩니다. VPAID 광고가 사이트에 액세스할 수 없습니다. 호환 iframe 액세스에 종속되는 VPAID 광고는 오류가 발생할 수 있습니다. 이는 기본값입니다.

보안

VPAID 광고는 호환 iframe을 사용하여 사용 설정됩니다. 자바스크립트를 통해 사이트에 액세스할 수 있습니다.

속성

컴패니언 백업 광고 모드

상수 정적

문자열

컴패니언 백업 광고 설정을 위한 상수 집합을 정의합니다. 이 설정은 다양한 시나리오에서 컴패니언을 백필해야 하는지 여부를 나타냅니다.

값이 ALWAYS인 경우 반환되는 기본 광고가 없는 경우에도 모든 상황에서 컴패니언 백업 광고를 시도합니다.

값이 ON_MASTER_AD인 경우 컴패니언 광고가 컴패니언 슬롯보다 적은 기본 광고가 있는 경우 컴패니언 백업 광고가 시도됩니다. 누락된 컴패니언은 백업됩니다.

기본값은 ALWAYS입니다.

클라이언트 컴패니언 백업 광고를 사용하려면 컴패니언을 Google 게시자 태그 (GPT)로 올바르게 태그해야 합니다. 백업 광고를 사용 설정하려면 표준 GPT 설정을 다음과 같이 변경해야 합니다. 
...
let slot1 = googletag.defineSlot('/1234/adunit', [300, 250], 'slot-div');
slot1.addService(googletag.companionAds()).addService(googletag.pubads());
...
googletag.companionAds().setRefreshUnfilledSlots(true);
...
googletag.enableServices();
자동재생 동영상의 경우 컴패니언 슬롯이 미리 로드된 후 즉시 컴패니언으로 대체되지 않도록 하려면 다음과 같은 추가 변경사항이 권장됩니다. 
googletag.pubads().disableInitialLoad();
...
googletag.enableServices();

값

항상

ON_MASTER_AD

VPAID 모드

상수 정적

숫자

VPAID 기능을 사용 설정하기 위한 상수 집합입니다.

값

사용 중지됨

VPAID 광고가 재생되지 않고 오류가 반환됩니다.

사용 설정됨

VPAID 광고는 교차 도메인 iframe을 사용하여 사용 설정됩니다. VPAID 광고가 사이트에 액세스할 수 없습니다. 호환 iframe 액세스에 종속되는 VPAID 광고는 오류가 발생할 수 있습니다. 이는 기본값입니다.

보안

VPAID 광고는 호환 iframe을 사용하여 사용 설정됩니다. 자바스크립트를 통해 사이트에 액세스할 수 있습니다.

방법

getCompanionBackfill

getCompanionBackfill()은 CompanionBackfillMode를 반환

현재 컴패니언 백업 광고 모드를 반환합니다.

반환 값

non-null CompanionBackfillMode 현재 값입니다.

getDisableCustomPlaybackForIOS10Plus

getDisableCustomPlaybackForIOS10Plus()는 부울을 반환합니다.

iOS 10 이상의 브라우저에서 맞춤 재생 사용 중지 여부를 가져옵니다. 기본값은 false입니다.

반환 값

boolean 

getFeatureFlags

getFeatureFlags()는 모든 유형 속성이 있는 객체를 반환합니다.

키를 기능 플래그로 사용하고 객체를 현재 상태로 반환합니다.

반환 값

non-null Object with any type properties 

getLocale

getLocale() 문자열 반환

게시자가 제공한 언어를 반환합니다.

반환 값

string 게시자 제공 언어입니다.

getNumRedirects

getNumRedirects()가 숫자 반환

후속 리디렉션의 최대 리디렉션 수를 거부합니다.

반환 값

number: 최대 리디렉션 수

getPlayerType

getPlayerType()은 문자열을 반환합니다.

파트너가 제공한 플레이어 유형을 반환합니다.

반환 값

string 파트너 플레이어 유형입니다.

getPlayerVersion

getPlayerVersion()은 문자열을 반환합니다.

파트너가 제공한 플레이어 버전을 반환합니다.

반환 값

string 파트너 플레이어 버전

getPpid

getPpid() 반환 (null 또는 문자열)

게시자 제공 ID를 반환합니다.

반환 값

(null or string) 게시자가 제공한 ID입니다.

isCookiesEnabled

isCookiesEnabled()는 부울을 반환

반환 값

boolean 게시자의 쿠키 사용 허용 여부입니다.

자동 재생 광고 시점 설정

setAutoPlayAdBreaks(autoPlayAdBreaks)는 void를 반환

VMAP 및 광고 규칙 광고 시점의 자동 재생 여부 설정

매개변수

자동 재생 광고 시점

boolean

광고 시점의 자동 재생 여부입니다.
반환 값

void 

setCompanionBackfill

setCompanionBackfill(mode) void를 반환

컴패니언 백업 광고 모드를 설정합니다. ImaSdkSettings.CompanionBackfillMode에서 사용할 수 있는 다양한 모드를 참조하세요.

기본 모드는 ImaSdkSettings.CompanionBackfillMode.ALWAYS입니다.

매개변수

모드

컴패니언 백업 광고 모드

선택한 컴패니언 백업 광고 모드입니다.

값은 null일 수 없습니다.
반환 값

void 

setCookiesEnabled

setCookiesEnabled(cookiesEnabled)는 void를 반환

SDK가 퍼스트 파티 쿠키로 게시자 도메인에 Google Ad Manager 쿠키 (GFP 쿠키)를 저장해야 하는지 여부입니다. 이렇게 하면 서드 파티 쿠키를 사용하지 않고도 동일한 도메인을 여러 번 방문하더라도 지속성이 사용 설정됩니다. 기본값은 true입니다.

이 설정은 다른 제3자가 설정하거나 다른 용도로 설정할 수 있는 다른 쿠키에는 영향을 미치지 않습니다. 사용자 동의 및 선택 해제는 퍼스트 파티 쿠키의 사용을 중지할 수도 있습니다. 동일한 프레임에 있는 경우 IAB 준수 동의 관리 제공업체를 사용하는 게시자가 이를 선택합니다.

매개변수

쿠키 사용

boolean
반환 값

void 

setDisableCustomPlaybackForIOS10Plus

setDisableCustomPlaybackForIOS10Plus(disable) void 반환

iOS 10 이상의 브라우저에서 맞춤 재생을 사용 중지할지 여부를 설정합니다. true인 경우 콘텐츠 동영상이 인라인인 경우 광고가 인라인으로 재생됩니다. 이렇게 하면 건너뛸 수 있는 TrueView 광고가 사용 설정됩니다. 하지만 광고는 인라인 상태로 유지되며 iOS의 네이티브 전체화면을 지원하지 않습니다. false인 경우 광고가 콘텐츠와 동일한 플레이어에서 재생됩니다. AdDisplayContainer가 생성될 때 여기에 설정된 값이 컨테이너의 전체 기간 동안 사용됩니다. 기본값은 false입니다.

매개변수

사용 중지

boolean

맞춤 재생의 사용 중지 여부입니다.
반환 값

void 

setFeatureFlags

setFeatureFlags(featureFlags)는 void를 반환합니다.

특성 플래그의 값을 설정합니다. 광고를 요청하기 전에 가능한 한 빨리 설정해야 합니다. 설정은 다음 광고 요청까지 동일하게 유지됩니다. 이 메서드를 다시 호출하면 다음 광고 요청의 기능 플래그가 재설정됩니다.

매개변수

featureFlags

모든 유형 속성이 있는 객체

값은 null일 수 없습니다.
반환 값

void 

setLocale

setLocale(locale) void 반환

게시자가 제공한 언어를 설정합니다. AdsLoader 또는 AdDisplayContainer를 만들기 전에 호출해야 합니다. 언어는 UI 요소를 표시할 언어를 지정합니다. 지원되는 코드는 언어 및 현지화 현지화에서 확인할 수 있습니다.

매개변수

locale

문자열

게시자가 제공한 언어입니다.
반환 값

void 

setNumRedirects 클래스의 생성자

setNumRedirects(numRedirects)는 void를 반환

후속 리디렉션이 거부되고 광고 로드가 취소되기 전 최대 리디렉션 수를 지정합니다. 리디렉션 수는 지연 시간에 직접적인 영향을 주므로 사용자 환경에 영향을 줍니다. 모든 VAST 래퍼 광고에 적용됩니다.

매개변수

리디렉션 리디렉션

숫자

최대 리디렉션 수
반환 값

void 

setPlayerType

setPlayerType(playerType) void를 반환

파트너가 제공한 플레이어 유형을 설정합니다. 이 설정은 SDK와 통합되는 플레이어의 이름을 지정하는 데 사용해야 합니다. 플레이어 유형이 20자를 초과하면 잘립니다. 지정된 플레이어 유형은 짧고 고유해야 합니다. 이 설정은 플레이어 유형을 추적하여 SDK 사용성을 개선하는 데 사용되는 설정(선택사항)입니다.

예: 


settings.setPlayerType('google/gmf-player');

매개변수

playerType

문자열

파트너 플레이어의 유형입니다.
반환 값

void 

setPlayerVersion

setPlayerVersion(playerVersion)이 void를 반환

파트너가 제공한 플레이어 버전을 설정합니다. 이 설정은 SDK와 통합되는 파트너 플레이어의 버전을 지정하는 데 사용되어야 합니다. 20자를 초과하는 플레이어 버전은 잘립니다. 이 설정은 플레이어 버전을 추적하여 SDK 사용성을 개선하는 데 사용되는 설정(선택사항)입니다.

예: 


settings.setPlayerVersion('1.0.0');

매개변수

playerVersion

문자열

파트너 플레이어의 버전입니다.
반환 값

void 

setPpid

setPpid(ppid)는 void를 반환합니다.

게시자 제공 ID를 설정합니다.

매개변수

ppid

문자열

게시자 제공 ID입니다.
반환 값

void 

setSessionId

setSessionId(sessionId) void를 반환

세션 ID는 일시적 임의 ID입니다. 최대 게재빈도 설정에만 사용됩니다. 세션 ID는 UUID여야 합니다.

매개변수

세션 ID

문자열

최대 게재빈도 설정에 사용되는 임시 UUID입니다.
반환 값

void 

setVpaidAllowed

setVpaidAllowed(allowVpaid)는 void를 반환합니다.

지원이 중단되었습니다. setVpaidMode를 사용하세요. VPAID 광고 소재의 허용 여부를 설정합니다.

매개변수

allowVpaid

boolean

VPAID 광고 소재의 허용 여부입니다.
반환 값

void 

setVpaidMode

setVpaidMode(vpaidMode)는 void를 반환합니다.

VPAID 재생 모드를 설정합니다.

매개변수

VPAID 모드

VPAID 모드

VPAID 광고가 재생되는 방식을 설정합니다. 기본값은 보안 모드입니다.

값은 null일 수 없습니다.
반환 값

void