GPT 참조

이 참조에서는 TypeScript 표기법을 사용하여 유형을 설명합니다. 다음 표에서는 예를 들어 간략하게 설명합니다.

유형 표현식
string 기본 문자열 유형입니다.
string[] 값이 문자열만 될 수 있는 배열 유형입니다.
number | string 값이 숫자 또는 문자열일 수 있는 결합 유형입니다.
Array<number | string> 값이 복잡한 (합집합) 유형인 배열 유형입니다.
[number, string] 튜플 유형으로, 값은 숫자와 문자열을 순서대로 포함해야 하는 2요소 배열입니다.
Slot 값이 googletag.Slot의 인스턴스인 객체 유형입니다.
() => void 정의된 인수가 없고 반환 값이 없는 함수 유형입니다.

지원되는 유형 및 유형 표현식에 대한 자세한 내용은 TypeScript 핸드북 을 참고하세요.

형식 주석

변수, 매개변수 이름, 속성 이름 또는 함수 서명 뒤에 오는 콜론은 유형 주석을 나타냅니다. 타입 주석은 콜론 왼쪽에 있는 요소가 허용하거나 반환할 수 있는 타입을 설명합니다. 다음 표에는 이 참조에서 볼 수 있는 유형 주석의 예가 나와 있습니다.

형식 주석
param: string param가 문자열 값을 허용하거나 반환함을 나타냅니다. 이 구문은 변수, 매개변수, 속성, 반환 유형에 사용됩니다.
param?: number | string param가 선택사항이지만 지정된 경우 숫자 또는 문자열을 허용함을 나타냅니다. 이 구문은 매개변수와 속성에 사용됩니다.
...params: Array<() => void> params가 함수를 허용하는 나머지 매개변수 임을 나타냅니다. 나머지 매개변수는 지정된 유형의 값을 무한대로 허용합니다.

googletag

Google 게시자 태그가 API에 사용하는 전역 네임스페이스입니다.
네임스페이스
config
페이지 수준 설정의 기본 구성 인터페이스입니다.
enums
GPT가 enum 유형에 사용하는 네임스페이스입니다.
events
GPT가 이벤트에 사용하는 네임스페이스입니다.
secureSignals
GPT가 보안 신호를 관리하는 데 사용하는 네임스페이스입니다.
인터페이스
CommandArray
명령어 배열은 함수 시퀀스를 허용하고 순서대로 호출합니다.
CompanionAdsService
컴패니언 광고 서비스입니다.
PrivacySettingsConfig
개인 정보 보호 설정의 구성 객체입니다.
PubAdsService
게시자 광고 서비스입니다.
ResponseInformation
단일 광고 응답을 나타내는 객체입니다.
RewardedPayload
보상형 광고와 연결된 리워드를 나타내는 객체입니다.
Service
모든 서비스에 공통적인 메서드가 포함된 기본 서비스 클래스입니다.
SizeMappingBuilder
크기 매핑 사양 객체의 빌더입니다.
Slot
슬롯은 페이지의 단일 광고 슬롯을 나타내는 객체입니다.
유형 별칭
GeneralSize
슬롯의 유효한 크기 구성입니다. 하나 또는 여러 크기일 수 있습니다.
MultiSize
유효한 단일 크기 목록입니다.
NamedSize
슬롯이 가질 수 있는 명명된 크기입니다.
SingleSize
슬롯의 유효한 단일 크기입니다.
SingleSizeArray
[너비, 높이]를 나타내는 숫자 2개의 배열입니다.
SizeMapping
표시 영역 크기와 광고 크기의 매핑입니다.
SizeMappingArray
크기 매핑 목록입니다.
변수
apiReady
GPT API가 로드되어 호출할 준비가 되었음을 나타내는 플래그입니다.
cmd
GPT 관련 호출의 비동기 실행을 위한 전역 명령어 대기열에 대한 참조입니다.
pubadsReady
PubAdsService가 사용 설정되고, 로드되고, 완전히 작동함을 나타내는 플래그입니다.
secureSignalProviders
보안 처리된 신호 제공업체 배열에 대한 참조입니다.
함수
companionAds
CompanionAdsService에 대한 참조를 반환합니다.
defineOutOfPageSlot
주어진 광고 단위 경로를 사용하여 페이지 외부 광고 슬롯을 구성합니다.
defineSlot
주어진 광고 단위 경로와 크기로 광고 슬롯을 구성하고 광고를 포함할 페이지의 div 요소 ID와 연결합니다.
destroySlots
지정된 슬롯을 소멸시켜 GPT에서 해당 슬롯의 모든 관련 객체와 참조를 삭제합니다.
disablePublisherConsole
Google 게시자 콘솔을 사용 중지합니다.
display
슬롯을 렌더링하도록 슬롯 서비스에 지시합니다.
enableServices
페이지의 광고 슬롯에 대해 정의된 모든 GPT 서비스를 사용 설정합니다.
getConfig
setConfig에 의해 설정된 페이지의 일반 구성 옵션을 가져옵니다.
getVersion
현재 GPT 버전을 반환합니다.
openConsole
Google 게시자 콘솔을 엽니다.
pubads
PubAdsService에 대한 참조를 반환합니다.
setAdIframeTitle
이 시점부터 PubAdsService에 의해 생성된 모든 광고 컨테이너 iframe의 제목을 설정합니다.
setConfig
페이지의 일반 구성 옵션을 설정합니다.
sizeMapping
SizeMappingBuilder를 만듭니다.

유형 별칭


GeneralSize

GeneralSize: SingleSize | MultiSize
슬롯의 유효한 크기 구성입니다. 하나 또는 여러 크기일 수 있습니다.

MultiSize

MultiSize: SingleSize[]
유효한 단일 크기 목록입니다.

NamedSize

NamedSize: "fluid" | ["fluid"]
슬롯이 가질 수 있는 명명된 크기입니다. 대부분의 경우 크기는 고정 크기 사각형이지만 다른 종류의 크기 사양이 필요한 경우도 있습니다. 다음만 유효한 명명된 크기입니다.
  • 유동적: 광고 컨테이너가 상위 div의 너비를 100% 차지한 다음 광고 소재 콘텐츠에 맞게 높이를 조정합니다. 페이지의 일반 블록 요소가 작동하는 방식과 유사합니다. 네이티브 광고에 사용됩니다 (관련 도움말 참고). fluid['fluid'] 모두 슬롯 크기를 유동적으로 선언하는 데 허용되는 형식입니다.

SingleSize

슬롯의 유효한 단일 크기입니다.

SingleSizeArray

SingleSizeArray: [number, number]
[너비, 높이]를 나타내는 숫자 2개의 배열입니다.

SizeMapping

표시 영역 크기와 광고 크기의 매핑입니다. 반응형 광고에 사용됩니다.

SizeMappingArray

SizeMappingArray: SizeMapping[]
크기 매핑 목록입니다.

변수


Const apiReady

apiReady: boolean | undefined
GPT API가 로드되어 호출할 준비가 되었음을 나타내는 플래그입니다. 이 속성은 API가 준비될 때까지 undefined입니다.

비동기를 처리하는 권장 방법은 GPT가 준비될 때 콜백을 대기열에 추가하기 위해 googletag.cmd를 사용하는 것입니다. 이러한 콜백은 API가 설정되면 실행되므로 googletag.apiReady를 확인할 필요가 없습니다.

Const cmd

cmd: ((this: typeof globalThis) => void)[] | CommandArray
GPT 관련 호출의 비동기 실행을 위한 전역 명령어 대기열을 참조합니다.

googletag.cmd 변수는 페이지의 GPT 태그 구문에 의해 빈 JavaScript 배열로 초기화되며 cmd.push는 배열 끝에 요소를 추가하는 표준 Array.push 메서드입니다. GPT JavaScript가 로드되면 배열을 살펴보고 모든 함수를 순서대로 실행합니다. 그런 다음 스크립트가 cmd를 push 메서드가 전달된 함수 인수를 실행하도록 정의된 CommandArray 객체로 바꿉니다. 이 메커니즘을 통해 GPT는 브라우저가 페이지를 계속 렌더링하는 동안 JavaScript를 비동기적으로 가져와 인지된 지연 시간을 줄일 수 있습니다.

자바스크립트

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (기존)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});

Const pubadsReady

pubadsReady: boolean | undefined
PubAdsService가 사용 설정되고, 로드되고, 완전히 작동함을 나타내는 플래그입니다. 이 속성은 enableServices가 호출되고 PubAdsService가 로드되고 초기화될 때까지 undefined입니다.

secureSignalProviders

secureSignalProviders: SecureSignalProvider[] | SecureSignalProvidersArray | undefined
보안 처리된 신호 제공업체 배열을 참조합니다.

보안 처리된 신호 제공업체 배열은 신호 생성 함수의 시퀀스를 허용하고 순서대로 호출합니다. GPT가 로드된 후 호출될 신호 생성 함수를 대기열에 추가하는 데 사용되는 표준 배열을 대체하기 위한 것입니다.

자바스크립트

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});

JavaScript (기존)

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    return Promise.resolve("signal");
  },
});

TypeScript

window.googletag = window.googletag || { cmd: [] };
googletag.secureSignalProviders = googletag.secureSignalProviders || [];
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    return Promise.resolve("signal");
  },
});
참고 항목

함수


companionAds

companionAds(): CompanionAdsService
CompanionAdsService에 대한 참조를 반환합니다.
반환 값
CompanionAdsService컴패니언 광고 서비스입니다.

defineOutOfPageSlot

defineOutOfPageSlot(adUnitPath: string, div?: string | OutOfPageFormat): Slot | null
주어진 광고 단위 경로를 사용하여 페이지 외부 광고 슬롯을 구성합니다.

맞춤 페이지 외부 광고의 경우 div는 광고를 포함할 div 요소의 ID입니다. 자세한 내용은 페이지 외부 광고 소재 도움말을 참고하세요.

GPT 관리 페이지 외부 광고의 경우 div이 지원되는 OutOfPageFormat입니다.

자바스크립트

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

JavaScript (기존)

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);

TypeScript

// Define a custom out-of-page ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", "div-1");

// Define a GPT managed web interstitial ad slot.
googletag.defineOutOfPageSlot("/1234567/sports", googletag.enums.OutOfPageFormat.INTERSTITIAL);
참고 항목
매개변수
adUnitPath: string네트워크 코드와 광고 단위 코드가 포함된 전체 광고 단위 경로
Optional div: string | OutOfPageFormat이 광고 단위 또는 OutOfPageFormat을 포함할 div의 ID입니다.
반환 값
Slot | null새로 생성된 슬롯입니다. 슬롯을 생성할 수 없는 경우 null입니다.

defineSlot

defineSlot(adUnitPath: string, size: GeneralSize, div?: string): Slot | null
주어진 광고 단위 경로와 크기로 광고 슬롯을 구성하고 광고가 포함될 페이지의 div 요소 ID와 연결합니다.

자바스크립트

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

JavaScript (기존)

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
참고 항목
매개변수
adUnitPath: string네트워크 코드와 단위 코드가 포함된 전체 광고 단위 경로
size: GeneralSize추가된 슬롯의 너비와 높이입니다. 반응형 크기 매핑이 제공되지 않거나 표시 영역의 크기가 매핑에 제공된 가장 작은 크기보다 작은 경우 광고 요청에 사용되는 크기입니다.
Optional div: string이 광고 단위를 포함할 div의 ID입니다.
반환 값
Slot | null새로 생성된 슬롯입니다. 슬롯을 생성할 수 없는 경우 null입니다.

destroySlots

destroySlots(slots?: Slot[]): boolean
지정된 슬롯을 소멸시켜 GPT에서 해당 슬롯의 모든 관련 객체와 참조를 삭제합니다. 이 API는 패스백 슬롯과 컴패니언 슬롯을 지원하지 않습니다.

슬롯에서 이 API를 호출하면 광고가 지워지고 GPT에서 유지관리하는 내부 상태에서 슬롯 객체가 삭제됩니다. 슬롯 객체에서 함수를 추가로 호출하면 동작이 정의되지 않습니다. 게시자 페이지에서 슬롯에 대한 참조를 유지하는 경우 브라우저에서 해당 슬롯과 연결된 메모리를 해제하지 않을 수 있습니다. 이 API를 호출하면 해당 슬롯과 연결된 div를 재사용할 수 있습니다.

특히 슬롯을 삭제하면 GPT의 장기 페이지 조회에서 광고가 삭제되므로 향후 요청은 이 광고와 관련된 장애물이나 경쟁업체 제외의 영향을 받지 않습니다. 페이지에서 슬롯의 div를 삭제하기 전에 이 함수를 호출하지 않으면 정의되지 않은 동작이 발생합니다.

자바스크립트

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

JavaScript (기존)

// The calls to construct an ad and display contents.
var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();

TypeScript

// The calls to construct an ad and display contents.
const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to destroy only slot1.
googletag.destroySlots([slot1]);

// This call to destroy both slot1 and slot2.
googletag.destroySlots([slot1, slot2]);

// This call to destroy all slots.
googletag.destroySlots();
매개변수
Optional slots: Slot[]삭제할 슬롯의 배열입니다. 배열은 선택사항입니다. 지정하지 않으면 모든 슬롯이 소멸됩니다.
반환 값
boolean슬롯이 소멸된 경우 true, 그렇지 않은 경우 false

disablePublisherConsole

disablePublisherConsole(): void
Google 게시자 콘솔을 사용 중지합니다.
참고 항목

디스플레이

display(divOrSlot: string | Element | Slot): void
슬롯을 렌더링하도록 슬롯 서비스에 지시합니다. 각 광고 슬롯은 페이지당 한 번만 표시되어야 합니다. 모든 슬롯은 정의되어야 하며 표시되기 전에 서비스가 연결되어 있어야 합니다. 요소가 DOM에 표시될 때까지 디스플레이 호출이 발생해서는 안 됩니다. 일반적으로 이 작업을 수행하는 방법은 메서드 호출에서 이름이 지정된 div 요소 내의 스크립트 블록에 배치하는 것입니다.

단일 요청 아키텍처 (SRA)를 사용하는 경우 이 메서드가 호출될 때 가져오지 않은 모든 광고 슬롯이 한 번에 가져옵니다. 광고 슬롯이 표시되지 않도록 하려면 전체 div를 삭제해야 합니다.
참고 항목
매개변수
divOrSlot: string | Element | Slot광고 슬롯 또는 div 요소를 포함하는 div 요소의 ID 또는 슬롯 객체입니다. div 요소가 제공되는 경우 defineSlot에 전달된 ID와 일치하는 'id' 속성이 있어야 합니다.

enableServices

enableServices(): void
페이지의 광고 슬롯에 대해 정의된 모든 GPT 서비스를 사용 설정합니다.

getConfig

getConfig(keys: string | string[]): Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">
setConfig로 설정된 페이지의 일반 구성 옵션을 가져옵니다.

이 메서드에서는 일부 setConfig() 속성만 지원됩니다. 지원되는 속성은 다음과 같습니다.

자바스크립트

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

JavaScript (기존)

// Get the value of the `targeting` setting.
var targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
var config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);

TypeScript

// Get the value of the `targeting` setting.
const targetingConfig = googletag.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `disableInitialLoad` settings.
const config = googletag.getConfig(["adsenseAttributes", "disableInitialLoad"]);
매개변수
keys: string | string[]가져올 구성 옵션의 키입니다.
반환 값
Pick<PageSettingsConfig, "adsenseAttributes" | "disableInitialLoad" | "targeting">슬롯의 구성 옵션입니다.

getVersion

getVersion(): string
현재 버전의 GPT를 반환합니다.
참고 항목
반환 값
string현재 실행 중인 GPT 버전 문자열입니다.

openConsole

openConsole(div?: string): void
Google 게시자 콘솔을 엽니다.

자바스크립트

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

JavaScript (기존)

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();

TypeScript

// Calling with div ID.
googletag.openConsole("div-1");

// Calling without div ID.
googletag.openConsole();
참고 항목
매개변수
Optional div: string광고 슬롯 div ID입니다. 이 값은 선택사항입니다. 제공된 경우 게시자 콘솔이 지정된 광고 슬롯의 세부정보가 표시된 상태로 열립니다.

pubads

pubads(): PubAdsService
PubAdsService에 대한 참조를 반환합니다.
반환 값
PubAdsService게시자 광고 서비스입니다.

setAdIframeTitle

setAdIframeTitle(title: string): void
이 시점 이후로 PubAdsService에 의해 생성된 모든 광고 컨테이너 iframe의 제목을 설정합니다.

자바스크립트

googletag.setAdIframeTitle("title");

JavaScript (기존)

googletag.setAdIframeTitle("title");

TypeScript

googletag.setAdIframeTitle("title");
매개변수
title: string모든 광고 컨테이너 iframe의 새 제목입니다.

setConfig

setConfig(config: PageSettingsConfig): void
페이지의 일반 구성 옵션을 설정합니다.
매개변수
config: PageSettingsConfig

sizeMapping

