클래스: 광고

google.ima.Ad

class   정적

다양한 광고 유형을 나타내는 클래스로 확장된 광고 클래스입니다.

방법

getAdId

getAdId()가 문자열을 반환함

광고 ID는 기본 광고와 컴패니언 광고를 동기화하는 데 사용됩니다.

반환 값

string: 광고의 ID이거나 이 정보를 사용할 수 없는 경우 빈 문자열입니다.

getAdPodInfo

getAdPodInfo()가 AdPodInfo를 반환

광고의 광고 모음 정보를 반환합니다.

반환 값

non-null AdPodInfo 광고의 광고 모음 정보입니다.

getAdSystem

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

광고 응답에 포함된 소스 광고 서버 정보입니다.

반환 값

string: 광고의 소스 광고 서버 또는 이 정보를 사용할 수 없는 경우 빈 문자열입니다.

광고주 이름 가져오기

getAdvertiserName()이 문자열을 반환

게재 당사자가 정의한 광고주 이름입니다.

반환 값

string 광고주 이름이거나 이 정보를 사용할 수 없는 경우 빈 문자열입니다.

getApiFramework

getApiFramework()는 문자열을 반환합니다.

광고를 실행하는 데 필요한 API를 식별합니다. 이는 VAST에 지정된 apiFramework에 해당합니다.

반환 값

nullable string API 프레임워크는 광고를 실행해야 하며, 이 정보를 사용할 수 없는 경우 null을 처리합니다.

컴패니언 광고 가져오기

getCompanionAds(adSlotWidth, adSlotHeight, settings)는 null이 아닌 CompanionAd의 배열을 반환합니다.

컴패니언 광고 슬롯 크기를 기준으로 이 광고의 컴패니언 광고를 가져옵니다. 원하는 경우 고급 선택 설정이 허용됩니다. 이 메서드는 STARTED 이벤트 이후에 획득한 광고 인스턴스에 대해 비어 있지 않은 배열만 반환합니다. 특히 LOADED 이벤트의 광고가 빈 배열을 반환합니다.

매개변수
adSlotWidth	숫자 컴패니언 광고 슬롯의 너비.
adSlotHeight	숫자 컴패니언 광고 슬롯의 높이
설정	선택사항 CompanionAdSelectionSettings 컴패니언 광고의 선택 설정 값은 null일 수 없습니다.

반환 값

non-null Array of non-null CompanionAd 설정 및 슬롯 크기와 일치하는 컴패니언 광고의 배열입니다.

getContentType

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

현재 선택된 광고 소재의 콘텐츠 유형을 반환하거나 광고 소재를 선택하지 않았거나 콘텐츠 유형을 사용할 수 없는 경우 빈 문자열을 반환합니다. 선형 광고의 경우 미디어 파일이 선택된 경우 시작 이벤트 이후에만 콘텐츠 유형을 사용할 수 있습니다.

반환 값

string 콘텐츠 유형, 사용할 수 없는 경우 빈 문자열.

getCreativeAdId

getCreativeAdId()가 문자열을 반환함

광고의 ISCI (Industry Standard Commercial Identifier) 코드를 반환하거나 코드를 사용할 수 없는 경우 빈 문자열을 반환합니다. 이는 VAST 응답에 있는 광고 소재의 광고 ID입니다.

반환 값

string 

getCreativeId

getCreativeId()가 문자열을 반환함

광고에 선택된 광고 소재의 ID를 검색합니다.

반환 값

string 광고에 대해 선택한 광고 소재의 ID입니다. 이 정보를 사용할 수 없는 경우 빈 문자열입니다.

거래 할인 ID

getDealId()가 문자열을 반환

현재 광고의 래퍼 체인에 있는 첫 번째 거래 ID를 위에서부터 반환합니다. 사용할 수 없는 경우 빈 문자열을 반환합니다.

반환 값

string 

getDescription

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

VAST 응답에서 이 광고의 설명을 반환합니다.