sizeMapping(): SizeMappingBuilder
SizeMappingBuilder를 만듭니다.
참고 항목
반환 값
SizeMappingBuilder새 빌더

googletag.CommandArray

명령어 배열은 함수 시퀀스를 허용하고 순서대로 호출합니다. GPT가 로드된 후 호출할 함수를 대기열에 추가하는 데 사용되는 표준 배열을 대체하기 위한 것입니다.
메서드
push
인수에 지정된 함수 시퀀스를 순서대로 실행합니다.

메서드


push

push(...f: ((this: typeof globalThis) => void)[]): number
인수에 지정된 함수 시퀀스를 순서대로 실행합니다.

자바스크립트

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

JavaScript (기존)

googletag.cmd.push(function () {
  googletag.defineSlot("/1234567/sports", [160, 600]).addService(googletag.pubads());
});

TypeScript

googletag.cmd.push(() => {
  googletag.defineSlot("/1234567/sports", [160, 600])!.addService(googletag.pubads());
});
매개변수
Rest ...f: ((this: typeof globalThis) => void)[]실행할 JavaScript 함수입니다. 런타임 바인딩은 항상 globalThis입니다. 포함된 어휘 컨텍스트의 this 값을 유지하려면 화살표 함수를 전달하는 것이 좋습니다.
반환 값
number지금까지 처리된 명령어 수입니다. 이는 Array.push의 반환 값 (배열의 현재 길이)과 호환됩니다.

googletag.CompanionAdsService

Service을 확장합니다.
컴패니언 광고 서비스입니다. 이 서비스는 동영상 광고에서 컴패니언 광고를 표시하는 데 사용됩니다.
메서드
addEventListener
페이지에서 특정 GPT 이벤트가 발생할 때 JavaScript 함수를 설정하고 호출할 수 있는 리스너를 등록합니다.
getSlots
이 서비스와 연결된 슬롯 목록을 가져옵니다.
removeEventListener
이전에 등록된 리스너를 삭제합니다.
setRefreshUnfilledSlots
채워지지 않은 컴패니언 광고가 자동으로 백업될지 여부를 설정합니다.
참고 항목

메서드


setRefreshUnfilledSlots

setRefreshUnfilledSlots(value: boolean): void
채워지지 않은 컴패니언 광고가 자동으로 백업되는지 여부를 설정합니다.

이 메서드는 페이지 수명 주기 동안 여러 번 호출하여 백업을 사용 설정하거나 사용 중지할 수 있습니다. PubAdsService에 등록된 광고만 백업됩니다. 정책 제한으로 인해 이 메서드는 Ad Exchange 동영상이 게재될 때 빈 컴패니언 슬롯을 채우도록 설계되지 않았습니다.

자바스크립트

googletag.companionAds().setRefreshUnfilledSlots(true);

JavaScript (기존)

googletag.companionAds().setRefreshUnfilledSlots(true);

TypeScript

googletag.companionAds().setRefreshUnfilledSlots(true);
매개변수
value: booleantrue를 선택하면 채워지지 않은 슬롯이 자동으로 채워지고, false를 선택하면 변경되지 않습니다.

googletag.PrivacySettingsConfig

개인 정보 보호 설정의 구성 객체입니다.
속성
childDirectedTreatment?
페이지를 아동 대상으로 취급해야 하는지 여부를 나타냅니다.
limitedAds?
게시자의 규정 준수 요구사항을 지원하기 위해 제한적인 광고 모드에서 게재가 실행되도록 합니다.
nonPersonalizedAds?
게시자의 규정 준수 요구사항을 지원하기 위해 개인 맞춤이 아닌 광고 모드에서 게재가 실행되도록 지원합니다.
restrictDataProcessing?
게시자의 규정 준수 요구사항을 지원하기 위해 게재가 제한된 처리 모드로 실행되도록 합니다.
trafficSource?
요청이 구매한 트래픽인지 자연 트래픽인지 나타냅니다.
underAgeOfConsent?
광고 요청을 동의 연령 미만 사용자의 요청으로 표시할지 여부를 나타냅니다.
참고 항목

속성


Optional childDirectedTreatment

childDirectedTreatment?: boolean
페이지를 아동 대상으로 취급해야 하는지 여부를 나타냅니다. 구성을 지우려면 null로 설정합니다.

Optional limitedAds

limitedAds?: boolean
게시자의 규정 준수 요구사항을 지원하기 위해 제한적인 광고 모드에서 게재가 실행되도록 지원합니다.

다음 두 가지 방법으로 GPT에 제한적인 광고를 요청하도록 지시할 수 있습니다.
  • IAB TCF v2.0 동의 관리 플랫폼의 신호를 사용하여 자동으로
  • 이 필드의 값을 true로 설정하여 수동으로
제한적인 광고를 수동으로 구성하는 것은 GPT가 제한적인 광고 URL에서 로드되는 경우에만 가능합니다. GPT가 표준 URL에서 로드된 경우 이 설정을 수정하려고 하면 게시자 콘솔 경고가 생성됩니다.

CMP를 사용하는 경우 제한적인 광고를 수동으로 사용 설정할 필요가 없습니다.

자바스크립트

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

JavaScript (기존)

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});

TypeScript

// Manually enable limited ads serving.
// GPT must be loaded from the limited ads URL to configure this setting.
googletag.pubads().setPrivacySettings({
  limitedAds: true,
});
참고 항목

Optional nonPersonalizedAds

nonPersonalizedAds?: boolean
게시자의 규정 준수 요구사항을 지원하기 위해 개인 맞춤이 아닌 광고 모드에서 게재가 실행되도록 지원합니다.

Optional restrictDataProcessing

restrictDataProcessing?: boolean
게시자의 규정 준수 요구사항을 지원하기 위해 게재가 제한된 처리 모드로 실행되도록 합니다.

Optional trafficSource

trafficSource?: TrafficSource
요청이 구매한 트래픽인지 자연 트래픽인지 나타냅니다. 이 값은 Ad Manager 보고의 트래픽 소스 측정기준에 입력됩니다. 설정하지 않으면 보고에서 트래픽 소스가 기본적으로 undefined로 설정됩니다.

자바스크립트

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

JavaScript (기존)

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

TypeScript

// Indicate requests represent organic traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.ORGANIC,
});

// Indicate requests represent purchased traffic.
googletag.pubads().setPrivacySettings({
  trafficSource: googletag.enums.TrafficSource.PURCHASED,
});

Optional underAgeOfConsent

underAgeOfConsent?: boolean
광고 요청을 동의 연령 미만 사용자의 요청으로 표시할지 여부를 나타냅니다. 구성을 지우려면 null로 설정합니다.

googletag.PubAdsService

Service을 확장합니다.
게시자 광고 서비스입니다. 이 서비스는 Google Ad Manager 계정에서 광고를 가져와 표시하는 데 사용됩니다.
메서드
addEventListener
페이지에서 특정 GPT 이벤트가 발생할 때 JavaScript 함수를 설정하고 호출할 수 있는 리스너를 등록합니다.
clear
지정된 슬롯에서 광고를 삭제하고 빈 콘텐츠로 대체합니다.
clearCategoryExclusions
지원 중단되었습니다. 모든 페이지 수준 광고 카테고리 제외 라벨을 지웁니다.
clearTargeting
지원 중단되었습니다. 특정 키 또는 모든 키의 맞춤 타겟팅 매개변수를 지웁니다.
collapseEmptyDivs
지원 중단되었습니다. 표시할 광고 콘텐츠가 없는 경우 페이지에서 공간을 차지하지 않도록 슬롯 div의 축소를 사용 설정합니다.
disableInitialLoad
지원 중단되었습니다. 페이지 로드 시 광고 요청을 사용 중지하지만 PubAdsService.refresh 호출로 광고를 요청할 수 있습니다.
display
주어진 광고 단위 경로와 크기로 광고 슬롯을 구성하고 표시합니다.
enableLazyLoad
지원 중단되었습니다. 구성 객체에 정의된 대로 GPT에서 지연 로딩을 사용 설정합니다.
enableSingleRequest
지원 중단되었습니다. 여러 광고를 동시에 가져오기 위한 단일 요청 모드를 사용 설정합니다.
enableVideoAds
지원 중단되었습니다. 페이지에 동영상 광고가 표시됨을 GPT에 알립니다.
get
지원 중단되었습니다. 지정된 키와 연결된 애드센스 속성의 값을 반환합니다.
getAttributeKeys
지원 중단되었습니다. 이 서비스에 설정된 속성 키를 반환합니다.
getSlots
이 서비스와 연결된 슬롯 목록을 가져옵니다.
getTargeting
지원 중단되었습니다. 설정된 특정 맞춤 서비스 수준 타겟팅 매개변수를 반환합니다.
getTargetingKeys
지원 중단되었습니다. 설정된 모든 맞춤 서비스 수준 타겟팅 키의 목록을 반환합니다.
isInitialLoadDisabled
지원 중단되었습니다. 이전 PubAdsService.disableInitialLoad 호출로 광고의 초기 요청이 사용 중지되었는지 여부를 반환합니다.
refresh
페이지의 특정 슬롯 또는 모든 슬롯에 대한 새 광고를 가져와 표시합니다.
removeEventListener
이전에 등록된 리스너를 삭제합니다.
set
지원 중단되었습니다. 게시자 광고 서비스의 모든 광고 슬롯에 적용되는 애드센스 속성의 값을 설정합니다.
setCategoryExclusion
지원 중단되었습니다. 지정된 라벨 이름에 대해 페이지 수준 광고 카테고리 제외를 설정합니다.
setCentering
지원 중단되었습니다. 광고의 가로 중앙 정렬을 사용 설정하거나 사용 중지합니다.
setForceSafeFrame
지원 중단되었습니다. 페이지의 모든 광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제할지 여부를 구성합니다.
setLocation
지원 중단되었습니다. 광고 항목을 특정 위치에 지리적 타겟팅할 수 있도록 웹사이트에서 위치 정보를 전달합니다.
setPrivacySettings
구성 객체를 사용하여 단일 API에서 모든 개인 정보 보호 설정을 구성할 수 있습니다.
setPublisherProvidedId
게시자가 제공한 ID의 값을 설정합니다.
setSafeFrameConfig
지원 중단되었습니다. SafeFrame 구성의 페이지 수준 환경설정을 설정합니다.
setTargeting
지원 중단되었습니다. 모든 게시자 광고 서비스 광고 슬롯에 적용되는 특정 키의 맞춤 타겟팅 매개변수를 설정합니다.
setVideoContent
지원 중단되었습니다. 타겟팅 및 콘텐츠 제외 목적으로 광고 요청과 함께 전송할 동영상 콘텐츠 정보를 설정합니다.
updateCorrelator
광고 요청과 함께 전송되는 상관자를 변경하여 사실상 새 페이지 조회를 시작합니다.

메서드


clear

clear(slots?: Slot[]): boolean
지정된 슬롯에서 광고를 삭제하고 빈 콘텐츠로 대체합니다. 슬롯이 가져오지 않은 것으로 표시됩니다.

특히 슬롯을 지우면 GPT의 장기 페이지 조회에서 광고가 삭제되므로 향후 요청은 이 광고와 관련된 장애물이나 경쟁업체 제외의 영향을 받지 않습니다.

자바스크립트

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

JavaScript (기존)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to clear only slot1.
googletag.pubads().clear([slot1]);

// This call to clear both slot1 and slot2.
googletag.pubads().clear([slot1, slot2]);

// This call to clear all slots.
googletag.pubads().clear();
매개변수
Optional slots: Slot[]삭제할 슬롯의 배열입니다. 배열은 선택사항이며 지정하지 않으면 모든 슬롯이 삭제됩니다.
반환 값
boolean슬롯이 삭제된 경우 true를 반환하고, 그렇지 않으면 false를 반환합니다.

clearCategoryExclusions

clearCategoryExclusions(): PubAdsService
모든 페이지 수준 광고 카테고리 제외 라벨을 지웁니다. 이 기능은 슬롯을 새로고침하려는 경우에 유용합니다.

자바스크립트

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

JavaScript (기존)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
googletag.pubads().setCategoryExclusion("AirlineAd");

// Make ad requests. No ad with 'AirlineAd' label will be returned.

// Clear category exclusions so all ads can be returned.
googletag.pubads().clearCategoryExclusions();

// Make ad requests. Any ad can be returned.
참고 항목
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

clearTargeting

clearTargeting(key?: string): PubAdsService
특정 키 또는 모든 키의 맞춤 타겟팅 매개변수를 삭제합니다.

자바스크립트

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

JavaScript (기존)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");
googletag.pubads().setTargeting("fruits", "apple");

googletag.pubads().clearTargeting("interests");
// Targeting 'colors' and 'fruits' are still present, while 'interests'
// was cleared.

googletag.pubads().clearTargeting();
// All targeting has been cleared.
참고 항목
매개변수
Optional key: string타겟팅 매개변수 키입니다. 키는 선택사항입니다. 지정하지 않으면 모든 타겟팅 매개변수가 삭제됩니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

collapseEmptyDivs

collapseEmptyDivs(collapseBeforeAdFetch?: boolean): boolean
게재할 광고 콘텐츠가 없는 경우 페이지에서 공간을 차지하지 않도록 슬롯 div를 축소할 수 있습니다. 이 모드는 서비스가 사용 설정되기 전에 설정해야 합니다.
참고 항목
매개변수
Optional collapseBeforeAdFetch: boolean광고를 가져오기 전에도 슬롯을 축소할지 여부입니다. 이 매개변수는 선택사항입니다. 제공되지 않으면 false이 기본값으로 사용됩니다.
반환 값
booleandiv 접기 모드가 사용 설정된 경우 true을 반환하고, 서비스가 사용 설정된 후 메서드가 호출되어 접기 모드를 사용 설정할 수 없는 경우 false을 반환합니다.

disableInitialLoad

disableInitialLoad(): void
페이지 로드 시 광고 요청을 사용 중지하지만 PubAdsService.refresh 호출로 광고를 요청할 수 있습니다. 서비스를 사용 설정하기 전에 설정해야 합니다. 비동기 모드를 사용해야 합니다. 그렇지 않으면 refresh를 사용하여 광고를 요청할 수 없습니다.
참고 항목

디스플레이

display(adUnitPath: string, size: GeneralSize, div?: string | Element, clickUrl?: string): void
주어진 광고 단위 경로와 크기로 광고 슬롯을 구성하고 표시합니다. 이 메서드는 단일 요청 모드에서는 작동하지 않습니다.

참고: 이 메서드가 호출되면 광고 요청을 전송하고 응답을 렌더링할 때 일관성을 유지하기 위해 슬롯과 페이지 상태의 스냅샷이 생성됩니다. 이 메서드가 호출된 후 슬롯 또는 페이지 상태 (타겟팅, 개인 정보 보호 설정, SafeFrame 강제 적용 등)에 적용된 변경사항은 후속 display() 또는 refresh() 요청에만 적용됩니다.

자바스크립트

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

JavaScript (기존)

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");

TypeScript

googletag.pubads().display("/1234567/sports", [728, 90], "div-1");
참고 항목
매개변수
adUnitPath: string렌더링할 슬롯의 광고 단위 경로입니다.
size: GeneralSize슬롯의 너비와 높이입니다.
Optional div: string | Element슬롯이 포함된 div의 ID 또는 div 요소 자체입니다.
Optional clickUrl: string이 슬롯에서 사용할 클릭 URL입니다.

enableLazyLoad

enableLazyLoad(config?: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}): void
구성 객체에 정의된 대로 GPT에서 지연 로딩을 사용 설정합니다. 자세한 예는 지연 로드 샘플을 참고하세요.

참고: SRA의 지연 가져오기는 모든 슬롯이 가져오기 여백 외부에 있는 경우에만 작동합니다.

자바스크립트

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

JavaScript (기존)

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});

TypeScript

googletag.pubads().enableLazyLoad({
  // Fetch slots within 5 viewports.
  fetchMarginPercent: 500,
  // Render slots within 2 viewports.
  renderMarginPercent: 200,
  // Double the above values on mobile.
  mobileScaling: 2.0,
});
참고 항목
매개변수
Optional config: {
  fetchMarginPercent?: number;
  mobileScaling?: number;
  renderMarginPercent?: number;
}
구성 객체를 사용하면 지연 동작을 맞춤설정할 수 있습니다. 생략된 구성은 시간이 지남에 따라 조정되는 Google의 기본값을 사용합니다. 가져오기 여백과 같은 특정 설정을 사용 중지하려면 값을 -1으로 설정합니다.
  • fetchMarginPercent

    광고를 가져오기 전에 슬롯이 현재 표시 영역에서 떨어져 있어야 하는 최소 거리입니다(표시 영역 크기의 비율). 값 0은 '슬롯이 표시 영역에 들어갈 때'를, 100은 '광고가 표시 영역에서 1개 떨어져 있을 때'를 의미합니다.
  • renderMarginPercent

    광고를 렌더링하기 전에 슬롯이 현재 표시 영역에서 떨어져 있어야 하는 최소 거리입니다. 이렇게 하면 광고를 미리 가져올 수 있지만 다른 하위 리소스의 렌더링 및 다운로드는 기다립니다. 이 값은 fetchMarginPercent와 마찬가지로 뷰포트의 백분율로 작동합니다.
  • mobileScaling

    휴대기기의 여백에 적용되는 승수입니다. 이를 통해 모바일과 데스크톱에서 여백을 다르게 설정할 수 있습니다. 예를 들어 값이 2.0이면 휴대기기에서 모든 여백에 2를 곱하여 슬롯을 가져오고 렌더링하기 전의 최소 거리가 늘어납니다.

enableSingleRequest

enableSingleRequest(): boolean
여러 광고를 동시에 가져오기 위한 단일 요청 모드를 사용 설정합니다. 이렇게 하려면 서비스를 사용 설정하기 전에 모든 게시자 광고 슬롯을 정의하고 PubAdsService에 추가해야 합니다. 서비스를 사용 설정하기 전에 단일 요청 모드를 설정해야 합니다.
참고 항목
반환 값
boolean단일 요청 모드가 사용 설정된 경우 true를 반환하고, 서비스가 사용 설정된 후 메서드가 호출되어 단일 요청 모드를 사용 설정할 수 없는 경우 false를 반환합니다.

enableVideoAds

enableVideoAds(): void
페이지에 동영상 광고가 표시됨을 GPT에 알립니다. 이렇게 하면 디스플레이 광고와 동영상 광고에 경쟁 제외 제약 조건이 적용됩니다. 동영상 콘텐츠를 알고 있는 경우 디스플레이 광고에 콘텐츠 제외를 사용할 수 있도록 PubAdsService.setVideoContent를 호출하세요.

get

get(key: string): string
지정된 키와 연결된 애드센스 속성의 값을 반환합니다.

자바스크립트

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (기존)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().get("adsense_background_color");
// Returns '#FFFFFF'.
참고 항목
매개변수
key: string찾을 속성의 이름입니다.
반환 값
string속성 키의 현재 값입니다. 키가 없는 경우 null입니다.

getAttributeKeys

getAttributeKeys(): string[]
이 서비스에 설정된 속성 키를 반환합니다.

자바스크립트

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (기존)

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
googletag.pubads().set("adsense_border_color", "#AABBCC");
googletag.pubads().getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
반환 값
string[]이 서비스에 설정된 속성 키의 배열입니다. 순서가 정의되지 않았습니다.

getTargeting

getTargeting(key: string): string[]
설정된 특정 맞춤 서비스 수준 타겟팅 매개변수를 반환합니다.

자바스크립트

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

JavaScript (기존)

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).

TypeScript

googletag.pubads().setTargeting("interests", "sports");

googletag.pubads().getTargeting("interests");
// Returns ['sports'].

googletag.pubads().getTargeting("age");
// Returns [] (empty array).
매개변수
key: string찾을 타겟팅 키입니다.
반환 값
string[]이 키와 연결된 값 또는 이러한 키가 없는 경우 빈 배열입니다.

getTargetingKeys

getTargetingKeys(): string[]
설정된 모든 맞춤 서비스 수준 타겟팅 키의 목록을 반환합니다.

자바스크립트

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

JavaScript (기존)

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].

TypeScript

googletag.pubads().setTargeting("interests", "sports");
googletag.pubads().setTargeting("colors", "blue");

googletag.pubads().getTargetingKeys();
// Returns ['interests', 'colors'].
반환 값
string[]타겟팅 키의 배열입니다. 순서가 정의되지 않았습니다.

isInitialLoadDisabled

isInitialLoadDisabled(): boolean
이전 PubAdsService.disableInitialLoad 호출로 광고의 초기 요청이 사용 중지되었는지 여부를 반환합니다.
반환 값
boolean이전 PubAdsService.disableInitialLoad 호출이 성공하면 true를 반환하고, 그렇지 않으면 false를 반환합니다.

refresh

refresh(slots?: Slot[], options?: {
  changeCorrelator: boolean;
}): void
페이지의 특정 슬롯 또는 모든 슬롯에 대한 새 광고를 가져와 표시합니다. 비동기 렌더링 모드에서만 작동합니다.

모든 브라우저에서 올바르게 작동하려면 refresh 호출 전에 광고 슬롯의 display를 호출해야 합니다. display 호출을 생략하면 새로고침이 예상치 못한 방식으로 작동할 수 있습니다. 원하는 경우 PubAdsService.disableInitialLoad 메서드를 사용하여 display가 광고를 가져오지 못하도록 할 수 있습니다.

슬롯을 새로고침하면 GPT의 장기 페이지 조회에서 이전 광고가 삭제되므로 향후 요청은 해당 광고와 관련된 차단 또는 경쟁업체 제외의 영향을 받지 않습니다.

자바스크립트

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

JavaScript (기존)

var slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1");
googletag.display("div-1");
var slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2");
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });

TypeScript

const slot1 = googletag.defineSlot("/1234567/sports", [728, 90], "div-1")!;
googletag.display("div-1");
const slot2 = googletag.defineSlot("/1234567/news", [160, 600], "div-2")!;
googletag.display("div-2");

// This call to refresh fetches a new ad for slot1 only.
googletag.pubads().refresh([slot1]);

// This call to refresh fetches a new ad for both slot1 and slot2.
googletag.pubads().refresh([slot1, slot2]);

// This call to refresh fetches a new ad for each slot.
googletag.pubads().refresh();

// This call to refresh fetches a new ad for slot1, without changing
// the correlator.
googletag.pubads().refresh([slot1], { changeCorrelator: false });

// This call to refresh fetches a new ad for each slot, without
// changing the correlator.
googletag.pubads().refresh(null, { changeCorrelator: false });
참고 항목
매개변수
Optional slots: Slot[]새로고침할 슬롯입니다. 배열은 선택사항이며 지정하지 않으면 모든 슬롯이 새로고침됩니다.
Optional options: {
  changeCorrelator: boolean;
}
이 새로고침 호출과 관련된 구성 옵션입니다.
  • changeCorrelator

    광고를 가져오기 위해 새 상관자를 생성할지 여부를 지정합니다. Google 광고 서버는 이 상관자 값을 잠시 동안 (현재 30초, 변경될 수 있음) 유지하므로 비슷한 시기에 함께 들어온 동일한 상관자 값이 있는 요청은 하나의 페이지 조회로 간주됩니다. 기본적으로 새로고침마다 새 상관자가 생성됩니다.

    참고: 이 옵션은 현재 페이지에 있는 광고를 자동으로 반영하고 만료 시간이 없는 GPT의 장기 페이지 조회수에는 영향을 주지 않습니다.

set

set(key: string, value: string): PubAdsService
게시자 광고 서비스의 모든 광고 슬롯에 적용되는 애드센스 속성 값을 설정합니다.

동일한 키에 대해 이 함수를 두 번 이상 호출하면 해당 키에 대해 이전에 설정된 값이 재정의됩니다. display 또는 refresh를 호출하기 전에 모든 값을 설정해야 합니다.

자바스크립트

googletag.pubads().set("adsense_background_color", "#FFFFFF");

JavaScript (기존)

googletag.pubads().set("adsense_background_color", "#FFFFFF");

TypeScript

googletag.pubads().set("adsense_background_color", "#FFFFFF");
참고 항목
매개변수
key: string속성 이름입니다.
value: string속성 값입니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): PubAdsService
지정된 라벨 이름에 페이지 수준 광고 카테고리 제외를 설정합니다.

자바스크립트

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

JavaScript (기존)

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");

TypeScript

// Label = AirlineAd.
googletag.pubads().setCategoryExclusion("AirlineAd");
참고 항목
매개변수
categoryExclusion: string추가할 광고 카테고리 제외 라벨입니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setCentering

setCentering(centerAds: boolean): void
광고의 가로 중앙 정렬을 사용 설정하거나 사용 중지합니다. 가운데 맞춤은 기본적으로 사용 중지되어 있습니다. 기존 gpt_mobile.js에서는 기본적으로 가운데 정렬이 사용 설정됩니다.

이 메서드는 display 또는 refresh를 호출하기 전에 호출해야 합니다. 이 메서드를 호출한 후에 요청된 광고만 가운데 정렬되기 때문입니다.

자바스크립트

// Make ads centered.
googletag.pubads().setCentering(true);

JavaScript (기존)

// Make ads centered.
googletag.pubads().setCentering(true);

TypeScript

// Make ads centered.
googletag.pubads().setCentering(true);
매개변수
centerAds: booleantrue를 눌러 광고를 가운데 정렬하고 false를 눌러 왼쪽 정렬합니다.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): PubAdsService
페이지의 모든 광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제해야 하는지 여부를 구성합니다.

이 API를 사용하는 동안 다음 사항에 유의하세요.
  • 이 설정은 해당 슬롯에 대해 이루어진 후속 광고 요청에만 적용됩니다.
  • 슬롯 수준 설정이 지정된 경우 항상 페이지 수준 설정보다 우선 적용됩니다.
  • true (슬롯 수준 또는 페이지 수준)로 설정된 경우 Google Ad Manager UI에서 선택한 내용과 관계없이 광고가 항상 SafeFrame 컨테이너를 사용하여 렌더링됩니다.
  • 하지만 false로 설정하거나 지정하지 않은 경우 광고 소재 유형과 Google Ad Manager UI에서 선택한 내용에 따라 SafeFrame 컨테이너를 사용하여 광고가 렌더링됩니다.
  • 이 API는 iframe에서 벗어나려고 하거나 게시자 페이지에 직접 렌더링되는 크리에이티브의 동작에 영향을 줄 수 있으므로 주의해서 사용해야 합니다.

자바스크립트

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (기존)

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will be opted-out of the page-level force
// SafeFrame instruction.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setForceSafeFrame(false)
  .addService(googletag.pubads());

// The following slot will have SafeFrame forced.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
참고 항목
매개변수
forceSafeFrame: booleantrue를 사용하여 페이지의 모든 광고가 SafeFrame에서 렌더링되도록 강제하고 false를 사용하여 이전 설정을 false로 변경합니다. 이전에 지정되지 않은 경우 이를 false로 설정해도 아무것도 변경되지 않습니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setLocation

setLocation(address: string): PubAdsService
웹사이트에서 위치 정보를 전달하여 특정 위치에 광고 항목을 지역 타겟팅할 수 있습니다.

자바스크립트

// Postal code:
googletag.pubads().setLocation("10001,US");

JavaScript (기존)

// Postal code:
googletag.pubads().setLocation("10001,US");

TypeScript

// Postal code:
googletag.pubads().setLocation("10001,US");
매개변수
address: string자유 형식 주소입니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setPrivacySettings

setPrivacySettings(privacySettings: PrivacySettingsConfig): PubAdsService
구성 객체를 사용하여 단일 API에서 모든 개인 정보 보호 설정을 구성할 수 있습니다.

자바스크립트

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

JavaScript (기존)

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});

TypeScript

googletag.pubads().setPrivacySettings({
  restrictDataProcessing: true,
});

// Set multiple privacy settings at the same time.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: true,
  underAgeOfConsent: true,
});

// Clear the configuration for childDirectedTreatment.
googletag.pubads().setPrivacySettings({
  childDirectedTreatment: null,
});
참고 항목
매개변수
privacySettings: PrivacySettingsConfig개인 정보 보호 설정 구성을 포함하는 객체입니다.
반환 값
PubAdsService함수가 호출된 서비스 객체입니다.

setPublisherProvidedId

setPublisherProvidedId(ppid: string): PubAdsService
게시자가 제공한 ID의 값을 설정합니다.

자바스크립트

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

JavaScript (기존)

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");

TypeScript

googletag.pubads().setPublisherProvidedId("12JD92JD8078S8J29SDOAKC0EF230337");
참고 항목
매개변수
ppid: string게시자가 제공하는 영숫자 ID입니다. 32~150자(영문 기준)여야 합니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): PubAdsService
SafeFrame 구성의 페이지 수준 환경설정을 설정합니다. 구성 객체에서 인식할 수 없는 키는 무시됩니다. 인식된 키에 잘못된 값이 전달되면 전체 구성이 무시됩니다.

이러한 페이지 수준 환경설정은 지정된 경우 슬롯 수준 환경설정으로 재정의됩니다.

자바스크립트

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (기존)

googletag.pubads().setForceSafeFrame(true);

var pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

var slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

const pageConfig = {
  allowOverlayExpansion: true,
  allowPushExpansion: true,
  sandbox: true,
};

const slotConfig = { allowOverlayExpansion: false };

googletag.pubads().setSafeFrameConfig(pageConfig);

// The following slot will not allow for expansion by overlay.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig(slotConfig)
  .addService(googletag.pubads());

// The following slot will inherit the page level settings, and hence
// would allow for expansion by overlay.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
참고 항목
매개변수
config: SafeFrameConfig구성 객체입니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setTargeting

setTargeting(key: string, value: string | string[]): PubAdsService
모든 게시자 광고 서비스 광고 슬롯에 적용되는 특정 키의 맞춤 타겟팅 매개변수를 설정합니다. 동일한 키에 대해 이 함수를 여러 번 호출하면 이전 값이 덮어쓰여집니다. 이러한 키는 Google Ad Manager 계정에서 정의됩니다.

자바스크립트

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

JavaScript (기존)

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);

TypeScript

// Example with a single value for a key.
googletag.pubads().setTargeting("interests", "sports");

// Example with multiple values for a key inside in an array.
googletag.pubads().setTargeting("interests", ["sports", "music"]);
참고 항목
매개변수
key: string타겟팅 매개변수 키입니다.
value: string | string[]타겟팅 매개변수 값 또는 값 배열입니다.
반환 값
PubAdsService메서드가 호출된 서비스 객체입니다.

setVideoContent

setVideoContent(videoContentId: string, videoCmsId: string): void
타겟팅 및 콘텐츠 제외 목적으로 광고 요청과 함께 전송할 동영상 콘텐츠 정보를 설정합니다. 이 메서드가 호출되면 동영상 광고가 자동으로 사용 설정됩니다. videoContentIdvideoCmsId의 경우 Google Ad Manager 콘텐츠 처리 서비스에 제공된 값을 사용합니다.
참고 항목
매개변수
videoContentId: string동영상 콘텐츠 ID입니다.
videoCmsId: string동영상 CMS ID입니다.

updateCorrelator

updateCorrelator(): PubAdsService
광고 요청과 함께 전송되는 상관자를 변경하여 사실상 새 페이지 조회를 시작합니다. 상관자는 하나의 페이지 조회에서 발생하는 모든 광고 요청에 대해 동일하며 페이지 조회 전체에서는 고유합니다. 비동기 모드에만 적용됩니다.

참고: 이는 페이지에 실제로 있는 광고를 자동으로 반영하고 만료 시간이 없는 GPT의 장기 페이지 조회수에는 영향을 미치지 않습니다.

자바스크립트

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

JavaScript (기존)

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.

TypeScript

// Assume that the correlator is currently 12345. All ad requests made
// by this page will currently use that value.

// Replace the current correlator with a new correlator.
googletag.pubads().updateCorrelator();

// The correlator will now be a new randomly selected value, different
// from 12345. All subsequent ad requests made by this page will use
// the new value.
반환 값
PubAdsService함수가 호출된 서비스 객체입니다.

googletag.ResponseInformation

단일 광고 응답을 나타내는 객체입니다.
속성
advertiserId
광고주의 ID입니다.
campaignId
캠페인의 ID입니다.
creativeId
광고 소재의 ID입니다.
creativeTemplateId
광고의 템플릿 ID입니다.
lineItemId
품목의 ID입니다.
참고 항목

속성


advertiserId

advertiserId: number
광고주의 ID입니다.

campaignId

campaignId: number
캠페인의 ID입니다.

creativeId

creativeId: number
광고 소재의 ID입니다.

creativeTemplateId

creativeTemplateId: number
광고의 템플릿 ID입니다.

lineItemId

lineItemId: number
품목의 ID입니다.

googletag.RewardedPayload

보상형 광고와 연결된 리워드를 나타내는 객체
속성
amount
리워드에 포함된 상품의 수입니다.
type
보상에 포함된 항목의 유형입니다 (예: 'coin').
참고 항목

속성


amount

amount: number
리워드에 포함된 상품의 수입니다.

type

type: string
보상에 포함된 항목의 유형입니다 (예: 'coin').

googletag.Service

모든 서비스에 공통적인 메서드가 포함된 기본 서비스 클래스입니다.
메서드
addEventListener
페이지에서 특정 GPT 이벤트가 발생할 때 JavaScript 함수를 설정하고 호출할 수 있는 리스너를 등록합니다.
getSlots
이 서비스와 연결된 슬롯 목록을 가져옵니다.
removeEventListener
이전에 등록된 리스너를 삭제합니다.

메서드


addEventListener

addEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((arg: EventTypeMap[K]) => void)): Service
페이지에서 특정 GPT 이벤트가 발생할 때 JavaScript 함수를 설정하고 호출할 수 있는 리스너를 등록합니다. 지원되는 이벤트는 다음과 같습니다. 호출될 때 적절한 이벤트 유형의 객체가 리스너에 전달됩니다.

자바스크립트

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", function (event) {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// 1. Adding an event listener for the PubAdsService.
googletag.pubads().addEventListener("slotOnload", (event) => {
  console.log("Slot has been loaded:");
  console.log(event);
});

// 2. Adding an event listener with slot specific logic.
// Listeners operate at service level, which means that you cannot add
// a listener for an event for a specific slot only. You can, however,
// programmatically filter a listener to respond only to a certain ad
// slot, using this pattern:
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  if (event.slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목
매개변수
eventType: KGPT에서 생성된 이벤트 유형을 나타내는 문자열입니다. 이벤트 유형은 대소문자를 구분합니다.
listener: ((arg: EventTypeMap[K]) => void)단일 이벤트 객체 인수를 사용하는 함수
반환 값
Service메서드가 호출된 서비스 객체입니다.

getSlots

getSlots(): Slot[]
이 서비스와 연결된 슬롯 목록을 가져옵니다.
반환 값
Slot[]슬롯은 서비스에 추가된 순서대로 표시됩니다.

removeEventListener

removeEventListener<K extends keyof EventTypeMap>(eventType: K, listener: ((event: EventTypeMap[K]) => void)): void
이전에 등록된 리스너를 삭제합니다.

자바스크립트

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

JavaScript (기존)

googletag.cmd.push(function () {
  // Define a new ad slot.
  googletag.defineSlot("/6355419/Travel", [728, 90], "div-for-slot").addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  var onViewableListener = function (event) {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(function () {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});

TypeScript

googletag.cmd.push(() => {
  // Define a new ad slot.
  googletag
    .defineSlot("/6355419/Travel", [728, 90], "div-for-slot")!
    .addService(googletag.pubads());

  // Define a new function that removes itself via removeEventListener
  // after the impressionViewable event fires.
  const onViewableListener = (event: googletag.events.ImpressionViewableEvent) => {
    googletag.pubads().removeEventListener("impressionViewable", onViewableListener);
    setTimeout(() => {
      googletag.pubads().refresh([event.slot]);
    }, 30000);
  };

  // Add onViewableListener as a listener for impressionViewable events.
  googletag.pubads().addEventListener("impressionViewable", onViewableListener);
  googletag.enableServices();
});
매개변수
eventType: KGPT에서 생성된 이벤트 유형을 나타내는 문자열입니다. 이벤트 유형은 대소문자를 구분합니다.
listener: ((event: EventTypeMap[K]) => void)단일 이벤트 객체 인수를 사용하는 함수

googletag.SizeMappingBuilder

크기 매핑 사양 객체의 빌더입니다. 이 빌더는 크기 사양을 쉽게 구성할 수 있도록 제공됩니다.
메서드
addSize
단일 크기 배열 (표시 영역을 나타냄)에서 슬롯을 나타내는 단일 또는 다중 크기 배열로의 매핑을 추가합니다.
build
이 빌더에 추가된 매핑에서 사이즈 맵 사양을 빌드합니다.
참고 항목

메서드


addSize

addSize(viewportSize: SingleSizeArray, slotSize: GeneralSize): SizeMappingBuilder
단일 크기 배열 (표시 영역을 나타냄)에서 슬롯을 나타내는 단일 또는 다중 크기 배열로의 매핑을 추가합니다.

자바스크립트

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

JavaScript (기존)

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]

TypeScript

// Mapping 1
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [728, 90])
  .addSize([640, 480], "fluid")
  .addSize([0, 0], [88, 31]) // All viewports &lt; 640x480
  .build();

// Mapping 2
googletag
  .sizeMapping()
  .addSize([1024, 768], [970, 250])
  .addSize([980, 690], [])
  .addSize([640, 480], [120, 60])
  .addSize([0, 0], [])
  .build();

// Mapping 2 will not show any ads for the following viewport sizes:
// [1024, 768] > size >= [980, 690] and
// [640, 480] > size >= [0, 0]
매개변수
viewportSize: SingleSizeArray이 매핑 항목의 표시 영역 크기입니다.
slotSize: GeneralSize이 매핑 항목의 슬롯 크기입니다.
반환 값
SizeMappingBuilder이 빌더에 대한 참조입니다.

build

build(): SizeMappingArray
이 빌더에 추가된 매핑에서 크기 맵 사양을 빌드합니다.

잘못된 매핑이 제공된 경우 이 메서드는 null을 반환합니다. 그렇지 않으면 Slot.defineSizeMapping에 전달할 올바른 형식의 사양을 반환합니다.

참고: 이 메서드를 호출한 후 빌더의 동작은 정의되지 않습니다.
반환 값
SizeMappingArray이 빌더로 빌드된 결과입니다. 잘못된 크기 매핑이 제공된 경우 null일 수 있습니다.

googletag.Slot

슬롯은 페이지의 단일 광고 슬롯을 나타내는 객체입니다.
메서드
addService
이 슬롯에 서비스를 추가합니다.
clearCategoryExclusions
지원 중단되었습니다. 이 슬롯의 모든 슬롯 수준 광고 카테고리 제외 라벨을 지웁니다.
clearTargeting
지원 중단되었습니다. 이 슬롯의 특정 또는 모든 맞춤 슬롯 수준 타겟팅 매개변수를 지웁니다.
defineSizeMapping
이 슬롯의 최소 뷰포트 크기에서 슬롯 크기로의 매핑 배열을 설정합니다.
get
지원 중단되었습니다. 이 슬롯의 주어진 키와 연결된 애드센스 속성 값을 반환합니다.
getAdUnitPath
네트워크 코드와 광고 단위 경로가 포함된 광고 단위의 전체 경로를 반환합니다.
getAttributeKeys
지원 중단되었습니다. 이 슬롯에 설정된 속성 키 목록을 반환합니다.
getCategoryExclusions
지원 중단되었습니다. 이 슬롯의 광고 카테고리 제외 라벨을 반환합니다.
getConfig
setConfig로 설정된 슬롯의 일반 구성 옵션을 가져옵니다.
getResponseInformation
광고 응답 정보를 반환합니다.
getSlotElementId
슬롯이 정의될 때 제공된 슬롯 div의 ID를 반환합니다.
getTargeting
지원 중단되었습니다. 이 슬롯에 설정된 특정 맞춤 타겟팅 매개변수 세트를 반환합니다.
getTargetingKeys
지원 중단되었습니다. 이 슬롯에 설정된 모든 맞춤 타겟팅 키의 목록을 반환합니다.
set
지원 중단되었습니다. 이 광고 슬롯의 애드센스 속성 값을 설정합니다.
setCategoryExclusion
지원 중단되었습니다. 이 슬롯에 슬롯 수준 광고 카테고리 제외 라벨을 설정합니다.
setClickUrl
지원 중단되었습니다. 사용자가 광고를 클릭한 후 리디렉션되는 클릭 URL을 설정합니다.
setCollapseEmptyDiv
지원 중단되었습니다. 슬롯에 광고가 없을 때 슬롯 div을 숨길지 여부를 설정합니다.
setConfig
이 슬롯의 일반 구성 옵션을 설정합니다.
setForceSafeFrame
지원 중단되었습니다. 이 슬롯의 광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제해야 하는지 여부를 구성합니다.
setSafeFrameConfig
지원 중단되었습니다. SafeFrame 구성의 슬롯 수준 환경설정을 설정합니다.
setTargeting
지원 중단되었습니다. 이 슬롯의 맞춤 타겟팅 매개변수를 설정합니다.
updateTargetingFromMap
지원 중단되었습니다. JSON 객체의 key:value 맵에서 이 슬롯의 맞춤 타겟팅 매개변수를 설정합니다.

메서드


addService

addService(service: Service): Slot
이 슬롯에 서비스를 추가합니다.

자바스크립트

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

JavaScript (기존)

googletag.defineSlot("/1234567/sports", [160, 600], "div").addService(googletag.pubads());

TypeScript

googletag.defineSlot("/1234567/sports", [160, 600], "div")!.addService(googletag.pubads());
참고 항목
매개변수
service: Service추가할 서비스입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

clearCategoryExclusions

clearCategoryExclusions(): Slot
이 슬롯의 모든 슬롯 수준 광고 카테고리 제외 라벨을 지웁니다.

자바스크립트

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

JavaScript (기존)

// Set category exclusion to exclude ads with 'AirlineAd' labels.
var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.

TypeScript

// Set category exclusion to exclude ads with 'AirlineAd' labels.
const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

// Make an ad request. No ad with 'AirlineAd' label will be returned
// for the slot.

// Clear category exclusions so all ads can be returned.
slot.clearCategoryExclusions();

// Make an ad request. Any ad can be returned for the slot.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

clearTargeting

clearTargeting(key?: string): Slot
이 슬롯의 특정 또는 모든 맞춤 슬롯 수준 타겟팅 매개변수를 삭제합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .setTargeting("color", "red")
  .addService(googletag.pubads());

slot.clearTargeting("color");
// Targeting 'allow_expandable' and 'interests' are still present,
// while 'color' was cleared.

slot.clearTargeting();
// All targeting has been cleared.
참고 항목
매개변수
Optional key: string타겟팅 매개변수 키입니다. 키는 선택사항입니다. 지정하지 않으면 모든 타겟팅 매개변수가 삭제됩니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

defineSizeMapping

defineSizeMapping(sizeMapping: SizeMappingArray): Slot
이 슬롯의 최소 표시 영역 크기에서 슬롯 크기로의 매핑 배열을 설정합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

var mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

const mapping = googletag
  .sizeMapping()
  .addSize([100, 100], [88, 31])
  .addSize(
    [320, 400],
    [
      [320, 50],
      [300, 50],
    ],
  )
  .build();

slot.defineSizeMapping(mapping!);
참고 항목
매개변수
sizeMapping: SizeMappingArray크기 매핑의 배열입니다. SizeMappingBuilder를 사용하여 만들 수 있습니다. 각 크기 매핑은 SingleSizeArrayGeneralSize라는 두 요소의 배열입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

get

get(key: string): string
이 슬롯의 주어진 키와 연결된 애드센스 속성 값을 반환합니다. 이 슬롯에서 상속된 서비스 수준 속성을 확인하려면 PubAdsService.get을 사용하세요.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

slot.get("adsense_background_color");
// Returns '#FFFFFF'.
참고 항목
매개변수
key: string찾을 속성의 이름입니다.
반환 값
string속성 키의 현재 값입니다. 키가 없는 경우 null입니다.

getAdUnitPath

getAdUnitPath(): string
네트워크 코드와 광고 단위 경로가 포함된 광고 단위의 전체 경로를 반환합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getAdUnitPath();
// Returns '/1234567/sports'.
반환 값
string광고 단위 경로입니다.

getAttributeKeys

getAttributeKeys(): string[]
이 슬롯에 설정된 속성 키 목록을 반환합니다. 이 슬롯에서 상속된 서비스 수준 속성의 키를 확인하려면 PubAdsService.getAttributeKeys를 사용하세요.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .set("adsense_border_color", "#AABBCC")
  .addService(googletag.pubads());

slot.getAttributeKeys();
// Returns ['adsense_background_color', 'adsense_border_color'].
반환 값
string[]속성 키의 배열입니다. 순서가 정의되지 않았습니다.

getCategoryExclusions

getCategoryExclusions(): string[]
이 슬롯의 광고 카테고리 제외 라벨을 반환합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .setCategoryExclusion("TrainAd")
  .addService(googletag.pubads());

slot.getCategoryExclusions();
// Returns ['AirlineAd', 'TrainAd'].
반환 값
string[]이 슬롯의 광고 카테고리 제외 라벨입니다. 설정된 라벨이 없는 경우 빈 배열입니다.

getConfig

getConfig(keys: string | string[]): Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">
setConfig로 설정된 슬롯의 일반 구성 옵션을 가져옵니다.

이 메서드에서는 일부 setConfig() 속성만 지원됩니다. 지원되는 속성은 다음과 같습니다.

자바스크립트

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

JavaScript (기존)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

// Get the value of the `targeting` setting.
var targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
var config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

// Get the value of the `targeting` setting.
const targetingConfig = slot.getConfig("targeting");

// Get the value of the `adsenseAttributes` and `categoryExclusion` settings.
const config = slot.getConfig(["adsenseAttributes", "categoryExclusion"]);
매개변수
keys: string | string[]가져올 구성 옵션의 키입니다.
반환 값
Pick<SlotSettingsConfig, "adsenseAttributes" | "targeting" | "categoryExclusion">슬롯의 구성 옵션입니다.

getResponseInformation

getResponseInformation(): ResponseInformation
광고 응답 정보를 반환합니다. 이는 슬롯의 마지막 광고 응답을 기반으로 합니다. 슬롯에 광고가 없을 때 이 함수를 호출하면 null가 반환됩니다.
반환 값
ResponseInformation최신 광고 응답 정보입니다. 슬롯에 광고가 없는 경우 null입니다.

getSlotElementId

getSlotElementId(): string
슬롯이 정의될 때 제공된 슬롯 div의 ID를 반환합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

slot.getSlotElementId();
// Returns 'div'.
반환 값
string슬롯 div ID입니다.

getTargeting

getTargeting(key: string): string[]
이 슬롯에 설정된 특정 맞춤 타겟팅 매개변수 세트를 반환합니다. 서비스 수준 타겟팅 매개변수는 포함되지 않습니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .addService(googletag.pubads());

slot.getTargeting("allow_expandable");
// Returns ['true'].

slot.getTargeting("age");
// Returns [] (empty array).
매개변수
key: string찾을 타겟팅 키입니다.
반환 값
string[]이 키와 연결된 값 또는 이러한 키가 없는 경우 빈 배열입니다.

getTargetingKeys

getTargetingKeys(): string[]
이 슬롯에 설정된 모든 맞춤 타겟팅 키의 목록을 반환합니다. 서비스 수준 타겟팅 키는 포함되지 않습니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setTargeting("allow_expandable", "true")
  .setTargeting("interests", ["sports", "music"])
  .addService(googletag.pubads());

slot.getTargetingKeys();
// Returns ['interests', 'allow_expandable'].
반환 값
string[]타겟팅 키의 배열입니다. 순서가 정의되지 않았습니다.

set

set(key: string, value: string): Slot
이 광고 슬롯의 애드센스 속성 값을 설정합니다. 이렇게 하면 이 키에 대해 서비스 수준에서 설정된 값이 재정의됩니다.

동일한 키에 대해 이 메서드를 두 번 이상 호출하면 해당 키에 대해 이전에 설정된 값이 재정의됩니다. display 또는 refresh을 호출하기 전에 모든 값을 설정해야 합니다.

자바스크립트

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

JavaScript (기존)

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());

TypeScript

// Setting an attribute on a single ad slot.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .set("adsense_background_color", "#FFFFFF")
  .addService(googletag.pubads());
참고 항목
매개변수
key: string속성 이름입니다.
value: string속성 값입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setCategoryExclusion

setCategoryExclusion(categoryExclusion: string): Slot
이 슬롯에 슬롯 수준 광고 카테고리 제외 라벨을 설정합니다.

자바스크립트

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

JavaScript (기존)

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());

TypeScript

// Label = AirlineAd
googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setCategoryExclusion("AirlineAd")
  .addService(googletag.pubads());
참고 항목
매개변수
categoryExclusion: string추가할 광고 카테고리 제외 라벨입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setClickUrl

setClickUrl(value: string): Slot
사용자가 광고를 클릭한 후 리디렉션되는 클릭 URL을 설정합니다.

클릭 URL이 대체되더라도 Google Ad Manager 서버는 클릭을 기록합니다. 게재된 광고 소재와 연결된 방문 페이지 URL이 제공된 값에 추가됩니다. 후속 호출은 값을 덮어씁니다. 이는 SRA가 아닌 요청에만 적용됩니다.

자바스크립트

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

JavaScript (기존)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setClickUrl("http://www.example.com?original_click_url=")
  .addService(googletag.pubads());
매개변수
value: string설정할 클릭 URL입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setCollapseEmptyDiv

setCollapseEmptyDiv(collapse: boolean, collapseBeforeAdFetch?: boolean): Slot
슬롯에 광고가 없을 때 슬롯 div을 숨길지 여부를 설정합니다. 이렇게 하면 서비스 수준 설정이 재정의됩니다.

자바스크립트

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