반환 값

string 설명입니다. 지정되지 않은 경우 비어 있습니다.

getDuration

getDuration()이 숫자를 반환

선택된 광고 소재의 재생 시간을 반환하거나 비선형 광고 소재의 경우 -1을 반환합니다.

반환 값

number: 선택된 광고 소재 길이(초 단위) 또는 -1(비선형인 경우)

getHeight

getHeight()는 숫자를 반환합니다.

선택한 비선형 광고 소재의 높이를 반환합니다.

반환 값

number 선택한 비선형 광고 소재의 높이 또는 선형 광고 소재의 경우 0입니다.

getMediaUrl

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

현재 사용 중인 미디어 선택 설정에 따라 광고에서 선택한 미디어 파일의 URL을 반환합니다. 이 정보를 사용할 수 없으면 null을 반환합니다. 시작 이벤트에서 사용할 수 있습니다.

반환 값

nullable string 

getMinSuggestedDuration

getMinSuggestedDuration()이 숫자를 반환

비선형 광고 소재를 표시해야 하는 최소 권장 기간(초)을 반환합니다. 최소 추천 기간을 알 수 없는 경우 -2를 반환합니다. 선형 광고 소재의 경우 광고의 전체 재생 시간을 반환합니다.

반환 값

number 광고 소재가 표시되어야 하는 최소 추천 기간(초)입니다.

getSkipTimeOffset

getSkipTimeOffset()이 숫자를 반환

광고를 건너뛸 수 있게 되기까지 걸리는 시간(초)입니다. 건너뛸 수 없는 광고가 있거나 사용할 수 없는 경우 -1이 반환됩니다.

반환 값

number 초 단위의 오프셋입니다. 또는 -1입니다.

getSurveyUrl

getSurveyUrl()이 문자열을 반환함

지정된 광고의 설문조사와 연결된 URL을 반환합니다. 사용할 수 없는 경우 null을 반환합니다.

반환 값

nullable string 

getTitle

getTitle()이 문자열을 반환

VAST 응답에서 이 광고의 제목을 반환합니다.

반환 값

string 제목입니다. 지정하지 않으면 비어 있습니다.

getTraffickingParameters

getTraffickingParameters()는 문자열 속성이 있는 객체를 반환합니다.

광고 트래피킹 시 광고와 연결된 맞춤 매개변수를 가져옵니다.

반환 값

non-null Object with string properties 트래피킹 키를 값에 매핑합니다. 이 정보를 사용할 수 없는 경우 빈 객체입니다.

getTraffickingParametersString

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

광고 트래피킹 시 광고와 연결된 맞춤 매개변수를 가져옵니다. getTraffickingParameters에서 파싱된 매개변수의 원시 문자열 버전을 반환합니다.

반환 값

string 트래피킹 매개변수 또는 이 정보를 사용할 수 없는 경우 빈 문자열.

getUiElements

getUiElements()는 문자열의 배열을 반환합니다.

이 광고가 재생될 때 표시되는 UI 요소를 반환합니다. 반환된 배열의 가능한 요소는 UiElements를 참조하세요.

반환 값

non-null Array of string 표시되는 UI 요소입니다.

getUniversalAdIdRegistry

getUniversalAdIdRegistry()는 문자열을 반환합니다.

광고에 대해 선택된 광고 소재의 UniversalAdId 카탈로그와 연결된 레지스트리입니다.

지원 중단됨

ad.getUniversalAdIds()를 대신 사용하세요.

반환 값

string 레지스트리 값을 반환하거나 사용할 수 없는 경우 '알 수 없음'을 반환합니다.

getUniversalAdIdValue

getUniversalAdIdValue()가 문자열을 반환함

광고에 대해 선택된 광고 소재의 UniversalAdId입니다.

지원 중단됨

ad.getUniversalAdIds()를 대신 사용하세요.

반환 값

string ID 값 또는 사용할 수 없는 경우 '알 수 없음'을 반환합니다.