JavaScript (기존)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setCollapseEmptyDiv(true, true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// when the page is loaded, before ads are requested.

googletag
  .defineSlot("/1234567/sports", [160, 600], "div-2")!
  .setCollapseEmptyDiv(true)
  .addService(googletag.pubads());
// The above will cause the div for this slot to be collapsed
// only after GPT detects that no ads are available for the slot.
참고 항목
매개변수
collapse: boolean광고가 반환되지 않은 경우 슬롯을 축소할지 여부입니다.
Optional collapseBeforeAdFetch: boolean광고를 가져오기 전에도 슬롯을 축소할지 여부입니다. 축소가 true이 아니면 무시됩니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setConfig

setConfig(slotConfig: SlotSettingsConfig): void
이 슬롯의 일반 구성 옵션을 설정합니다.
매개변수
slotConfig: SlotSettingsConfig구성 객체입니다.

setForceSafeFrame

setForceSafeFrame(forceSafeFrame: boolean): Slot
이 슬롯의 광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제해야 하는지 여부를 구성합니다.

이 API를 사용하는 동안 다음 사항에 유의하세요.
  • 이 설정은 해당 슬롯에 대해 이루어진 후속 광고 요청에만 적용됩니다.
  • 슬롯 수준 설정이 지정된 경우 항상 페이지 수준 설정보다 우선 적용됩니다.
  • true (슬롯 수준 또는 페이지 수준)로 설정된 경우 Google Ad Manager UI에서 선택한 내용과 관계없이 광고가 항상 SafeFrame 컨테이너를 사용하여 렌더링됩니다.
  • 하지만 false로 설정하거나 지정하지 않은 경우 광고 소재 유형과 Google Ad Manager UI에서 선택한 내용에 따라 SafeFrame 컨테이너를 사용하여 광고가 렌더링됩니다.
  • 이 API는 iframe에서 벗어나려고 하거나 게시자 페이지에 직접 렌더링되는 크리에이티브의 동작에 영향을 줄 수 있으므로 주의해서 사용해야 합니다.

자바스크립트

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

JavaScript (기존)

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .setForceSafeFrame(true)
  .addService(googletag.pubads());

TypeScript

googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .setForceSafeFrame(true)
  .addService(googletag.pubads());
참고 항목
매개변수
forceSafeFrame: booleantrue: 이 슬롯의 모든 광고가 SafeFrame에서 렌더링되도록 강제합니다. false: 페이지 수준 설정 (있는 경우)을 선택 해제합니다. 페이지 수준에서 지정되지 않은 경우 이를 false로 설정해도 아무것도 변경되지 않습니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setSafeFrameConfig

setSafeFrameConfig(config: SafeFrameConfig): Slot
SafeFrame 구성의 슬롯 수준 환경설정을 설정합니다. 구성 객체에서 인식할 수 없는 키는 무시됩니다. 인식된 키에 잘못된 값이 전달되면 전체 구성이 무시됩니다.

이 슬롯 수준 환경설정은 지정된 경우 페이지 수준 환경설정을 재정의합니다.

자바스크립트

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

JavaScript (기존)

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2").addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");

TypeScript

googletag.pubads().setForceSafeFrame(true);

// The following slot will have a sandboxed safeframe that only
// disallows top-level navigation.
googletag
  .defineSlot("/1234567/sports", [160, 600], "div-1")!
  .setSafeFrameConfig({ sandbox: true })
  .addService(googletag.pubads());

// The following slot will inherit page-level settings.
googletag.defineSlot("/1234567/news", [160, 600], "div-2")!.addService(googletag.pubads());

googletag.display("div-1");
googletag.display("div-2");
참고 항목
매개변수
config: SafeFrameConfig구성 객체입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

setTargeting

setTargeting(key: string, value: string | string[]): Slot
이 슬롯의 맞춤 타겟팅 매개변수를 설정합니다. 동일한 키에 대해 이 메서드를 여러 번 호출하면 이전 값이 덮어쓰여집니다. 여기에서 설정된 값은 서비스 수준에서 설정된 타겟팅 매개변수를 덮어씁니다. 이러한 키는 Google Ad Manager 계정에 정의되어 있습니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Example with a single value for a key.
slot.setTargeting("allow_expandable", "true");

// Example with multiple values for a key inside in an array.
slot.setTargeting("interests", ["sports", "music"]);
참고 항목
매개변수
key: string타겟팅 매개변수 키입니다.
value: string | string[]타겟팅 매개변수 값 또는 값 배열입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

updateTargetingFromMap

updateTargetingFromMap(map: {
  [adUnitPath: string]: string | string[];
}): Slot
JSON 객체의 key:value 맵에서 이 슬롯의 맞춤 타겟팅 매개변수를 설정합니다. 이는 객체의 모든 키 값에 대해 Slot.setTargeting을 호출하는 것과 동일합니다. 이러한 키는 Google Ad Manager 계정에 정의되어 있습니다.

참고:
  • 덮어쓰는 경우 마지막 값만 유지됩니다.
  • 값이 배열인 경우 이전 값은 병합되지 않고 덮어쓰여집니다.
  • 여기에서 설정된 값은 서비스 수준에서 설정된 타겟팅 매개변수를 덮어씁니다.

자바스크립트

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

JavaScript (기존)

var slot = googletag.defineSlot("/1234567/sports", [160, 600], "div");

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});

TypeScript

const slot = googletag.defineSlot("/1234567/sports", [160, 600], "div")!;

slot.updateTargetingFromMap({
  color: "red",
  interests: ["sports", "music", "movies"],
});
매개변수
map: {
  [adUnitPath: string]: string | string[];
}
타겟팅 매개변수 key:value 맵입니다.
반환 값
Slot메서드가 호출된 슬롯 객체입니다.

googletag.config

페이지 수준 설정의 기본 구성 인터페이스입니다.
인터페이스
AdExpansionConfig
광고 확장을 제어하는 설정입니다.
AdSenseAttributesConfig
애드센스 광고의 동작을 제어하는 설정입니다.
ComponentAuctionConfig
기기 내 광고 입찰의 단일 구성요소 입찰을 나타내는 객체입니다.
InterstitialConfig
단일 전면 광고 슬롯의 동작을 정의하는 객체입니다.
LazyLoadConfig
GPT에서 지연 로딩 사용을 제어하는 설정입니다.
PageSettingsConfig
페이지 수준 설정의 기본 구성 인터페이스입니다.
PrivacyTreatmentsConfig
게시자 개인 정보 보호 처리를 관리하는 설정입니다.
PublisherProvidedSignalsConfig
게시자 제공 신호 (PPS) 구성 객체입니다.
SafeFrameConfig
GPT에서 SafeFrame을 제어하는 설정입니다.
SlotSettingsConfig
슬롯 수준 설정의 기본 구성 인터페이스입니다.
TaxonomyData
단일 분류의 값을 포함하는 객체입니다.
VideoAdsConfig
동영상 광고 관련 설정을 구성하는 설정입니다.
유형 별칭
CollapseDivBehavior
광고 슬롯의 축소 동작을 제어하는 데 지원되는 값입니다.
InterstitialTrigger
지원되는 전면 광고 트리거입니다.
PrivacyTreatment
지원되는 게시자 개인 정보 보호 처리입니다.
Taxonomy
게시자 제공 신호 (PPS)에 지원되는 분류입니다.

유형 별칭


CollapseDivBehavior

CollapseDivBehavior: "DISABLED" | "BEFORE_FETCH" | "ON_NO_FILL"
광고 슬롯의 접기 동작을 제어하는 데 지원되는 값입니다.
참고 항목

InterstitialTrigger

InterstitialTrigger: "unhideWindow" | "navBar"
지원되는 전면 광고 트리거입니다.

PrivacyTreatment

PrivacyTreatment: "disablePersonalization"
지원되는 게시자 개인 정보 보호 처리입니다.

분류

Taxonomy: "IAB_AUDIENCE_1_1" | "IAB_CONTENT_2_2"
게시자 제공 신호 (PPS)에 지원되는 분류입니다.
참고 항목

googletag.config.AdExpansionConfig

광고 확장을 제어하는 설정입니다.
속성
enabled?
광고 확장이 사용 설정 또는 중지되었는지 여부입니다.

자바스크립트

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

JavaScript (기존)

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

TypeScript

// Enable ad slot expansion across the entire page.
googletag.setConfig({
  adExpansion: { enabled: true },
});

속성


Optional 사용 설정됨

enabled?: boolean
광고 확장이 사용 설정되어 있는지 사용 중지되어 있는지 여부입니다.

이 값을 설정하면 Google Ad Manager에 구성된 기본값이 재정의됩니다.
참고 항목

googletag.config.AdSenseAttributesConfig

애드센스 광고의 동작을 제어하는 설정입니다.

이 속성은 요청별로 서버 측 설정을 재정의하는 데 사용할 수 있습니다.
속성
adsense_ad_format?
애드센스 광고 형식입니다.
adsense_channel_ids?
애드센스 채널 ID입니다.
adsense_test_mode?
테스트 모드의 사용 설정 여부입니다.
document_language?
광고가 표시되는 페이지의 언어입니다.
page_url?
광고가 표시되는 페이지의 URL입니다.
참고 항목

속성


Optional adsense_ad_format

adsense_ad_format?: "120x240_as" | "120x600_as" | "125x125_as" | "160x600_as" | "180x150_as" | "200x200_as" | "234x60_as" | "250x250_as" | "300x250_as" | "336x280_as" | "468x60_as" | "728x90_as"
애드센스 광고 형식입니다.

Optional adsense_channel_ids

adsense_channel_ids?: string
애드센스 채널 ID입니다.

허용되는 값은 '+'로 구분된 채널 ID입니다.

예: 271828183+314159265
참고 항목

Optional adsense_test_mode

adsense_test_mode?: "on"
테스트 모드가 사용 설정되었는지 여부입니다.

on로 설정하면 광고가 테스트 전용으로 표시되며 집계 또는 청구에 포함되지 않습니다. 이 설정은 프로덕션, 비테스트 트래픽에 대해 설정되지 않은 상태여야 합니다.

Optional document_language

document_language?: string
광고가 표시되는 페이지의 언어입니다.

허용되는 값은 유효한 ISO 639-1 언어 코드입니다.

예: en
참고 항목

Optional page_url

page_url?: string
광고가 표시되는 페이지의 URL입니다.

허용되는 값은 유효한 URL입니다.

예: http://www.example.com

googletag.config.ComponentAuctionConfig

기기 내 광고 입찰의 단일 구성요소 입찰을 나타내는 객체입니다.
속성
auctionConfig
이 구성요소 입찰의 입찰 구성 객체입니다.
configKey
이 구성요소 입찰과 연결된 구성 키입니다.
참고 항목

속성


auctionConfig

auctionConfig: {
  auctionSignals?: unknown;
  decisionLogicURL: string;
  interestGroupBuyers?: string[];
  perBuyerExperimentGroupIds?: {
    [buyer: string]: number;
  };
  perBuyerGroupLimits?: {
    [buyer: string]: number;
  };
  perBuyerSignals?: {
    [buyer: string]: unknown;
  };
  perBuyerTimeouts?: {
    [buyer: string]: number;
  };
  seller: string;
  sellerExperimentGroupId?: number;
  sellerSignals?: unknown;
  sellerTimeout?: number;
  trustedScoringSignalsURL?: string;
}
이 구성요소 입찰의 입찰 구성 객체입니다.

이 값이 null로 설정되면 지정된 configKey의 기존 구성이 삭제됩니다.

자바스크립트

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

JavaScript (기존)

var componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

var auctionSlot = googletag.defineSlot("/1234567/example", [160, 600]);

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});

TypeScript

const componentAuctionConfig = {
  // Seller URL should be https and the same as decisionLogicURL's origin
  seller: "https://testSeller.com",
  decisionLogicURL: "https://testSeller.com/ssp/decision-logic.js",
  interestGroupBuyers: ["https://example-buyer.com"],
  auctionSignals: { auction_signals: "auction_signals" },
  sellerSignals: { seller_signals: "seller_signals" },
  perBuyerSignals: {
    // listed on interestGroupBuyers
    "https://example-buyer.com": {
      per_buyer_signals: "per_buyer_signals",
    },
  },
};

const auctionSlot = googletag.defineSlot("/1234567/example", [160, 600])!;

// To add configKey to the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: componentAuctionConfig,
    },
  ],
});

// To remove configKey from the component auction:
auctionSlot.setConfig({
  componentAuction: [
    {
      configKey: "https://testSeller.com",
      auctionConfig: null,
    },
  ],
});
참고 항목

configKey

configKey: string
이 구성요소 입찰과 연결된 구성 키입니다.

이 값은 비워둘 수 없으며 고유해야 합니다. 두 ComponentAuctionConfig 객체가 동일한 configKey 값을 공유하는 경우 마지막으로 설정된 객체가 이전 구성을 덮어씁니다.

googletag.config.InterstitialConfig

단일 전면 광고 슬롯의 동작을 정의하는 객체입니다.
속성
requireStorageAccess?
이 전면 광고를 표시하는 데 로컬 저장소 동의가 필요한지 여부입니다.
triggers?
이 전면 광고의 전면 광고 트리거 구성입니다.

속성


Optional requireStorageAccess

requireStorageAccess?: boolean
이 전면 광고를 표시하는 데 로컬 저장소 동의가 필요한지 여부입니다.

GPT는 로컬 저장소를 사용하여 전면 광고의 최대 게재빈도를 적용합니다. 하지만 로컬 저장소 동의를 제공하지 않은 사용자에게도 전면 광고가 게재될 수 있습니다. 이 속성을 true로 설정하면 기본 동작이 선택 해제되고 로컬 스토리지 동의를 제공한 사용자에게만 전면 광고가 표시됩니다.

자바스크립트

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

JavaScript (기존)

// Opt out of showing interstitials to users
// without local storage consent.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});

TypeScript

// Opt out of showing interstitials to users
// without local storage consent.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

interstitialSlot.setConfig({
  interstitial: {
    requireStorageAccess: true, // defaults to false
  },
});
참고 항목

Optional 트리거

triggers?: Partial<Record<InterstitialTrigger, boolean>>
이 전면 광고의 전면 광고 트리거 구성입니다.

전면 광고 트리거의 값을 true로 설정하면 사용 설정되고 false로 설정하면 사용 중지됩니다. 이렇게 하면 Google Ad Manager에서 구성된 기본값이 재정의됩니다.

자바스크립트

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

JavaScript (기존)

// Define a GPT managed web interstitial ad slot.
var interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
);

// Enable optional interstitial triggers.
// Change this value to false to disable.
var enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});

TypeScript

// Define a GPT managed web interstitial ad slot.
const interstitialSlot = googletag.defineOutOfPageSlot(
  "/1234567/sports",
  googletag.enums.OutOfPageFormat.INTERSTITIAL,
)!;

// Enable optional interstitial triggers.
// Change this value to false to disable.
const enableTriggers = true;

interstitialSlot.setConfig({
  interstitial: {
    triggers: {
      navBar: enableTriggers,
      unhideWindow: enableTriggers,
    },
  },
});
참고 항목

googletag.config.LazyLoadConfig

GPT에서 지연 로딩 사용을 제어하는 설정입니다.
속성
fetchMarginPercent?
광고를 요청하기 전에 슬롯이 현재 표시 영역에서 떨어져 있어야 하는 최소 거리입니다. 표시 영역 크기의 백분율로 표현됩니다.
mobileScaling?
휴대기기의 여백에 적용되는 곱셈수입니다.
renderMarginPercent?
광고를 렌더링하기 전에 슬롯이 현재 표시 영역에서 떨어져 있어야 하는 최소 거리입니다. 표시 영역 크기의 백분율로 표현됩니다.
참고 항목

속성


Optional fetchMarginPercent

fetchMarginPercent?: number
광고를 요청하기 전에 슬롯이 현재 표시 영역에서 떨어져 있어야 하는 최소 거리입니다. 표시 영역 크기의 백분율로 표현됩니다.

renderMarginPercent와 함께 사용되는 이 설정을 사용하면 광고를 미리 가져올 수 있지만 다른 하위 리소스의 렌더링 및 다운로드는 기다릴 수 있습니다. 따라서 이 값은 항상 renderMarginPercent보다 크거나 같아야 합니다.

0 값은 '슬롯이 표시 영역에 진입할 때'를 의미하고, 100 값은 '광고가 표시 영역에서 1만큼 떨어져 있을 때'를 의미합니다.

Optional mobileScaling

mobileScaling?: number
휴대기기의 여백에 적용되는 곱셈수입니다. 이 곱셈기는 fetchMarginPercentrenderMarginPercent 모두에 적용됩니다.

이를 통해 표시 영역 크기와 스크롤 속도가 다를 수 있는 모바일과 데스크톱에서 서로 다른 여백을 사용할 수 있습니다. 예를 들어 값이 2.0이면 모바일 기기에서 모든 여백에 2를 곱하여 가져오기 및 렌더링 전에 슬롯이 표시 영역에서 있을 수 있는 최소 거리가 늘어납니다.

Optional renderMarginPercent

renderMarginPercent?: number
광고를 렌더링하기 전에 슬롯이 현재 뷰포트에서 떨어져 있어야 하는 최소 거리입니다. 뷰포트 크기의 백분율로 표시됩니다.