getUniversalAdIds

getUniversalAdIds()는 null이 아닌 UniversalAdIdInfo의 배열을 반환합니다.

광고에 대해 선택된 광고 소재의 범용 광고 ID 목록입니다.

반환 값

non-null Array of non-null UniversalAdIdInfo 이 광고에 적용되는 범용 광고 ID 정보 목록을 반환합니다.

getVastMediaBitrate

getVastMediaBitrate()는 숫자를 반환합니다.

SDK에서 광고 소재와 미디어 파일을 모두 선택하면 VAST 응답에 나열된 미디어 파일의 비트 전송률이 반환됩니다.

반환 값

number 선택한 미디어 파일의 비트 전송률 또는 0입니다.

getVastMediaHeight

getVastMediaHeight()는 숫자를 반환합니다.

선택한 광고 소재의 VAST 미디어 높이를 반환합니다.

반환 값

number 선택한 광고 소재의 VAST 미디어 높이이며, 아무것도 선택하지 않은 경우 0입니다.

getVastMediaWidth

getVastMediaWidth()는 숫자를 반환합니다.

선택한 광고 소재의 VAST 미디어 너비를 반환합니다.

반환 값

number 선택한 소재의 VAST 미디어 너비이며, 아무것도 선택하지 않은 경우에는 0입니다.

getWidth

getWidth()는 숫자를 반환합니다.

선택한 광고 소재의 너비를 반환합니다.

반환 값

number 선택한 비선형 광고 소재의 너비이거나 선형 광고 소재의 경우 0입니다.

getWrapperAdIds

getWrapperAdIds()는 문자열의 배열을 반환합니다.

래퍼 광고에 사용되는 광고 ID입니다. 반환된 ID는 인라인 광고(가장 안쪽)에서 시작하고 가장 바깥쪽 래퍼 광고로 이동합니다. 래퍼 광고가 없으면 빈 배열이 반환됩니다.

반환 값

non-null Array of string 광고 ID(인라인 광고에서 시작) 또는 빈 배열(래퍼 광고가 없는 경우)

getWrapperAdSystems

getWrapperAdSystems()가 문자열의 배열을 반환함

래퍼 광고에 사용되는 광고 시스템입니다. 반환된 광고 시스템은 인라인 광고에서 시작하여 가장 바깥쪽 래퍼 광고로 이동합니다. 래퍼 광고가 없으면 빈 배열이 반환됩니다.

반환 값

non-null Array of string 광고의 광고 시스템(인라인 광고에서 시작) 또는 빈 배열(래퍼 광고가 없는 경우)

getWrapperCreativeIds

getWrapperCreativeIds()는 문자열의 배열을 반환합니다.

래퍼 광고에 사용되는 선택된 광고 소재 ID입니다. 반환된 광고 소재 ID는 인라인 광고에서 시작해서 가장 바깥쪽 래퍼 광고로 이동합니다. 래퍼 광고가 없으면 빈 배열이 반환됩니다.

반환 값

non-null Array of string 광고 소재의 ID(인라인 광고에서 시작) 또는 빈 배열(래퍼 광고가 없는 경우)

선형

isLinear()가 불리언을 반환함

광고의 현재 운영 모드가 선형인지 또는 비선형인지를 나타냅니다. 값이 true인 경우 광고가 선형 재생 모드에 있음을 나타냅니다. false인 경우 비선형 모드를 나타냅니다. 플레이어는 선형 속성을 확인하고 광고 게재위치의 세부정보에 따라 상태를 업데이트합니다. 광고가 선형 모드인 경우 플레이어가 콘텐츠 동영상을 일시중지합니다. 처음에 선형이 true이고 광고가 프리롤 (외부에서 정의됨)인 경우 플레이어는 광고 재생이 끝날 때까지 콘텐츠 동영상 로드를 지연하도록 선택할 수 있습니다.

반환 값

boolean 광고가 선형이면 true, 그렇지 않으면 false입니다.