fetchMarginPercent와 함께 사용되는 이 설정을 사용하면 광고를 미리 가져올 수 있지만 다른 하위 리소스의 렌더링 및 다운로드는 기다릴 수 있습니다. 따라서 이 값은 항상 fetchMarginPercent 이하여야 합니다.

0 값은 '슬롯이 표시 영역에 들어갈 때', 100 값은 '광고가 표시 영역에서 1만큼 떨어져 있을 때'를 의미합니다.

googletag.config.PageSettingsConfig

페이지 수준 설정의 기본 구성 인터페이스입니다.

단일 API 호출로 여러 기능을 설정할 수 있습니다.

아래에 나열된 모든 속성은 예시이며 setConfig를 사용하는 실제 기능을 반영하지 않습니다. 기능 세트는 아래 PageSettingsConfig 유형의 필드를 참고하세요.

예:
  • googletag.setConfig 호출에 지정된 기능만 수정됩니다.
      // Configure feature alpha.
      googletag.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      googletag.setConfig({
         bravo: {...}
      });
  • 특정 기능의 모든 설정은 googletag.setConfig를 호출할 때마다 업데이트됩니다.
      // Configure feature charlie to echo = 1, foxtrot = true.
      googletag.setConfig({
          charlie: {
              echo: 1,
              foxtrot: true,
          }
      });
    
      // Update feature charlie to echo = 2. Since foxtrot was not specified,
      // the value is cleared.
      googletag.setConfig({
          charlie: {
              echo: 2
          }
      });
  • null를 전달하여 기능의 모든 설정을 지울 수 있습니다.
      // Configure features delta, golf, and hotel.
      googletag.setConfig({
          delta: {...},
          golf: {...},
          hotel: {...},
      });
    
      // Feature delta and hotel are cleared, but feature golf remains set.
      googletag.setConfig({
          delta: null,
          hotel: null,
      });
속성
adExpansion?
광고 확장을 제어하는 설정입니다.
adsenseAttributes?
애드센스 속성을 구성하는 설정입니다.
adYield?
지원 중단되었습니다. 
categoryExclusion?
광고 카테고리 제외를 구성하는 설정입니다.
centering?
광고의 가로 가운데 정렬을 제어하는 설정입니다.
collapseDiv?
광고 슬롯의 축소 동작을 제어하는 설정입니다.
disableInitialLoad?
광고가 요청되는 시기를 제어하는 설정입니다.
lazyLoad?
GPT에서 지연 로딩 사용을 제어하는 설정입니다.
location?
광고 항목을 지리적 위치로 지역 타겟팅하는 설정입니다.
pps?
게시자 제공 신호 (PPS)를 제어하는 설정입니다.
privacyTreatments?
게시자 개인 정보 보호 처리를 관리하는 설정입니다.
safeFrame?
GPT에서 SafeFrame 사용을 제어하는 설정입니다.
singleRequest?
단일 요청 아키텍처 (SRA)를 사용 설정하거나 중지하는 설정입니다.
targeting?
키-값 타겟팅을 제어하는 설정입니다.
threadYield?
광고 소재를 요청하고 렌더링할 때 GPT가 JS 스레드를 양보해야 하는지 여부를 제어하는 설정입니다.
videoAds?
동영상 광고를 제어하는 설정입니다.

속성


Optional adExpansion

adExpansion?: AdExpansionConfig
광고 확장을 제어하는 설정입니다.

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
애드센스 속성을 구성하는 설정입니다.

이 설정을 통해 구성된 애드센스 속성은 페이지의 모든 광고 슬롯에 적용됩니다. 이 설정은 여러 속성 값을 정의하거나 기존 값을 덮어쓰기 위해 여러 번 호출될 수 있습니다.

AdSense 속성 변경사항은 이 메서드가 호출된 후에 요청된 광고에만 적용됩니다. 따라서 googletag.display 또는 PubAdsService.refresh를 호출하기 전에 이 메서드를 호출하는 것이 좋습니다.

자바스크립트

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

JavaScript (기존)

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

TypeScript

// Set the document language and page URL.
googletag.setConfig({
  adsenseAttributes: { document_language: "en", page_url: "http://www.example.com" },
});

// Clear the page URL only.
googletag.setConfig({ adsenseAttributes: { page_url: null } });

// Clear all AdSense attributes.
googletag.setConfig({ adsenseAttributes: null });

Optional adYield

adYield?: "DISABLED" | "ENABLED_ALL_SLOTS"

Optional categoryExclusion

categoryExclusion?: string[]
광고 카테고리 제외를 구성하는 설정입니다.

자바스크립트

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

JavaScript (기존)

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });

TypeScript

// Label = AirlineAd.
googletag.setConfig({ categoryExclusion: ["AirlineAd"] });

// Clearing category exclusion setting.
googletag.setConfig({ categoryExclusion: null });
참고 항목

Optional 가운데 맞춤

centering?: boolean
광고의 가로 가운데 정렬을 제어하는 설정입니다. 기본적으로 가운데 맞춤은 사용 중지되어 있습니다.

가로 가운데 맞춤 변경사항은 이 메서드가 호출된 후에 요청된 광고에만 적용됩니다. 따라서 googletag.display 또는 PubAdsService.refresh를 호출하기 전에 이 메서드를 호출하는 것이 좋습니다.

자바스크립트

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

JavaScript (기존)

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

TypeScript

// Make ads centered.
googletag.setConfig({ centering: true });

// Clear the centering setting.
googletag.setConfig({ centering: null });

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
광고 슬롯의 축소 동작을 제어하는 설정입니다.

축소된 광고 슬롯은 페이지에서 공간을 차지하지 않습니다.

지원되는 값:
  • null (기본값): 슬롯이 축소되지 않습니다.
  • DISABLED: 광고가 반환되든 반환되지 않든 슬롯이 축소되지 않습니다.
  • BEFORE_FETCH: 슬롯이 처음에는 축소된 상태로 시작되며 광고가 반환되면 확장됩니다.
  • ON_NO_FILL: 슬롯이 확장된 상태로 시작되며 광고가 반환되지 않으면 축소됩니다.

자바스크립트

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

JavaScript (기존)

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });

TypeScript

// Collapse the div for this slot if no ad is returned.
googletag.setConfig({ collapseDiv: "ON_NO_FILL" });

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
googletag.setConfig({ collapseDiv: "BEFORE_FETCH" });

// Do not collapse the div for this slot.
googletag.setConfig({ collapseDiv: "DISABLED" });

// Clear the collapse setting.
googletag.setConfig({ collapseDiv: null });
참고 항목

Optional disableInitialLoad

disableInitialLoad?: boolean
광고가 요청되는 시기를 제어하는 설정

기본적으로 googletag.display 메서드는 광고 슬롯을 등록하고 해당 슬롯에 대한 광고를 요청합니다. 하지만 광고 콘텐츠가 로드되는 시점을 더 정확하게 제어하기 위해 이러한 작업을 분리하는 것이 더 나은 경우가 있습니다.

이 설정을 사용 설정하면 display() 메서드가 호출될 때 등록된 슬롯에 광고가 요청되지 않습니다. 대신 광고 요청을 시작하려면 PubAdsService.refresh에 대한 별도의 호출을 실행해야 합니다.

이 메서드는 googletag.enableServices를 호출하기 전에 호출해야 합니다.

자바스크립트

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

JavaScript (기존)

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });

TypeScript

// Prevent requesting ads when `display()` is called.
googletag.setConfig({ disableInitialLoad: true });
참고 항목

Optional lazyLoad

lazyLoad?: LazyLoadConfig
GPT에서 지연 로드 사용을 제어하는 설정입니다.

지연 로드는 광고가 사용자의 표시 영역에 접근할 때까지 광고의 요청 및 렌더링을 지연하는 기법입니다. 자세한 예는 지연 로드 샘플을 참고하세요.

참고: singleRequest가 사용 설정된 경우 지연 가져오기는 모든 슬롯이 가져오기 여백 외부에 있는 경우에만 작동합니다.

setConfig()를 호출할 때 지정되지 않은 지연 로드 설정은 Google에서 설정한 기본값을 사용합니다. 이러한 기본값은 시간이 지남에 따라 조정될 수 있습니다. 특정 설정을 사용 중지하려면 값을 null으로 설정합니다.

자바스크립트

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

JavaScript (기존)

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });

TypeScript

// Enable lazy loading.
googletag.setConfig({
  lazyLoad: {
    // Fetch slots within 5 viewports.
    fetchMarginPercent: 500,
    // Render slots within 2 viewports.
    renderMarginPercent: 200,
    // Double the above values on mobile.
    mobileScaling: 2.0,
  },
});

// Clear fetch margin only.
googletag.setConfig({
  lazyLoad: { fetchMarginPercent: null },
});

// Clear all lazy loading settings.
googletag.setConfig({ lazyLoad: null });
참고 항목

Optional 위치

location?: string
광고 항목을 지리적 위치에 따라 타겟팅하는 설정입니다.

자바스크립트

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

JavaScript (기존)

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });

TypeScript

// Geo-target line items to US postal code 10001.
googletag.setConfig({ location: "10001,US" });

// Clear the location setting.
googletag.setConfig({ location: null });
참고 항목

Optional pps

게시자 제공 신호 (PPS)를 제어하는 설정입니다.

Optional privacyTreatments

privacyTreatments?: PrivacyTreatmentsConfig
게시자 개인 정보 보호 처리를 관리하는 설정입니다.

Optional safeFrame

safeFrame?: SafeFrameConfig
GPT에서 SafeFrame 사용을 제어하는 설정입니다.

이 설정을 통해 구성된 값은 페이지의 모든 광고 슬롯에 적용됩니다. 개별 광고 슬롯은 SlotSettingsConfig.safeFrame을 통해 이러한 값을 재정의할 수 있습니다.

자바스크립트

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

JavaScript (기존)

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

TypeScript

// Force SafeFrame for all ads on the page.
googletag.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion.
googletag.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting.
googletag.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings.
googletag.setConfig({ safeFrame: null });

Optional singleRequest

singleRequest?: boolean
단일 요청 아키텍처 (SRA)를 사용 설정 또는 중지하는 설정입니다.

SRA가 사용 설정되면 googletag.display 또는 PubAdsService.refresh 호출 전에 정의된 모든 광고 슬롯이 단일 광고 요청으로 일괄 처리됩니다. 이렇게 하면 성능이 향상될 뿐만 아니라 로드블록과 경쟁 제외가 적용됩니다.

SRA가 사용 중지되면 각 광고 슬롯이 개별적으로 요청됩니다. 이는 GPT의 기본 동작입니다.

이 메서드는 googletag.enableServices를 호출하기 전에 호출해야 합니다.

자바스크립트

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

JavaScript (기존)

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });

TypeScript

// Enable Single Request Architecture.
googletag.setConfig({ singleRequest: true });
참고 항목

Optional 타겟팅

targeting?: Record<string, string | string[]>
키-값 타겟팅을 제어하는 설정입니다.

이 설정을 통해 구성된 타겟팅은 페이지의 모든 광고 슬롯에 적용됩니다. 이 설정은 여러 타겟팅 키-값을 정의하거나 기존 값을 덮어쓰기 위해 여러 번 호출될 수 있습니다. 타겟팅 키는 Google Ad Manager 계정에서 정의됩니다.

자바스크립트

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

JavaScript (기존)

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });

TypeScript

// Setting a single targeting key-value.
googletag.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key
googletag.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
googletag.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
googletag.setConfig({ targeting: { interests: null } });
참고 항목

Optional threadYield

threadYield?: "DISABLED" | "ENABLED_ALL_SLOTS"
광고 소재를 요청하고 렌더링할 때 GPT가 JS 스레드를 양보해야 하는지 여부를 제어하는 설정입니다.

GPT는 Scheduler.postTask 또는 Scheduler.yield API를 지원하는 브라우저에 대해서만 양보합니다.

지원되는 값:
  • null (기본값): GPT는 표시 영역 외부에 있는 슬롯에 대해 JS 스레드를 생성합니다.
  • ENABLED_ALL_SLOTS: 슬롯이 표시 영역 내에 있는지 여부와 관계없이 GPT는 모든 슬롯에 대해 JS 스레드를 생성합니다.
  • DISABLED: GPT가 JS 스레드를 생성하지 않습니다.

자바스크립트

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

JavaScript (기존)

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });

TypeScript

// Disable yielding.
googletag.setConfig({ threadYield: "DISABLED" });

// Enable yielding for all slots.
googletag.setConfig({ threadYield: "ENABLED_ALL_SLOTS" });

// Enable yielding only for slots outside of the viewport (default).
googletag.setConfig({ threadYield: null });
참고 항목

Optional videoAds

videoAds?: VideoAdsConfig
동영상 광고를 관리하는 설정입니다.

자바스크립트

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

JavaScript (기존)

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});

TypeScript

// Enable video ads and set video content and content source IDs.
googletag.setConfig({
  videoAds: {
    enableVideoAds: true,
    videoContentId: "e1eGlRL7ju8",
    videoCmsId: "1234567",
  },
});
참고 항목

googletag.config.PrivacyTreatmentsConfig

게시자 개인 정보 보호 처리를 관리하는 설정입니다.
속성
treatments
사용 설정할 게시자 개인 정보 보호 처리의 배열입니다.

속성


치료

treatments: "disablePersonalization"[]
사용 설정할 게시자 개인 정보 보호 처리의 배열입니다.

자바스크립트

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

JavaScript (기존)

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

TypeScript

// Disable personalization across the entire page.
googletag.setConfig({
  privacyTreatments: { treatments: ["disablePersonalization"] },
});

googletag.config.PublisherProvidedSignalsConfig

게시자 제공 신호 (PPS) 구성 객체입니다.
속성
taxonomies
분류 매핑이 포함된 객체 또는 구성을 지우는 null입니다.

자바스크립트

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

JavaScript (기존)

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});

TypeScript

googletag.setConfig({
  pps: {
    taxonomies: {
      IAB_AUDIENCE_1_1: { values: ["6", "626"] },
      // '6' = 'Demographic | Age Range | 30-34'
      // '626' = 'Interest | Sports | Darts'
      IAB_CONTENT_2_2: { values: ["48", "127"] },
      // '48' = 'Books and Literature | Fiction'
      // '127' = 'Careers | Job Search'
    },
  },
});
참고 항목

속성


taxonomies

taxonomies: Partial<Record<Taxonomy, TaxonomyData>>
분류 매핑이 포함된 객체 또는 구성을 지우는 null입니다.

googletag.config.SafeFrameConfig

GPT에서 SafeFrame을 제어하는 설정입니다.
속성
allowOverlayExpansion?
SafeFrame에서 광고 콘텐츠가 페이지 콘텐츠를 오버레이하여 확장되도록 허용할지 여부입니다.
allowPushExpansion?
SafeFrame에서 광고 콘텐츠가 페이지 콘텐츠를 푸시하여 확장되도록 허용해야 하는지 여부입니다.
forceSafeFrame?
광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제해야 하는지 여부입니다.
sandbox?
SafeFrame이 사용자 상호작용 없이 최상위 탐색을 방지하기 위해 HTML5 샌드박스 속성을 사용해야 하는지 여부입니다.
useUniqueDomain?
지원 중단되었습니다. SafeFrame이 예약 광고 소재에 임의 하위 도메인을 사용해야 하는지 여부입니다.
참고 항목

속성


Optional allowOverlayExpansion

allowOverlayExpansion?: boolean
SafeFrame에서 광고 콘텐츠가 페이지 콘텐츠를 오버레이하여 확장되도록 허용할지 여부입니다.

Optional allowPushExpansion

allowPushExpansion?: boolean
SafeFrame에서 광고 콘텐츠가 페이지 콘텐츠를 푸시하여 확장되도록 허용해야 하는지 여부입니다.

Optional forceSafeFrame

forceSafeFrame?: boolean
광고가 SafeFrame 컨테이너를 사용하여 렌더링되도록 강제해야 하는지 여부입니다.

Optional 샌드박스

sandbox?: boolean
SafeFrame이 사용자 상호작용 없이 최상위 탐색을 방지하기 위해 HTML5 샌드박스 속성을 사용해야 하는지 여부입니다. 유효한 값은 true뿐입니다 (false로 강제할 수 없음). 샌드박스 속성은 플러그인 (예: Flash)을 사용 중지합니다.

Optional useUniqueDomain

useUniqueDomain?: boolean
SafeFrame이 예약 광고 소재에 임의 하위 도메인을 사용해야 하는지 여부입니다. 저장된 값을 지우려면 null를 전달하세요.

참고: 이 기능은 기본적으로 사용 설정되어 있습니다.
참고 항목

googletag.config.SlotSettingsConfig

슬롯 수준 설정의 기본 구성 인터페이스입니다.

단일 슬롯에 대해 단일 API 호출로 여러 기능을 설정할 수 있습니다.

아래에 나열된 모든 속성은 예시이며 setConfig를 사용하는 실제 기능을 반영하지 않습니다. 기능 세트는 아래의 SlotSettingsConfig 유형 내 필드를 참고하세요.

예:
  • Slot.setConfig 호출에 지정된 기능만 수정됩니다.
      const slot = googletag.defineSlot("/1234567/example", [160, 600]);
    
      // Configure feature alpha.
      slot.setConfig({
          alpha: {...}
      });
    
      // Configure feature bravo. Feature alpha is unchanged.
      slot.setConfig({
         bravo: {...}
      });
  • 특정 기능의 모든 설정은 Slot.setConfig를 호출할 때마다 업데이트됩니다.
      // Configure feature charlie to echo = 1, foxtrot = true.
      slot.setConfig({
          charlie: {
              echo: 1,
              foxtrot: true,
          }
      });
    
      // Update feature charlie to echo = 2. Since foxtrot was not specified,
      // the value is cleared.
      slot.setConfig({
          charlie: {
              echo: 2
          }
      });
  • null를 전달하여 기능의 모든 설정을 지울 수 있습니다.
      // Configure features delta, golf, and hotel.
      slot.setConfig({
          delta: {...},
          golf: {...},
          hotel: {...},
      });
    
      // Feature delta and hotel are cleared, but feature golf remains set.
      slot.setConfig({
          delta: null,
          hotel: null,
      });
속성
adExpansion?
광고 확장을 구성하는 설정입니다.
adsenseAttributes?
애드센스 속성을 구성하는 설정입니다.
categoryExclusion?
광고 카테고리 제외를 구성하는 설정입니다.
clickUrl?
사용자가 광고를 클릭한 후 리디렉션될 URL을 구성하는 설정입니다.
collapseDiv?
광고 슬롯의 접기 동작을 구성하는 설정입니다.
componentAuction?
기기 내 광고 입찰에 포함할 구성요소 입찰의 배열입니다.
interstitial?
전면 광고 슬롯 동작을 구성하는 설정입니다.
safeFrame?
GPT에서 SafeFrame 사용을 구성하는 설정입니다.
targeting?
키-값 타겟팅을 구성하는 설정입니다.

속성


Optional adExpansion

adExpansion?: AdExpansionConfig
광고 확장을 구성하는 설정입니다.
참고 항목

Optional adsenseAttributes

adsenseAttributes?: AdSenseAttributesConfig
애드센스 속성을 구성하는 설정입니다.

이 설정을 통해 구성된 애드센스 속성은 광고 슬롯에만 적용됩니다. 이 설정은 여러 속성 값을 정의하거나 기존 값을 덮어쓰기 위해 여러 번 호출될 수 있습니다.

AdSense 속성 변경사항은 이 메서드가 호출된 후에 요청된 광고에만 적용됩니다. 따라서 googletag.display 또는 PubAdsService.refresh를 호출하기 전에 이 메서드를 호출하는 것이 좋습니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Set the AdSense ad format and channel IDs.
slot.setConfig({
  adsenseAttributes: {
    adsense_ad_format: "120x240_as",
    adsense_channel_ids: "271828183+314159265",
  },
});

// Clear the AdSense channel IDs only.
slot.setConfig({ adsenseAttributes: { adsense_channel_ids: null } });

// Clear all AdSense attributes.
slot.setConfig({ adsenseAttributes: null });

Optional categoryExclusion

categoryExclusion?: string[]
광고 카테고리 제외를 구성하는 설정입니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Label = AirlineAd
slot.setConfig({
  categoryExclusion: ["AirlineAd"],
});

// Clearing category exclusion setting.
slot.setConfig({ categoryExclusion: null });
참고 항목

Optional clickUrl

clickUrl?: string
사용자가 광고를 클릭한 후 리디렉션되는 URL을 구성하는 설정입니다.

클릭 URL이 대체되더라도 Google Ad Manager 서버는 클릭을 기록합니다. 게재된 광고 소재와 연결된 방문 페이지 URL이 제공된 값에 추가됩니다. 이 값을 두 번 이상 설정하면 이전에 구성된 값이 덮어쓰여집니다. null을 전달하면 값이 삭제됩니다.

참고: 이 설정은 SRA 이외의 요청에만 적용됩니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Sets the click URL to 'http://www.example.com?original_click_url='.
slot.setConfig({
  clickUrl: "http://www.example.com?original_click_url=",
});

// Clears the click URL.
slot.setConfig({
  clickUrl: null,
});

Optional collapseDiv

collapseDiv?: CollapseDivBehavior
광고 슬롯의 축소 동작을 구성하는 설정입니다.

축소된 광고 슬롯은 페이지에서 공간을 차지하지 않습니다.

지원되는 값:
  • null (기본값): 슬롯이 축소되지 않습니다.
  • DISABLED: 광고가 반환되든 반환되지 않든 슬롯이 축소되지 않습니다.
  • BEFORE_FETCH: 슬롯이 처음에는 축소된 상태로 시작되며 광고가 반환되면 확장됩니다.
  • ON_NO_FILL: 슬롯이 확장된 상태로 시작되며 광고가 반환되지 않으면 축소됩니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Collapse the div for this slot if no ad is returned.
slot.setConfig({
  collapseDiv: "ON_NO_FILL",
});

// Collapse the div for this slot by default, and expand only
// if an ad is returned.
slot.setConfig({
  collapseDiv: "BEFORE_FETCH",
});

// Do not collapse the div for this slot.
slot.setConfig({
  collapseDiv: "DISABLED",
});

// Clear the collapse setting.
slot.setConfig({
  collapseDiv: null,
});
참고 항목

Optional componentAuction

componentAuction?: ComponentAuctionConfig[]
기기 내 광고 입찰에 포함할 구성요소 입찰의 배열입니다.

Optional 전면 광고

interstitial?: InterstitialConfig
전면 광고 슬롯 동작을 구성하는 설정입니다.
참고 항목

Optional safeFrame

safeFrame?: SafeFrameConfig
GPT에서 SafeFrame 사용을 구성하는 설정입니다.

이 설정을 통해 구성된 값은 광고 슬롯에만 적용되며 PageSettingsConfig.safeFrame을 통해 설정된 값을 재정의합니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Force SafeFrame for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: true },
});

// Configure SafeFrame to allow overlay expansion for the slot.
slot.setConfig({
  safeFrame: { allowOverlayExpansion: true },
});

// Clear forceSafeFrame setting for the slot.
slot.setConfig({
  safeFrame: { forceSafeFrame: null },
});

// Clear all SafeFrame settings for the slot.
slot.setConfig({ safeFrame: null });

Optional 타겟팅

targeting?: Record<string, string | string[]>
키-값 타겟팅을 구성하는 설정입니다.

이 설정을 통해 구성된 타겟팅은 광고 슬롯에만 적용됩니다. 이 설정은 여러 타겟팅 키-값을 정의하거나 기존 값을 덮어쓰기 위해 여러 번 호출될 수 있습니다. 타겟팅 키는 Google Ad Manager 계정에서 정의됩니다.

자바스크립트

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

JavaScript (기존)

var slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });

TypeScript

const slot = googletag
  .defineSlot("/1234567/sports", [160, 600], "div")!
  .addService(googletag.pubads());

// Setting a single targeting key-value.
slot.setConfig({ targeting: { interests: "sports" } });

// Setting multiple values for a single targeting key.
slot.setConfig({ targeting: { interests: ["sports", "music"] } });

// Setting multiple targeting key-values at once.
slot.setConfig({ targeting: { interests: ["sports", "music"], color: "red" } });

// Clearing a single targeting key.
slot.setConfig({ targeting: { interests: null } });

// Clear all targeting keys.
slot.setConfig({ targeting: null });
참고 항목

googletag.config.TaxonomyData

단일 분류의 값을 포함하는 객체입니다.
속성
values
분류 값의 목록입니다.

속성


values

values: readonly string[]
분류 값의 목록입니다.

googletag.config.VideoAdsConfig

동영상 광고 관련 설정을 구성하는 설정입니다.
속성
enableVideoAds
페이지에 동영상 광고가 표시되는지 여부입니다.
videoCmsId?
동영상 콘텐츠 소스 ID입니다.
videoContentId?
동영상 콘텐츠 ID입니다.
참고 항목

속성


enableVideoAds

enableVideoAds: boolean
페이지에 동영상 광고가 표시되는지 여부입니다.

true로 설정하면 디스플레이 광고 및 동영상 광고에 콘텐츠 제외 제약 조건이 사용 설정됩니다.

동영상 콘텐츠를 알고 있는 경우 디스플레이 광고에 콘텐츠 제외를 사용하려면 Google Ad Manager 콘텐츠 수집 서비스에 제공된 값으로 videoContentIdvideoCmsId를 설정하세요.

Optional videoCmsId

videoCmsId?: string
동영상 콘텐츠 소스 ID입니다.

이 값은 Google Ad Manager 콘텐츠 처리 서비스에서 videoContentId로 지정된 동영상 콘텐츠의 소스를 식별하기 위해 할당하는 고유한 값입니다.
참고 항목

Optional videoContentId

videoContentId?: string
동영상 콘텐츠 ID입니다.

이 값은 videoCmsId로 지정된 콘텐츠 소스의 특정 동영상을 식별하는 고유한 값입니다. 이 값은 동영상 콘텐츠를 호스팅하는 CMS에 의해 할당됩니다.
참고 항목

googletag.enums

GPT가 enum 유형에 사용하는 네임스페이스입니다.
열거
OutOfPageFormat
GPT에서 지원하는 페이지 외부 형식입니다.
TrafficSource
GPT에서 지원하는 트래픽 소스

열거


OutOfPageFormat

OutOfPageFormat
GPT에서 지원하는 페이지 외부 형식입니다.
참고 항목
열거형 멤버
AD_INTENTS
광고 의도 형식입니다.
BOTTOM_ANCHOR
슬롯이 표시 영역 하단에 고정되는 앵커 형식입니다.
GAME_MANUAL_INTERSTITIAL
게임 수동 전면 광고 형식입니다.

참고: 게임 수동 전면 광고는 액세스가 제한된 형식입니다.
INTERSTITIAL
웹 전면 광고 소재 형식입니다.
LEFT_SIDE_RAIL
왼쪽 사이드 레일 형식입니다.
REWARDED
보상형 형식입니다.
RIGHT_SIDE_RAIL
오른쪽 사이드 레일 형식입니다.
TOP_ANCHOR
슬롯이 표시 영역 상단에 고정되는 앵커 형식입니다.

TrafficSource

TrafficSource
GPT에서 지원하는 트래픽 소스
참고 항목
열거형 멤버
ORGANIC
직접 URL 입력, 사이트 검색 또는 앱 다운로드
PURCHASED
소유 이외의 속성에서 리디렉션된 트래픽 (획득 또는 인센티브 제공 활동)

googletag.events

GPT가 이벤트에 사용하는 네임스페이스입니다. 코드는 Service.addEventListener를 사용하여 이러한 이벤트에 반응할 수 있습니다.
인터페이스
Event
모든 GPT 이벤트의 기본 인터페이스입니다.
EventTypeMap
Service.addEventListenerService.removeEventListener의 이벤트 이름을 해당 이벤트 객체 유형에 매핑하는 의사 유형입니다.
GameManualInterstitialSlotClosedEvent
이 이벤트는 사용자가 게임 매뉴얼 전면 광고 슬롯을 닫을 때 발생합니다.
GameManualInterstitialSlotReadyEvent
이 이벤트는 게임 수동 전면 광고 슬롯을 사용자에게 표시할 준비가 되면 발생합니다.
ImpressionViewableEvent
이 이벤트는 Active View 기준에 따라 노출이 조회 가능하게 될 때 발생합니다.
RewardedSlotClosedEvent
이 이벤트는 사용자가 보상형 광고 슬롯을 닫을 때 발생합니다.
RewardedSlotGrantedEvent
이 이벤트는 보상형 광고를 시청하여 리워드가 부여될 때 발생합니다.
RewardedSlotReadyEvent
이 이벤트는 보상형 광고가 표시될 준비가 되면 발생합니다.
RewardedSlotVideoCompletedEvent
이 이벤트는 보상형 동영상 광고의 재생이 완료되면 발생합니다.
SlotOnloadEvent
이 이벤트는 광고 소재의 iframe이 로드 이벤트를 발생시킬 때 발생합니다.
SlotRenderEndedEvent
이 이벤트는 광고 소재 코드가 슬롯에 삽입될 때 발생합니다.
SlotRequestedEvent
이 이벤트는 특정 슬롯에 광고가 요청된 경우에 발생합니다.
SlotResponseReceived
이 이벤트는 특정 슬롯에 대한 광고 응답이 수신될 때 발생합니다.
SlotVisibilityChangedEvent
이 이벤트는 광고 슬롯 영역의 화면 비율이 변경될 때마다 발생합니다.

googletag.events.Event

모든 GPT 이벤트의 기본 인터페이스입니다. 아래의 모든 GPT 이벤트에는 다음 필드가 있습니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.
참고 항목

속성


serviceName

serviceName: string
이벤트를 트리거한 서비스의 이름입니다.

slot

slot: Slot
이벤트를 트리거한 슬롯입니다.

googletag.events.EventTypeMap

Service.addEventListenerService.removeEventListener의 이벤트 이름을 해당 이벤트 객체 유형에 매핑하는 의사 유형입니다. 참조 및 유형 안전 목적으로만 문서화됩니다.
속성
gameManualInterstitialSlotClosed
gameManualInterstitialSlotReady
impressionViewable
events.ImpressionViewableEvent의 별칭입니다.
rewardedSlotClosed
events.RewardedSlotClosedEvent의 별칭입니다.
rewardedSlotGranted
rewardedSlotReady
events.RewardedSlotReadyEvent의 별칭입니다.
rewardedSlotVideoCompleted
slotOnload
events.SlotOnloadEvent의 별칭입니다.
slotRenderEnded
events.SlotRenderEndedEvent의 별칭입니다.
slotRequested
events.SlotRequestedEvent의 별칭입니다.
slotResponseReceived
events.SlotResponseReceived의 별칭입니다.
slotVisibilityChanged

속성


gameManualInterstitialSlotClosed

gameManualInterstitialSlotClosed: GameManualInterstitialSlotClosedEvent
events.GameManualInterstitialSlotClosedEvent의 별칭입니다.

gameManualInterstitialSlotReady

gameManualInterstitialSlotReady: GameManualInterstitialSlotReadyEvent
events.GameManualInterstitialSlotReadyEvent의 별칭입니다.

impressionViewable

impressionViewable: ImpressionViewableEvent
events.ImpressionViewableEvent의 별칭입니다.

rewardedSlotClosed

rewardedSlotClosed: RewardedSlotClosedEvent
events.RewardedSlotClosedEvent의 별칭입니다.

rewardedSlotGranted

rewardedSlotGranted: RewardedSlotGrantedEvent
events.RewardedSlotGrantedEvent의 별칭입니다.

rewardedSlotReady

rewardedSlotReady: RewardedSlotReadyEvent
events.RewardedSlotReadyEvent의 별칭입니다.

rewardedSlotVideoCompleted

rewardedSlotVideoCompleted: RewardedSlotVideoCompletedEvent
events.RewardedSlotVideoCompletedEvent의 별칭입니다.

slotOnload

slotOnload: SlotOnloadEvent
events.SlotOnloadEvent의 별칭입니다.

slotRenderEnded

slotRenderEnded: SlotRenderEndedEvent
events.SlotRenderEndedEvent의 별칭입니다.

slotRequested

slotRequested: SlotRequestedEvent
events.SlotRequestedEvent의 별칭입니다.

slotResponseReceived

slotResponseReceived: SlotResponseReceived
events.SlotResponseReceived의 별칭입니다.

slotVisibilityChanged

slotVisibilityChanged: SlotVisibilityChangedEvent
events.SlotVisibilityChangedEvent의 별칭입니다.

googletag.events.GameManualInterstitialSlotClosedEvent

Event을 확장합니다.
이 이벤트는 사용자가 게임 수동 전면 광고 슬롯을 닫을 때 발생합니다.

참고: 게임 수동 전면 광고는 액세스가 제한된 형식입니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

// This listener is called when a game manual interstitial slot is closed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is closed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Game manual interstital slot", slot.getSlotElementId(), "is closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

googletag.events.GameManualInterstitialSlotReadyEvent

Event을 확장합니다.
이 이벤트는 게임 수동 전면 광고 슬롯을 사용자에게 표시할 준비가 되면 발생합니다.

참고: 게임 수동 전면 광고는 액세스가 제한된 형식입니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.
메서드
makeGameManualInterstitialVisible
사용자에게 게임 수동 전면 광고를 표시합니다.

자바스크립트

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", function (event) {
    var slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    var displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a game manual interstitial slot is ready to
// be displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.GAME_MANUAL_INTERSTITIAL,
);

// Slot returns null if the page or device does not support game manual interstitial ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  googletag.pubads().addEventListener("gameManualInterstitialSlotReady", (event) => {
    const slot = event.slot;
    console.log(
      "Game manual interstital slot",
      slot.getSlotElementId(),
      "is ready to be displayed.",
    );

    // Replace with custom logic.
    const displayGmiAd = true;
    if (displayGmiAd) {
      event.makeGameManualInterstitialVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

메서드


makeGameManualInterstitialVisible

makeGameManualInterstitialVisible(): void
사용자에게 게임 수동 전면 광고를 표시합니다.

googletag.events.ImpressionViewableEvent

Event을 확장합니다.
이 이벤트는 Active View 기준에 따라 노출이 조회 가능하게 될 때 발생합니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called when an impression becomes viewable.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", function (event) {
  var slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an impression becomes viewable.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("impressionViewable", (event) => {
  const slot = event.slot;
  console.log("Impression for slot", slot.getSlotElementId(), "became viewable.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

googletag.events.RewardedSlotClosedEvent

Event을 확장합니다.
이 이벤트는 사용자가 보상형 광고 슬롯을 닫을 때 발생합니다. 리워드가 부여되기 전이나 후에 실행될 수 있습니다. 보상이 부여되었는지 확인하려면 events.RewardedSlotGrantedEvent를 대신 사용하세요.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the user closes a rewarded ad slot.
  googletag.pubads().addEventListener("rewardedSlotClosed", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "has been closed.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

googletag.events.RewardedSlotGrantedEvent

Event을 확장합니다.
이 이벤트는 보상형 광고를 시청하여 리워드가 부여될 때 발생합니다. 보상 부여 기준이 충족되기 전에 광고가 닫히면 이 이벤트가 발생하지 않습니다.
속성
payload
부여된 리워드에 관한 정보가 포함된 객체입니다.
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", function (event) {
    var _a, _b;
    var slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", (_a = event.payload) === null || _a === void 0 ? void 0 : _a.type);
    console.log(
      "Reward amount:",
      (_b = event.payload) === null || _b === void 0 ? void 0 : _b.amount,
    );
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotGranted", (event) => {
    const slot = event.slot;
    console.group("Reward granted for slot", slot.getSlotElementId(), ".");

    // Log details of the reward.
    console.log("Reward type:", event.payload?.type);
    console.log("Reward amount:", event.payload?.amount);
    console.groupEnd();

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

속성


payload

부여된 리워드에 관한 정보가 포함된 객체입니다.

googletag.events.RewardedSlotReadyEvent

Event을 확장합니다.
이 이벤트는 보상형 광고가 표시될 준비가 되면 발생합니다. 게시자는 광고를 표시하기 전에 사용자에게 광고를 볼 수 있는 옵션을 제공할 책임이 있습니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.
메서드
makeRewardedVisible
보상형 광고를 표시합니다.

자바스크립트

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", function (event) {
    var slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    var userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

// This listener is called when a rewarded ad slot becomes ready to be
// displayed.
const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called whenever a reward is granted for a
  // rewarded ad.
  googletag.pubads().addEventListener("rewardedSlotReady", (event) => {
    const slot = event.slot;
    console.log("Rewarded ad slot", slot.getSlotElementId(), "is ready to be displayed.");

    // Replace with custom logic.
    const userHasConsented = true;
    if (userHasConsented) {
      event.makeRewardedVisible();
    }

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

메서드


makeRewardedVisible

makeRewardedVisible(): void
보상형 광고를 표시합니다. 이 메서드는 사용자가 광고를 보는 데 동의할 때까지 호출하면 안 됩니다.

googletag.events.RewardedSlotVideoCompletedEvent

Event을 확장합니다.
이 이벤트는 보상형 동영상 광고의 재생이 완료되면 발생합니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

JavaScript (기존)

var targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", function (event) {
    var slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}

TypeScript

const targetSlot = googletag.defineOutOfPageSlot(
  "/1234567/example",
  googletag.enums.OutOfPageFormat.REWARDED,
);

// Slot returns null if the page or device does not support rewarded ads.
if (targetSlot) {
  targetSlot.addService(googletag.pubads());

  // This listener is called when the video in a rewarded ad slot has
  // finished playing.
  googletag.pubads().addEventListener("rewardedSlotVideoCompleted", (event) => {
    const slot = event.slot;
    console.log("Video in rewarded ad slot", slot.getSlotElementId(), "has finished playing.");

    if (slot === targetSlot) {
      // Slot specific logic.
    }
  });
}
참고 항목

googletag.events.SlotOnloadEvent

Event을 확장합니다.
이 이벤트는 광고 소재의 iframe이 로드 이벤트를 발생시킬 때 발생합니다. 동기식 렌더링 모드에서 리치 미디어 광고를 렌더링할 때는 iframe이 사용되지 않으므로 SlotOnloadEvent가 실행되지 않습니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called when a creative iframe load event fires.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", function (event) {
  var slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a creative iframe load event fires.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotOnload", (event) => {
  const slot = event.slot;
  console.log("Creative iframe for slot", slot.getSlotElementId(), "has loaded.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

googletag.events.SlotRenderEndedEvent

Event을 확장합니다.
이 이벤트는 광고 소재 코드가 슬롯에 삽입될 때 발생합니다. 이 이벤트는 광고 소재의 리소스가 가져오기 전에 발생하므로 광고 소재가 아직 표시되지 않을 수 있습니다. 슬롯의 모든 광고 소재 리소스가 로드를 완료한 시점을 알아야 하는 경우 events.SlotOnloadEvent를 대신 고려하세요.
속성
advertiserId
렌더링된 광고의 광고주 ID입니다.
campaignId
렌더링된 광고의 캠페인 ID입니다.
companyIds
렌더링된 백업 광고에 입찰한 회사의 ID입니다.
creativeId
렌더링된 예약 광고의 광고 소재 ID입니다.
creativeTemplateId
렌더링된 예약 광고의 광고 소재 템플릿 ID입니다.
isBackfill
광고가 백업 광고인지 여부입니다.
isEmpty
슬롯에 광고가 반환되었는지 여부입니다.
labelIds
지원 중단되었습니다. 
lineItemId
렌더링된 예약 광고의 광고 항목 ID입니다.
responseIdentifier
응답 식별자는 광고 응답의 고유한 식별자입니다.
serviceName
이벤트를 트리거한 서비스의 이름입니다.
size
렌더링된 광고 소재의 픽셀 크기를 나타냅니다.
slot
이벤트를 트리거한 슬롯입니다.
slotContentChanged
렌더링된 광고로 슬롯 콘텐츠가 변경되었는지 여부입니다.
sourceAgnosticCreativeId
렌더링된 예약 또는 예비 광고의 광고 소재 ID입니다.
sourceAgnosticLineItemId
렌더링된 예약 또는 예비 광고의 광고 항목 ID입니다.
yieldGroupIds
렌더링된 대체 광고의 수익 그룹 ID입니다.

자바스크립트

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called when a slot has finished rendering.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", function (event) {
  var slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when a slot has finished rendering.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRenderEnded", (event) => {
  const slot = event.slot;
  console.group("Slot", slot.getSlotElementId(), "finished rendering.");

  // Log details of the rendered ad.
  console.log("Advertiser ID:", event.advertiserId);
  console.log("Campaign ID:", event.campaignId);
  console.log("Company IDs:", event.companyIds);
  console.log("Creative ID:", event.creativeId);
  console.log("Creative Template ID:", event.creativeTemplateId);
  console.log("Is backfill?:", event.isBackfill);
  console.log("Is empty?:", event.isEmpty);
  console.log("Line Item ID:", event.lineItemId);
  console.log("Size:", event.size);
  console.log("Slot content changed?", event.slotContentChanged);
  console.log("Source Agnostic Creative ID:", event.sourceAgnosticCreativeId);
  console.log("Source Agnostic Line Item ID:", event.sourceAgnosticLineItemId);
  console.log("Yield Group IDs:", event.yieldGroupIds);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

속성


advertiserId

advertiserId: number
렌더링된 광고의 광고주 ID입니다. 빈 슬롯, 백필 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

campaignId

campaignId: number
렌더링된 광고의 캠페인 ID입니다. 빈 슬롯, 백필 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

companyIds

companyIds: number[]
렌더링된 백업 광고에 입찰한 회사의 ID입니다. 빈 슬롯, 예약 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

creativeId

creativeId: number
렌더링된 예약 광고의 광고 소재 ID입니다. 빈 슬롯, 백필 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

creativeTemplateId

creativeTemplateId: number
렌더링된 예약 광고의 광고 소재 템플릿 ID입니다. 빈 슬롯, 백필 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

isBackfill

isBackfill: boolean
광고가 백업 광고인지 여부입니다. 광고가 예비 광고인 경우 값은 true이고, 그렇지 않으면 false입니다.

isEmpty

isEmpty: boolean
슬롯에 광고가 반환되었는지 여부입니다. 반환된 광고가 없으면 값은 true이고 그렇지 않으면 false입니다.

labelIds

labelIds: number[]

lineItemId

lineItemId: number
렌더링된 예약 광고의 광고 항목 ID입니다. 빈 슬롯, 백필 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

responseIdentifier

responseIdentifier: string
응답 식별자는 광고 응답의 고유한 식별자입니다. 이 값은 광고 심사 센터 (ARC)에서 광고를 식별하고 차단하는 데 사용할 수 있습니다.

size

size: string | number[]
렌더링된 광고 소재의 픽셀 크기를 나타냅니다. 예: [728, 90] 빈 광고 슬롯의 값은 null입니다.

slotContentChanged

slotContentChanged: boolean
렌더링된 광고로 슬롯 콘텐츠가 변경되었는지 여부입니다. 콘텐츠가 변경된 경우 값은 true이고, 그렇지 않은 경우 false입니다.

sourceAgnosticCreativeId

sourceAgnosticCreativeId: number
렌더링된 예약 또는 예비 광고의 광고 소재 ID입니다. 광고가 예약 또는 광고 항목 백필이 아니거나 광고 소재가 PubAdsService 이외의 서비스에 의해 렌더링되는 경우 값은 null입니다.

sourceAgnosticLineItemId

sourceAgnosticLineItemId: number
렌더링된 예약 또는 예비 광고의 광고 항목 ID입니다. 광고가 예약 또는 광고 항목 백필이 아니거나 광고 소재가 PubAdsService 이외의 서비스에 의해 렌더링되는 경우 값은 null입니다.

yieldGroupIds

yieldGroupIds: number[]
렌더링된 대체 광고의 수익 그룹 ID입니다. 빈 슬롯, 예약 광고, PubAdsService 이외의 서비스에서 렌더링된 광고 소재의 값은 null입니다.

googletag.events.SlotRequestedEvent

Event을 확장합니다.
이 이벤트는 특정 슬롯에 광고가 요청된 경우에 발생합니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", function (event) {
  var slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when the specified service issues an ad
// request for a slot. Each slot will fire this event, even though they
// may be batched together in a single request if single request
// architecture (SRA) is enabled.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotRequested", (event) => {
  const slot = event.slot;
  console.log("Slot", slot.getSlotElementId(), "has been requested.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

googletag.events.SlotResponseReceived

Event을 확장합니다.
이 이벤트는 특정 슬롯에 대한 광고 응답이 수신될 때 발생합니다.
속성
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called when an ad response has been received
// for a slot.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", function (event) {
  var slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called when an ad response has been received
// for a slot.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotResponseReceived", (event) => {
  const slot = event.slot;
  console.log("Ad response for slot", slot.getSlotElementId(), "received.");

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

googletag.events.SlotVisibilityChangedEvent

Event을 확장합니다.
이 이벤트는 광고 슬롯 영역의 화면 비율이 변경될 때마다 발생합니다. 이 이벤트는 제한되며 200ms에 한 번 이상 발생하지 않습니다.
속성
inViewPercentage
광고 영역 중 표시되는 영역의 비율입니다.
serviceName
이벤트를 트리거한 서비스의 이름입니다.
slot
이벤트를 트리거한 슬롯입니다.

자바스크립트

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

JavaScript (기존)

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
var targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", function (event) {
  var slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", "".concat(event.inViewPercentage, "%"));
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});

TypeScript

// This listener is called whenever the on-screen percentage of an
// ad slot's area changes.
const targetSlot = googletag.defineSlot("/1234567/example", [160, 600]);
googletag.pubads().addEventListener("slotVisibilityChanged", (event) => {
  const slot = event.slot;
  console.group("Visibility of slot", slot.getSlotElementId(), "changed.");

  // Log details of the event.
  console.log("Visible area:", `${event.inViewPercentage}%`);
  console.groupEnd();

  if (slot === targetSlot) {
    // Slot specific logic.
  }
});
참고 항목

속성


inViewPercentage

inViewPercentage: number
광고 영역 중 표시되는 영역의 비율입니다. 값은 0~100 사이의 숫자입니다.

googletag.secureSignals

GPT가 보안 신호를 관리하는 데 사용하는 네임스페이스입니다.
인터페이스
BidderSignalProvider
특정 입찰자의 보안 처리된 신호를 반환합니다.
PublisherSignalProvider
특정 게시자의 보안 신호를 반환합니다.
SecureSignalProvidersArray
보안 신호를 관리하는 인터페이스입니다.
유형 별칭
SecureSignalProvider
특정 입찰자 또는 제공업체의 보안 처리된 신호를 반환하는 인터페이스

유형 별칭


SecureSignalProvider

특정 입찰자 또는 제공업체의 보안 처리된 신호를 반환하는 인터페이스 id 또는 networkCode 중 하나를 제공해야 합니다. 둘 다 제공할 수는 없습니다.

googletag.secureSignals.BidderSignalProvider

특정 입찰자의 보안 처리된 신호를 반환합니다.

입찰자 보안 처리된 신호 제공자는 다음 두 부분으로 구성됩니다.

  1. 보안 신호로 확인되는 Promise를 반환하는 수집기 함수
  2. 신호와 연결된 입찰자를 식별하는 id입니다.
게시자의 보안 처리된 신호를 반환하려면 대신 secureSignals.PublisherSignalProvider를 사용하세요.
속성
collectorFunction
보안 신호로 확인되는 Promise를 반환하는 함수
id
Google Ad Manager에 등록된 이 보안 처리된 신호와 연결된 수집기의 고유 식별자입니다.

자바스크립트

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (기존)

// id is provided
googletag.secureSignalProviders.push({
  id: "collector123",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// id is provided
googletag.secureSignalProviders!.push({
  id: "collector123",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
참고 항목

속성


collectorFunction

collectorFunction: (() => Promise<string>)
보안 신호로 확인되는 Promise를 반환하는 함수

id

id: string
Google Ad Manager에 등록된 이 보안 처리된 신호와 연결된 수집기의 고유 식별자입니다.

googletag.secureSignals.PublisherSignalProvider

특정 게시자의 보안 처리된 신호를 반환합니다.

게시자 신호 제공업체는 다음 두 부분으로 구성됩니다.

  1. 보안 신호로 확인되는 Promise를 반환하는 수집기 함수
  2. 신호와 연결된 게시자를 식별하는 networkCode입니다.
입찰자의 보안 처리된 신호를 반환하려면 대신 secureSignals.BidderSignalProvider를 사용하세요.
속성
collectorFunction
보안 신호로 확인되는 Promise를 반환하는 함수
networkCode
이 보안 처리된 신호와 연결된 게시자의 네트워크 코드입니다 (광고 단위 경로에 표시됨).

자바스크립트

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

JavaScript (기존)

// networkCode is provided
googletag.secureSignalProviders.push({
  networkCode: "123456",
  collectorFunction: function () {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});

TypeScript

// networkCode is provided
googletag.secureSignalProviders!.push({
  networkCode: "123456",
  collectorFunction: () => {
    // ...custom signal generation logic...
    return Promise.resolve("signal");
  },
});
참고 항목

속성


collectorFunction

collectorFunction: (() => Promise<string>)
보안 신호로 확인되는 Promise를 반환하는 함수

networkCode

networkCode: string
이 보안 처리된 신호와 연결된 게시자의 네트워크 코드입니다 (광고 단위 경로에 표시됨).

googletag.secureSignals.SecureSignalProvidersArray

보안 신호를 관리하는 인터페이스입니다.
메서드
clearAllCache
캐시에서 모든 수집기의 모든 신호를 지웁니다.
push
신호 제공자 배열에 새로운 secureSignals.SecureSignalProvider를 추가하고 신호 생성 프로세스를 시작합니다.

메서드


clearAllCache

clearAllCache(): void
캐시에서 모든 수집기의 모든 신호를 삭제합니다.

이 메서드를 호출하면 현재 및 이후 페이지 조회의 광고 요청에 신호가 포함될 가능성이 줄어들 수 있습니다. 따라서 신규 사용자를 나타내는 이벤트 (로그인, 로그아웃, 가입 등)와 같이 의미 있는 상태 변경이 발생할 때만 호출해야 합니다.

push

push(provider: SecureSignalProvider): void
신호 제공자 배열에 새로운 secureSignals.SecureSignalProvider를 추가하고 신호 생성 프로세스를 시작합니다.
매개변수
provider: SecureSignalProvider배열에 추가할 secureSignals.SecureSignalProvider 객체입니다.